How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Customer.io Newsletters API

Retrieve information about newsletters and newsletter variants.

Customer.io Newsletters API is one of 42 APIs that Customer.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Newsletters. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.customer.io, https://api-eu.customer.io.

4 operations 2 paths 6 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.customer.io
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Customer.io Newsletters API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (Bearer-Auth). It accepts HTTP bearer tokens (sa_live_) (ServiceAccount-Auth). It accepts HTTP bearer tokens (bearerAuth).

  • Bearer-Auth — The App API uses a bearer authentication scheme. You can generate a bearer token, known as an App API Key, with a defined scope in [your account settings](http…
  • ServiceAccount-Auth — Transactional send endpoints (/v1/send/email, /v1/send/push, /v1/send/sms, /v1/send/inapp, /v1/send/inboxmessage) also accept a service-account bearer token, p…
  • bearerAuth — API key passed as a Bearer token

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Newsletters 4

A newsletter is a type of broadcast in Customer.io—a one-time, single message that you send to a group of people. You can also set your newsletter up with A/B test variants and/or…

GET
/v1/newsletters
List newsletters
listNewsletters 3 params → 200
POST
/v1/newsletters
Create and send a newsletter
createNewsletter body → 200400422429
GET
/v1/newsletters/{newsletter_id}
Get a newsletter
getNewsletters 1 param → 200404429
DELETE
/v1/newsletters/{newsletter_id}
Delete a newsletter
deleteNewsletters 1 param → 204404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

createPushNewsletter
For push notifications, you must provide at least one of subject or body.
createWebhookNewsletter
For webhooks, you must include body, requestmethod, and url.
createInAppNewsletter
For in-app messages, you must include bodyjson.
createInboxNewsletter
For inbox messages, you must include bodyjson.
createEmailNewsletter
When you create an email, include subject and body. Set either from or fromid, but not both. If you set neither, Customer.io uses your oldest verified sending…
createSmsNewsletter
When creating an SMS text, you must include body.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-newsletters-api-openapi.yml Raw ↑

Other APIs Customer.io publishes across the network.

Customer.io Track API
Customer.io Activities API
Customer.io Alias API
Customer.io Batch API
Customer.io Broadcasts API
Customer.io Campaigns API
Customer.io Collections API
Customer.io Customers API
Customer.io Exports API
Customer.io Group API
Customer.io Identify API
Customer.io Messages API
Where this information came from

This is an independent, third-party profile of Customer.io Newsletters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.