Customer.io API Reference

Platform
Pricing
Resources
Company

Sign In

Request Demo

Features
Pricing
Customers
Docs

Request Demo Sign In

Documentation Documentation
API
SDK SDK
- iOS
- Android
Release Notes

Region:

Overview
Client libraries
Authentication
Track API
- Track API Overview
- Javascript Snippet vs Backend Integrations
- Track API Limits
  - Track API Customer limits
  - Track API Event limits
- Account Region
  - getFind your account region
- Customers
  - putAdd or update a customer
  - delDelete a customer
  - putAdd or update a customer device
  - delDelete a customer device
  - postSuppress a customer profile
  - postUnsuppress a customer profile
  - postCustom unsubscribe handling
  - postMerge duplicate people
- Events
  - postTrack a customer event
  - postTrack an anonymous event
  - postReport push metrics
- Forms
  - postSubmit a form
- Segments
  - postAdd people to a manual segment
  - postRemove people from a manual segment
App API
- App API Overview
- App API Limits
  - API triggered broadcast limits
  - Transactional Message Limits
  - All other requests
- App API Authentication
- Activities
  - getList activities
- Broadcasts
  - postTrigger a broadcast
  - getGet the status of a broadcast
  - getGet broadcast error descriptions
  - getList broadcasts
  - getGet a broadcast
  - getGet metrics for a broadcast
  - getGet broadcast link metrics
  - getList broadcast actions
  - getGet message metadata for a broadcast
  - getGet a broadcast action
  - putUpdate a broadcast action
  - getGet broadcast action metrics
  - getGet broadcast action link metrics
  - getGet broadcast triggers
- Campaigns
  - getList campaigns
  - getGet a campaign
  - getGet campaign metrics
  - getGet campaign link metrics
  - getList campaign actions
  - getGet campaign message metadata
  - getGet a campaign action
  - putUpdate a campaign action
  - getGet campaign action metrics
  - getGet link metrics for an action
  - getGet campaign journey metrics
- Collections
  - postCreate a collection
  - getList your collections
  - getLookup a collection
  - delDelete a collection
  - putUpdate a collection
  - getLookup collection contents
  - putUpdate the contents of a collection
- Customers
  - getGet customers by email
  - postSearch for customers
  - getLookup a customer's attributes
  - postList customers, attributes, and devices
  - getLookup a customer's segments
  - getLookup messages sent to a customer
  - getLookup a customer's activities
- ESP Suppression
  - getLook up an ESP-suppressed address
  - getGet ESP-suppressed emails by type
  - delUn-suppress an ESP-suppressed address
  - postSuppress an email at the ESP
- Exports
  - getList exports
  - getGet an export
  - getDownload an export
  - postExport customer data
  - postExport information about deliveries
- Info
  - getList IP addresses
- Messages
  - getList messages
  - getGet a message
  - getGet an archived message
- Newsletters
  - getList newsletters
  - getGet a newsletter
  - getGet newsletter metrics
  - getGet newsletter link metrics
  - getList newsletter variants
  - getGet newsletter message metadata
  - getGet a newsletter variant
  - putUpdate a newsletter variant
  - getGet metrics for a variant
  - getGet newsletter variant link metrics
- Reporting Webhooks
  - postCreate a reporting webhook
  - getList reporting webhooks
  - getGet a reporting webhook
  - putUpdate a webhook configuration
  - delDelete a reporting webhook
  - EventReporting webhook format
- Segments
  - postCreate a manual segment
  - getList segments
  - getGet a segment
  - delDelete a segment
  - getGet a segment's dependencies
  - getGet a segment customer count
  - getList customers in a segment
- Sender Identities
  - getList sender identities
  - getGet a sender
  - get