Customer.io is a customer engagement platform that combines a customer data platform, marketing automation, and messaging delivery to send behavior-triggered email, push, SMS, and in-app messages. Its API surface includes the Track API for sending behavioral data and customer profile updates, the App API for managing workspace resources and sending transactional and broadcast messages, the Pipelines API which is a Segment-spec data ingestion interface, and outbound reporting webhooks that deliver message lifecycle events.
Customer.io publishes 41 APIs on the APIs.io network, including Track API, Activities API, Alias API, and 38 more. Tagged areas include Behavioral Data, Broadcasts, Campaigns, CDP, and Customer Data.
The Customer.io catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 3 Spectral governance rulesets.
Customer.io’s developer surface includes authentication, documentation, CLI, changelog, sandbox, API reference, getting-started guide, and 50 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Telecommunications regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/customer-io: open an issue to ask a question, or submit a pull request to add artifacts.
Submit an artifact on GitHub — free →Manage your own listing — the Influence plan, $499/mo →
The Customer.io Track API allows developers to send behavioral data and customer profile information into Customer.io. It provides endpoints for identifying customers, tracking ...
Customer.io's first-party hosted Model Context Protocol server. It exposes the full Journeys App API and CDP Data Pipelines API to any MCP client through eight tools — a context...
Use these endpoints to manage emails, translations, and components made with Design Studio. You can programmatically manage Design Studio content and migrate templates from an e...
If you use Customer.io as your email service provider (ESP), these endpoints help you retrieve information about email addresses suppressed directly by the ESP. ESP-based suppre...
Connect forms to your workspace to identify people, apply form responses to people, and trigger campaigns for people who fill out forms on your website or in your app.
APIs to upload CSV files containing lists of people. These endpoints provide a convenient way to add and update people without having to make an `identify` call for each individ...
Returns the list of addresses used by Customer.io. You must add add these addresses to your allowlist when using a custom SMTP provider and blocking unknown IP addresses.
Start, update, and end live notifications—real-time activities on the iOS Lock Screen and Dynamic Island, and in the Android notification shade. Your server drives the activity'...
Newsletter metrics include metrics for translations, A/B tests, and links. These endpoints return information about newsletter metrics including metrics for translations and A/B...
A newsletter variant is a translation or an A/B test. You can create, update, or delete variants in newsletters from these endpoints. You can also create a new A/B test group. I...
Objects are "groups" that you can relate people to in Customer.io—like the companies they work for, the online classes they take, and so on. These APIs help you find objects, th...
Set up webhooks to inform an external service about Customer.io events. Webhooks can notify you immediately when immediately when customer attributes change or when people open ...
Use these endpoints to send broadcasts or transactional messages to your audience. They use the same authentication method, but review the limits for both types of workflows to ...
A subscription center differentiates the types of messages available for your product. Your audience sets subscription preferences by name, but we record subscription preference...
Use customer events to trigger campaigns or add users to segments. You can attribute events directly to customers or send anonymous events and associate them with users later wh...
Manual segments are lists of people that you incorporate using the API or by uploading CSVs. You can add people to, or remove people from, manual segments with these endpoints. ...
This version of our edge API has only two endpoints, but supports the majority of our traditional v1 track operations and then some based on the `type` and `action` keys that yo...
Determine whether your account and data are hosted in the US or EU data center using your [Track API Key](https://fly.customer.io/settings/api_credentials).
An API to retrieve information about your workspaces in your account. You can use this to look up counts for messages sent, monthly billable emails sent, people, and objects.
Customer.io operates a first-party, hosted Model Context Protocol server that exposes the full Journeys App API and the CDP Data Pipelines API to any MCP client. It is a remote ...
Customer.io Reporting Webhooks send real-time message activity events as JSON payloads via HTTP POST to a configured endpoint. These events include message sends, deliveries, op...
aid: customer-io
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: true
label: Hosted service · you call their endpoint
confidence: high
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
accessModel:
pricing: paid
onboarding: self-serve
trial: false
try_now: false
public: false
label: Paid · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/customer-io.png
url: https://raw.githubusercontent.com/api-evangelist/customer-io/refs/heads/main/apis.yml
apis:
- aid: customer-io:track-api
name: Customer.io Track API
tags:
- Behavioral Data
- Customer Data
- Event Tracking
- Marketing Automation
- Messaging
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
baseURL: https://track.customer.io
humanURL: https://docs.customer.io/integrations/api/track/
properties:
- url: https://docs.customer.io/integrations/api/track/
type: Documentation
- url: openapi/customer-io-track-api-openapi.yml
type: OpenAPI
- url: graphql/customer-io-graphql.md
type: GraphQL
description: The Customer.io Track API allows developers to send behavioral data and customer profile information into Customer.io.
It provides endpoints for identifying customers, tracking events, managing devices for push notifications, and sending
anonymous events. The API uses basic authentication with a Site ID and API key, and accepts JSON request bodies.
- aid: customer-io:customer-io-activities-api
name: Customer.io Activities API
description: Retrieve activity logs for your workspace.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Activities
properties:
- type: OpenAPI
url: openapi/customer-io-activities-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-alias-api
name: Customer.io Alias API
description: Merge two user identities by creating an alias linking a new identity to an existing one.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://cdp.customer.io/v1
tags:
- Alias
properties:
- type: OpenAPI
url: openapi/customer-io-alias-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-batch-api
name: Customer.io Batch API
description: Send multiple API calls in a single request for improved performance.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Batch
properties:
- type: OpenAPI
url: openapi/customer-io-batch-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-broadcasts-api
name: Customer.io Broadcasts API
description: Trigger API-triggered broadcasts to send messages to groups of people based on segments or filters.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Broadcasts
properties:
- type: OpenAPI
url: openapi/customer-io-broadcasts-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-campaigns-api
name: Customer.io Campaigns API
description: Retrieve information about campaigns, campaign actions, and campaign metrics in your workspace.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Campaigns
properties:
- type: OpenAPI
url: openapi/customer-io-campaigns-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-collections-api
name: Customer.io Collections API
description: Manage collections of data used in message personalization.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Collection
tags_raw:
- Collections
properties:
- type: OpenAPI
url: openapi/customer-io-collections-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-customers-api
name: Customer.io Customers API
description: Look up customer profiles, search for customers, and retrieve customer attributes and activity data.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Customers
properties:
- type: OpenAPI
url: openapi/customer-io-customers-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-exports-api
name: Customer.io Exports API
description: Export customer data, deliveries, and other information from your workspace.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Export
tags_raw:
- Exports
properties:
- type: OpenAPI
url: openapi/customer-io-exports-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-group-api
name: Customer.io Group API
description: Associate people with groups or organizations.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://cdp.customer.io/v1
tags:
- Group
properties:
- type: OpenAPI
url: openapi/customer-io-group-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-identify-api
name: Customer.io Identify API
description: Identify people and set their profile attributes. The identify call tells Customer.io who the current user
is and assigns traits to them.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://cdp.customer.io/v1
tags:
- Identify
properties:
- type: OpenAPI
url: openapi/customer-io-identify-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-messages-api
name: Customer.io Messages API
description: Retrieve information about individual messages sent to customers.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Message
tags_raw:
- Messages
properties:
- type: OpenAPI
url: openapi/customer-io-messages-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-newsletters-api
name: Customer.io Newsletters API
description: Retrieve information about newsletters and newsletter variants.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Newsletters
properties:
- type: OpenAPI
url: openapi/customer-io-newsletters-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-page-api
name: Customer.io Page API
description: Record page views from web applications.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://cdp.customer.io/v1
tags:
- Page
properties:
- type: OpenAPI
url: openapi/customer-io-page-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-screen-api
name: Customer.io Screen API
description: Record screen views from mobile applications.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://cdp.customer.io/v1
tags:
- Screen
properties:
- type: OpenAPI
url: openapi/customer-io-screen-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-segments-api
name: Customer.io Segments API
description: Create and manage manual segments, and retrieve segment membership information.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Segments
properties:
- type: OpenAPI
url: openapi/customer-io-segments-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-sender-identities-api
name: Customer.io Sender Identities API
description: Manage sender identities used for sending messages.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Sender Identities
properties:
- type: OpenAPI
url: openapi/customer-io-sender-identities-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-snippets-api
name: Customer.io Snippets API
description: Manage reusable content snippets for use in messages.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Snippets
properties:
- type: OpenAPI
url: openapi/customer-io-snippets-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-transactional-api
name: Customer.io Transactional API
description: Send transactional messages such as password resets, purchase receipts, and other important notifications triggered
by user actions.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://api.customer.io
tags:
- Transactional
properties:
- type: OpenAPI
url: openapi/customer-io-transactional-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:mcp
name: Customer.io MCP
description: Customer.io's first-party hosted Model Context Protocol server. It exposes the full Journeys App API and CDP
Data Pipelines API to any MCP client through eight tools — a context primer, a schema browser, three verb-scoped HTTP
proxies split so reads can be approved independently of writes and deletes, a two-tool skill library, and an auth-status
probe. Authorization is OAuth 2.1 with PKCE and dynamic client registration, bound to the authorizing user's own Customer.io
permissions.
baseURL: https://mcp.customer.io/mcp
humanURL: https://docs.customer.io/ai/mcp/get-started/
tags:
- MCP
- Agents
- Artificial Intelligence
tags_raw:
- MCP
- Agents
- AI
properties:
- type: MCPServer
url: mcp/customer-io-mcp.yml
- type: ToolCrosswalk
url: mcp/customer-io-tool-crosswalk.yml
- type: OAuthScopes
url: scopes/customer-io-scopes.yml
- type: Documentation
url: https://docs.customer.io/ai/mcp/get-started/
- aid: customer-io:customer-io-assets-api
name: Customer.io Assets API
description: Manage file assets such as images and PDFs and organize them into folders.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Assets
properties:
- type: OpenAPI
url: openapi/customer-io-assets-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-customer-io-app-api-api
name: Customer.io Customer.io App API
description: The Customer.io App API API from Customer.io — 0 operation(s) for customer.io app api.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Customer.io App API
properties:
- type: OpenAPI
url: openapi/customer-io-customer-io-app-api-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-data-index-api
name: Customer.io Data Index API
description: Update descriptions for attributes and events in your workspace. This helps improve AI-generated content and
segments.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Data Index
properties:
- type: OpenAPI
url: openapi/customer-io-data-index-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-design-studio-api
name: Customer.io Design Studio API
description: 'Use these endpoints to manage emails, translations, and components made with Design Studio. You can programmatically
manage Design Studio content and migrate templates from an external service. To manage assets like images, use the [Assets
API](/integrations/api/app/#tag/assets).
These endpoints do not enable you to publish changes to connected workflows like campaigns, nor can you update global
styles. They''re only for content management at this time. Learn more about the [best practices](/integrations/api/integrate-with-ds/)
for sending HTML through these endpoints.
If you''re an external tool and interested in being listed as one of our integrated partners, please reach out to [product@customer.io](mailto:product@customer.io)
to chat with a Product Manager!'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Design Studio
properties:
- type: OpenAPI
url: openapi/customer-io-design-studio-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-esp-suppression-api
name: Customer.io ESP Suppression API
description: 'If you use Customer.io as your email service provider (ESP), these endpoints help you retrieve information
about email addresses suppressed directly by the ESP. ESP-based suppressions are different from suppression in Customer.io:
these are addresses that the ESP suppressed automatically because a message bounced, a customer requested they not be
contacted again, etc. These are _not_ addresses that you deleted and suppressed either in our UI or through [the API](#operation/suppress).'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- ESP Suppression
properties:
- type: OpenAPI
url: openapi/customer-io-esp-suppression-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-forms-api
name: Customer.io Forms API
description: Connect forms to your workspace to identify people, apply form responses to people, and trigger campaigns for
people who fill out forms on your website or in your app.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Forms
properties:
- type: OpenAPI
url: openapi/customer-io-forms-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-imports-api
name: Customer.io Imports API
description: APIs to upload CSV files containing lists of people. These endpoints provide a convenient way to add and update
people without having to make an `identify` call for each individual person.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Imports
properties:
- type: OpenAPI
url: openapi/customer-io-imports-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-info-api
name: Customer.io Info API
description: Returns the list of addresses used by Customer.io. You must add add these addresses to your allowlist when
using a custom SMTP provider and blocking unknown IP addresses.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Info
properties:
- type: OpenAPI
url: openapi/customer-io-info-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-live-notifications-api
name: Customer.io Live Notifications API
description: Start, update, and end live notifications—real-time activities on the iOS Lock Screen and Dynamic Island, and
in the Android notification shade. Your server drives the activity's content; Customer.io handles token lookup and push
delivery.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Live Notifications
properties:
- type: OpenAPI
url: openapi/customer-io-live-notifications-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-newsletter-metrics-api
name: Customer.io Newsletter Metrics API
description: 'Newsletter metrics include metrics for translations, A/B tests, and links.
These endpoints return information about newsletter metrics including metrics for translations and A/B tests. You can
update variants in newsletters from these endpoints, but you must perform all other create, update, and/or delete operations
through the UI.'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Newsletter Metrics
properties:
- type: OpenAPI
url: openapi/customer-io-newsletter-metrics-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-newsletter-variants-api
name: Customer.io Newsletter Variants API
description: 'A newsletter variant is a translation or an A/B test. You can create, update, or delete variants in newsletters
from these endpoints. You can also create a new A/B test group.
If your newsletters include assets like images or PDFs, host them in your [workspace''s assets](/integrations/api/app/#tag/assets)
or at another public URL, and include the URL in your message content.'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Newsletter Variants
properties:
- type: OpenAPI
url: openapi/customer-io-newsletter-variants-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-objects-api
name: Customer.io Objects API
description: Objects are "groups" that you can relate people to in Customer.io—like the companies they work for, the online
classes they take, and so on. These APIs help you find objects, their attributes, the people they're related to, etc.
Use the [track API v1](/api/track/#tag/Track-Customers) or the [Track v2 API](/api/track/#tag/track_v2) to add and relate
people to objects to your workspace and assign their attributes.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Objects
properties:
- type: OpenAPI
url: openapi/customer-io-objects-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-opt-outs-api
name: Customer.io Opt Outs API
description: The Opt-outs API from Customer.io — 2 operation(s) for opt-outs.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Opt-Outs
tags_raw:
- Opt-outs
properties:
- type: OpenAPI
url: openapi/customer-io-opt-outs-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-reporting-webhooks-api
name: Customer.io Reporting Webhooks API
description: Set up webhooks to inform an external service about Customer.io events. Webhooks can notify you immediately
when immediately when customer attributes change or when people open your messages.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Reporting Webhooks
properties:
- type: OpenAPI
url: openapi/customer-io-reporting-webhooks-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-send-messages-api
name: Customer.io Send Messages API
description: 'Use these endpoints to send broadcasts or transactional messages to your audience. They use the same authentication
method, but review the limits for both types of workflows to make sure you''ll successfully trigger your messages.
You can''t trigger campaigns through our APIs.
## API triggered broadcast limits
While [API triggered broadcasts](#operation/triggerBroadcast) are limited to 1 request every 10 seconds, they''re also
limited by the number of triggers you can have queued at a time, as shown in the table below.
| Data Type | Limit | Description |
| -- | -- | -- |
| Trigger Payload | 25MB | Max length of the entire Trigger call, larger calls are typically to support `per_user_data`
|
| Trigger Data | 50000 bytes | Max length of the data section in the Trigger call |
| Recipient List<sup>1</sup> | 10000 recipients | Max number of ids or emails included in the Trigger call |
| Custom Per User Data<sup>1</sup> | 10000 entries | Max number of entries in `per_user_data` |
| Custom Per User Data<sup>1</sup> | 2MB | Max length per user in the file referenced by `data_file_url`. |
| Custom Per User Data<sup>1</sup> | 10GB | Max length of the entire size of the file referenced by `data_file_url` |
| Trigger Queue | 5 triggers | Max number of triggers waiting to be processed consecutively |
<sup>1</sup>For larger data sets, use `data_file_url` to supply a link to a file that contains your merge data. Attempting
to send too much data in a single API call will fail.
## Transactional Message Limits
The `/send-*` endpoints are limited to 100 requests per second.
| Data Type | Limit | Description |
| -- | -- | -- |
| Payload | 1MB | Max length of the payload, excepting attachments |
| Attachments (email) | 2MB | Maximum size of attachments |
| Recipients | 15 | Total number of recipients across the `to`, `cc`, and `bcc` fields. |'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Send Messages
properties:
- type: OpenAPI
url: openapi/customer-io-send-messages-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-subscription-center-api
name: Customer.io Subscription Center API
description: A subscription center differentiates the types of messages available for your product. Your audience sets subscription
preferences by name, but we record subscription preferences by topic ID. You can use these endpoints to get a list of
topics and names, helping you understand your audience's subscription preferences.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Subscription Center
properties:
- type: OpenAPI
url: openapi/customer-io-subscription-center-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-track-customers-api
name: Customer.io Track Customers API
description: Add, modify, suppress, or unsuppress people (referred to as "customers" in our APIs). You can also use these
endpoints to set attributes on people.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Track Customers
properties:
- type: OpenAPI
url: openapi/customer-io-track-customers-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-track-events-api
name: Customer.io Track Events API
description: Use customer events to trigger campaigns or add users to segments. You can attribute events directly to customers
or send anonymous events and associate them with users later when you identify them.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Track Events
properties:
- type: OpenAPI
url: openapi/customer-io-track-events-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-track-segments-api
name: Customer.io Track Segments API
description: 'Manual segments are lists of people that you incorporate using the API or by uploading CSVs. You can add people
to, or remove people from, manual segments with these endpoints. These endpoints do _not_ let you modify data-driven segments.
**NOTE**: These endpoints do not yet support workspaces that use both `email` and `id` as identifiers.
A segment must exist before you can add people to it. You can create manual segments using the [App API `/segments` endpoints](/api/#operation/createManSegment).'
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Track Segments
properties:
- type: OpenAPI
url: openapi/customer-io-track-segments-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-track-v2-api
name: Customer.io Track V2 API
description: "This version of our edge API has only two endpoints, but supports the majority of our traditional v1 track\
\ operations and then some based on the `type` and `action` keys that you set in your request. \n \nYou can use the `/batch`\
\ call to send multiple requests at the same time. Unlike the v1 API, you can also make requests affecting objects and\
\ deliveries. Objects are a grouping mechanism for people—like an account people belong to or an online course that they\
\ enroll in. Deliveries are events based on messages sent from Customer.io.\n\nThe chart below lists the type of `action`\
\ you can perform for each `type`. Our requests below are broken out by `type`; use the `action` dropdown to see the specific\
\ payload structure for each action.\n\n| Action | Person | Object | Delivery | \n| :-- | :--: | :--: | :--: |\n| identify\
\ | ✅ | ✅ | |\n| delete | ✅ | ✅ | |\n| event | ✅ | | ✅ |\n| screen | ✅ | | |\n\
| page | ✅ | | |\n| add_relationships | ✅ | ✅ | |\n| delete_relationships | ✅ | ✅ | |\n\
| add_device | ✅ | | | \n| delete_device | ✅ | | |\n| merge | ✅ | | |\n| suppress | ✅ | | |\n\
| unsuppress | ✅ | | |"
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags: []
tags_raw:
- track_v2
properties:
- type: OpenAPI
url: openapi/customer-io-track-v2-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-trackregion-api
name: Customer.io Track Region API
description: Determine whether your account and data are hosted in the US or EU data center using your [Track API Key](https://fly.customer.io/settings/api_credentials).
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags: []
tags_raw:
- trackRegion
properties:
- type: OpenAPI
url: openapi/customer-io-trackregion-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
- aid: customer-io:customer-io-workspaces-api
name: Customer.io Workspaces API
description: An API to retrieve information about your workspaces in your account. You can use this to look up counts for
messages sent, monthly billable emails sent, people, and objects.
humanURL: https://docs.customer.io/integrations/api/track/
baseURL: https://track.customer.io
tags:
- Workspaces
properties:
- type: OpenAPI
url: openapi/customer-io-workspaces-api-openapi.yml
- type: Documentation
url: https://docs.customer.io/integrations/api/app/
- type: Documentation
url: https://docs.customer.io/integrations/data-in/connections/http-api/
common:
- type: CapabilityMap
url: capabilities/customer-io-capability-edges.yml
name: Customer.io Business Capability Map
- type: Overlay
url: overlays/customer-io-pipelines-api-overlay.yaml
- type: Overlay
url: overlays/customer-io-reporting-webhooks-overlay.yaml
- type: Plans
url: plans/customer-io-plans-pricing.yml
- type: RateLimits
url: rate-limits/customer-io-rate-limits.yml
- type: FinOps
url: finops/customer-io-finops.yml
- type: AgenticAccess
url: agent
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/customer-io/refs/heads/main/apis.yml
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
Kin Score
How this is scored →