Welcome to Customer.io

Quick start guide

Academy: structured learning

1. Create your workspace

2. Set up message channels

3. Integrate with Customer.io

5. Send events and make segments

6. Start sending automations and workflows

Use Customer.io with AI

Your Customer.io agent

Conversational analytics

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

People & events

Custom 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

Upload recipients via CSV to trigger one-time sends Sep 17, 2026

Recipients for a one-time send can now be built by uploading a CSV. This helps you send your message to an externally defined audience with the simpli…

Design Studio: preview your email in real inboxes Sep 15, 2026

Generate real screenshots of your email from specific clients and devices, like the Gmail app on iPhone 16 or Pixel 9. This helps you catch styling is…

Get behavioral insights with AI Sep 10, 2026

The Customer.io agent (and associated CLI and MCP tools) can now analyze your workspace's messaging and behavioral data, providing more advanced repor…

View all releases →

Log in Book a demo Start trial

Integrations
API
App API
Exports

Get started
AI features
Messaging
Integrations
Settings & Billing
Releases

App API

About the App API

POST Send an API-triggered broadcast
POST Cancel a scheduled broadcast
POST Trigger a one-time send
POST Schedule a one-time send
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
POST Send a transactional WhatsApp message

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 by ID
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

Automations/Campaigns

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

GET List one-time sends
POST Create and send a one-time send
GET Get a one-time send
DELETE Delete a one-time send

One-time send variants

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

One-time send metrics

GET Get one-time send metrics
GET Get click metrics for one-time send links
GET Get delivery data for a one-time send
GET Get metrics for a test or translation variant of a one-time send
GET Get click metrics for links in one-time send 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 components
POST Create a component
GET Get a component
PUT Update a component
DELETE Delete a component

Design Studio emails

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
POST Link an email to a workflow
POST Publish an email
GET Get publish status
GET Check for unpublished changes
GET Render an email
POST Preview an email
POST Send a test email
GET Review an email
GET List email versions
POST Save an email version
GET Get an email version
DELETE Delete an email version
POST Restore an email version
GET List inbox preview options
GET Get preview credit balance
POST Send for inbox previews
GET Get an inbox preview job
GET Get a preview screenshot
GET List inbox preview history

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 Cancel a scheduled broadcast
POST Trigger a one-time send
POST Schedule a one-time send
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
POST Send a transactional WhatsApp message

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 by ID
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

Automations/Campaigns

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

GET List one-time sends
POST Create and send a one-time send
GET Get a one-time send
DELETE Delete a one-time send

One-time send variants

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

One-time send metrics

GET Get one-time send metrics
GET Get click metrics for one-time send links
GET Get delivery data for a one-time send
GET Get metrics for a test or translation variant of a one-time send
GET Get click metrics for links in one-time send 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 components
POST Create a component
GET Get a component
PUT Update a component
DELETE Delete a component

Design Studio emails

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
POST Link an email to a workflow
POST Publish an email
GET Get publish status
GET Check for unpublished changes
GET Render an email
POST Preview an email
POST Send a test email
GET Review an email
GET List email versions
POST Save an email version
GET Get an email version
DELETE Delete an email version
POST Restore an email version
GET List inbox preview options
GET Get preview credit balance
POST Send for inbox previews
GET Get an inbox preview job
GET Get a preview screenshot
GET List inbox preview history

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

Exports

Export information about people, deliveries, etc. You can also download existing exports from these endpoints.

Endpoints

GET List exports /v1/exports
GET Get an export /v1/exports/{export_id}
GET Download an export /v1/exports/{export_id}/download
POST Export customer data /v1/exports/customers
POST Export information about deliveries /v1/exports/deliveries

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