Welcome to Customer.io

Quick start guide

Academy: structured learning

1. Create your workspace

2. Set up message channels

3. Integrate with Customer.io

4. Add profiles

5. Send events and make segments

6. Start sending automations and workflows

Use Customer.io with AI

Your Customer.io agent

Customer.io CLI

Customer.io MCP

Email content analysis

In-app message suggestions

In-app survey analysis

Use our docs with AI

Introduction to messaging

Profiles & events

Objects & non-people data

Message channels

Liquid & personalization

Integration directory

Quick start guide Understanding integrations in Customer.io Troubleshooting Data compliance and privacy

Introduction Source specs Custom events Semantic events Backfill historical data Proxying requests to Customer.io Connections

Getting started Add a data-out integration Actions Action triggers: code mode Database/warehouse integrations Filtering and mapping actions Resend past data Connections

Pipelines API Track API App API Reporting Webhooks Comparing the Pipelines and Track APIs

iOS Android React Native Expo Flutter

Settings & Billing

Account verification

Tasks: workspace performance

Privacy & security

Troubleshooting

✨ Latest features

Design Studio: new and improved canvas editing experience Aug 14, 2026

Edit your components more intuitively with slash commands to add blocks, shortcuts to navigate and resize elements, and the ability to click and drag…

Control how fast your automations send messages Aug 6, 2026

You can now add a rate limit per channel for each of your automations and API-triggered broadcasts. You might add a rate limit to protect your email s…

Set up SMS with Sinch, Infobip, or Vonage Jul 30, 2026

You can now bring your own provider for SMS messages! Previously, you could only integrate with Twilio or work with Customer.io to set up sending with…

View all releases →

Log in Book a demo Start trial

Integrations
API
App
Tag
Data Index

Get started
AI features
Messaging
Integrations
Settings & Billing
Releases

App API

About the App API

POST Send an API-triggered broadcast
POST Send a newsletter
POST Schedule a newsletter
POST Send a transactional email
POST Send a transactional in-app message
POST Send a transactional inbox message
POST Send a transactional push
POST Send a transactional SMS

API-triggered Broadcasts

GET Get broadcast error descriptions
GET List broadcasts
GET Get a broadcast
GET Get the status of a broadcast
GET Get broadcast metrics
GET Get broadcast link metrics
GET List broadcast actions
GET Get messages for a broadcast
GET Get a broadcast action
PUT Update a broadcast action
GET Get a translation of a broadcast message
PUT Update a translation of a broadcast message
GET Get broadcast action metrics
GET Get broadcast action link metrics
GET Get broadcast triggers

Transactional Messages

GET List transactional messages
GET Get a transactional message
GET List all variants of a transactional message
PUT Update a transactional message
GET Get a translation of a transactional message
PUT Update a translation of a transactional message
GET Get transactional message metrics
GET Get transactional message link metrics
GET Get transactional message deliveries

GET Get customers by email
POST Search for customers
GET Lookup a customer's attributes
GET Lookup a customer's relationships
POST List customers, attributes, and devices
GET Lookup a customer's segments
GET Lookup messages sent to a customer
GET Lookup a customer's activities
GET Lookup a customer's subscription preferences

GET List object types
POST Find objects
GET Get Object Relationships
GET Get Object Attributes

GET List campaigns
GET Get a campaign
GET Get campaign metrics
GET Get campaign link metrics
GET List campaign actions
GET Get campaign message metadata
GET Get a campaign action
PUT Update a campaign action
GET Get a translation of a campaign message
PUT Update a translation of a campaign message
GET Get campaign action metrics
GET Get link metrics for an action
GET Get campaign journey metrics

GET List newsletters
POST Create and send a newsletter
GET Get a newsletter
DELETE Delete a newsletter

Newsletter Variants

GET List newsletter variants
GET Get a newsletter variant
PUT Update a newsletter variant
POST Add a translation to a newsletter
GET Get a newsletter translation
PUT Update a translation of a newsletter
DELETE Delete a translation of a newsletter
GET List a newsletter's A/B test groups
POST Create an A/B test group for a newsletter
POST Add a translation to a newsletter test group
GET Get a translation in a newsletter test group
PUT Update a translation in a newsletter test group
DELETE Delete a translation in a newsletter test group

Newsletter Metrics

GET Get newsletter metrics
GET Get click metrics for newsletter links
GET Get delivery data for a newsletter
GET Get metrics for a test or translation variant of a newsletter
GET Get click metrics for links in newsletter variants

GET List segments
POST Create a manual segment
GET Get a segment
DELETE Delete a segment
GET Get a segment's dependencies
GET Get a segment customer count
GET List customers in a segment

GET List messages
GET Get a message
GET Get an archived message

Live Notifications

POST Start a live notification
POST Update a live notification
POST End a live notification
GET Get a live notification's status

GET List folders
POST Create a folder
GET Get a folder
PUT Update a folder
DELETE Delete a folder
GET List emails
POST Create an email
GET Get an email
PUT Update an email
DELETE Delete an email
GET List email translations
POST Create an email translation
GET Get an email translation
PUT Update an email translation
DELETE Delete an email translation
GET List components
POST Create a component
GET Get a component
PUT Update a component
DELETE Delete a component

GET List file assets
POST Create a file asset
GET Get a file asset
PUT Update a file asset
DELETE Delete a file asset
GET List folders
POST Create a folder
GET Get a folder
PUT Update a folder
DELETE Delete a folder

GET List exports
GET Get an export
GET Download an export
POST Export customer data
POST Export information about deliveries

GET List activities

Sender Identities

GET List sender identities
GET Get a sender
GET Get sender usage data

Reporting Webhooks

GET List reporting webhooks
POST Create a reporting webhook
GET Get a reporting webhook
PUT Update a webhook configuration
DELETE Delete a reporting webhook

GET List snippets
POST Create a snippet
PUT Update snippets
DELETE Delete a snippet

GET List IP addresses

GET List your collections
POST Create a collection
GET Lookup a collection
PUT Update a collection
DELETE Delete a collection
GET Lookup collection contents
PUT Update the contents of a collection

ESP Suppression

GET Look up an ESP-suppressed address
GET Get ESP-suppressed emails by type
GET Get ESP-suppressed emails by domain
POST Suppress an email at the ESP
DELETE Un-suppress an ESP-suppressed address

POST Import items in bulk
GET Retrieve a bulk import

Subscription Center

GET List subscription topics
GET Generate a subscription center token
GET List subscription channels

GET List workspaces

POST Add or update attributes
POST Add or update events

GET List opt-outs in the workspace
GET Lookup a customer's opt-outs
PUT Update a customer's opt-outs

Start trial Book a demo Log in

App API

About the App API

POST Send an API-triggered broadcast
POST Send a newsletter
POST Schedule a newsletter
POST Send a transactional email
POST Send a transactional in-app message
POST Send a transactional inbox message
POST Send a transactional push
POST Send a transactional SMS

API-triggered Broadcasts

GET Get broadcast error descriptions
GET List broadcasts
GET Get a broadcast
GET Get the status of a broadcast
GET Get broadcast metrics
GET Get broadcast link metrics
GET List broadcast actions
GET Get messages for a broadcast
GET Get a broadcast action
PUT Update a broadcast action
GET Get a translation of a broadcast message
PUT Update a translation of a broadcast message
GET Get broadcast action metrics
GET Get broadcast action link metrics
GET Get broadcast triggers

Transactional Messages

GET List transactional messages
GET Get a transactional message
GET List all variants of a transactional message
PUT Update a transactional message
GET Get a translation of a transactional message
PUT Update a translation of a transactional message
GET Get transactional message metrics
GET Get transactional message link metrics
GET Get transactional message deliveries

GET Get customers by email
POST Search for customers
GET Lookup a customer's attributes
GET Lookup a customer's relationships
POST List customers, attributes, and devices
GET Lookup a customer's segments
GET Lookup messages sent to a customer
GET Lookup a customer's activities
GET Lookup a customer's subscription preferences

GET List object types
POST Find objects
GET Get Object Relationships
GET Get Object Attributes

GET List campaigns
GET Get a campaign
GET Get campaign metrics
GET Get campaign link metrics
GET List campaign actions
GET Get campaign message metadata
GET Get a campaign action
PUT Update a campaign action
GET Get a translation of a campaign message
PUT Update a translation of a campaign message
GET Get campaign action metrics
GET Get link metrics for an action
GET Get campaign journey metrics

GET List newsletters
POST Create and send a newsletter
GET Get a newsletter
DELETE Delete a newsletter

Newsletter Variants

GET List newsletter variants
GET Get a newsletter variant
PUT Update a newsletter variant
POST Add a translation to a newsletter
GET Get a newsletter translation
PUT Update a translation of a newsletter
DELETE Delete a translation of a newsletter
GET List a newsletter's A/B test groups
POST Create an A/B test group for a newsletter
POST Add a translation to a newsletter test group
GET Get a translation in a newsletter test group
PUT Update a translation in a newsletter test group
DELETE Delete a translation in a newsletter test group

Newsletter Metrics

GET Get newsletter metrics
GET Get click metrics for newsletter links
GET Get delivery data for a newsletter
GET Get metrics for a test or translation variant of a newsletter
GET Get click metrics for links in newsletter variants

GET List segments
POST Create a manual segment
GET Get a segment
DELETE Delete a segment
GET Get a segment's dependencies
GET Get a segment customer count
GET List customers in a segment

GET List messages
GET Get a message
GET Get an archived message

Live Notifications

POST Start a live notification
POST Update a live notification
POST End a live notification
GET Get a live notification's status

GET List folders
POST Create a folder
GET Get a folder
PUT Update a folder
DELETE Delete a folder
GET List emails
POST Create an email
GET Get an email
PUT Update an email
DELETE Delete an email
GET List email translations
POST Create an email translation
GET Get an email translation
PUT Update an email translation
DELETE Delete an email translation
GET List components
POST Create a component
GET Get a component
PUT Update a component
DELETE Delete a component

GET List file assets
POST Create a file asset
GET Get a file asset
PUT Update a file asset
DELETE Delete a file asset
GET List folders
POST Create a folder
GET Get a folder
PUT Update a folder
DELETE Delete a folder

GET List exports
GET Get an export
GET Download an export
POST Export customer data
POST Export information about deliveries

GET List activities

Sender Identities

GET List sender identities
GET Get a sender
GET Get sender usage data

Reporting Webhooks

GET List reporting webhooks
POST Create a reporting webhook
GET Get a reporting webhook
PUT Update a webhook configuration
DELETE Delete a reporting webhook

GET List snippets
POST Create a snippet
PUT Update snippets
DELETE Delete a snippet

GET List IP addresses

GET List your collections
POST Create a collection
GET Lookup a collection
PUT Update a collection
DELETE Delete a collection
GET Lookup collection contents
PUT Update the contents of a collection

ESP Suppression

GET Look up an ESP-suppressed address
GET Get ESP-suppressed emails by type
GET Get ESP-suppressed emails by domain
POST Suppress an email at the ESP
DELETE Un-suppress an ESP-suppressed address

POST Import items in bulk
GET Retrieve a bulk import

Subscription Center

GET List subscription topics
GET Generate a subscription center token
GET List subscription channels

GET List workspaces

POST Add or update attributes
POST Add or update events

GET List opt-outs in the workspace
GET Lookup a customer's opt-outs
PUT Update a customer's opt-outs

App API

Data Index

Update descriptions for attributes and events in your workspace. This helps improve AI-generated content and segments.

Endpoints

POST Add or update attributes /v1/data_index/attributes
POST Add or update events /v1/data_index/events

©2026 Peaberry Software, Inc. Status Terms of Service Privacy Policy