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 Broadcasts API

Trigger API-triggered broadcasts to send messages to groups of people based on segments or filters.

Customer.io Broadcasts 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 Broadcasts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 13 paths. 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.

15 operations 13 paths 0 schemas 13 GET2 PUT

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 Broadcasts 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 15

Across 13 paths, the API surfaces 15 operations — 13 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Broadcasts 15

In the UI, we frequently refer to broadcasts that you trigger through these endpoints as "API triggered" broadcasts. Use these endpoints to trigger a broadcast and retrieve inform…

GET
/v1/campaigns/{broadcast_id}/triggers/{trigger_id}/errors
Get broadcast error descriptions
broadcastErrors 4 params → 200400401404429
GET
/v1/broadcasts
List broadcasts
listBroadcasts → 200429
GET
/v1/broadcasts/{broadcast_id}
Get a broadcast
getBroadcast 1 param → 200400404429
GET
/v1/campaigns/{broadcast_id}/triggers/{trigger_id}
Get the status of a broadcast
broadcastStatus 2 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/metrics
Get broadcast metrics
broadcastMetrics 4 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/metrics/links
Get broadcast link metrics
broadcastLinks 4 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/actions
List broadcast actions
broadcastActions 1 param → 200400404429
GET
/v1/broadcasts/{broadcast_id}/messages
Get messages for a broadcast
broadcastMessages 9 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/actions/{action_id}
Get a broadcast action
getBroadcastAction 2 params → 200400404429
PUT
/v1/broadcasts/{broadcast_id}/actions/{action_id}
Update a broadcast action
updateBroadcastAction 2 params body → 200400404429
GET
/v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language}
Get a translation of a broadcast message
getBroadcastActionLanguage 3 params → 200400404429
PUT
/v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language}
Update a translation of a broadcast message
updateBroadcastActionLanguage 3 params body → 200400404429
GET
/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics
Get broadcast action metrics
broadcastActionMetrics 5 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics/links
Get broadcast action link metrics
broadcastActionLinks 5 params → 200400404429
GET
/v1/broadcasts/{broadcast_id}/triggers
Get broadcast triggers
listBroadcastTriggers 1 param → 200400404429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-broadcasts-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 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
Customer.io Newsletters API
Where this information came from

This is an independent, third-party profile of Customer.io Broadcasts 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.