Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
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 23 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 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://track.customer.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Customer.io Broadcasts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using your App API key. Pass the key in the Authorization header as Bearer {appapikey}.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Broadcasts 1

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

POST
/campaigns/{campaign_id}/triggers
Trigger an API-triggered broadcast
triggerBroadcast 1 param body → 200400401404429

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is BroadcastTriggerRequest (5 properties). Each schema is shown below with its type and property counts.

BroadcastTriggerRequest
object
A request to trigger an API-triggered broadcast.
5 properties

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 Devices API
Customer.io Entity API
Customer.io Events API
Customer.io Exports API
Customer.io Group API