API reference
Browse endpoints by resource. Each endpoint includes authentication requirements, request fields, examples, and responses.
Looking for importable files? Visit Developer tools.
Events
Embedded components
Campaigns
- List campaignsGET
/api/v1/campaigns - Get a campaign and its resultsGET
/api/v1/campaigns/{id} - Create a draft campaignPOST
/api/v1/campaigns - Queue a campaign nowPOST
/api/v1/campaigns/{id}/send - Schedule a campaignPOST
/api/v1/campaigns/{id}/schedule - Cancel a scheduled campaignPOST
/api/v1/campaigns/{id}/cancel - List campaign recipientsGET
/api/v1/campaigns/{id}/recipients
Verification
Account
Subscribers
- List subscribersGET
/api/v1/subscribers - Add a subscriberPOST
/api/v1/subscribers - Get a subscriberGET
/api/v1/subscribers/{id} - Update a subscriberPATCH
/api/v1/subscribers/{id} - Erase a subscriberDELETE
/api/v1/subscribers/{id} - Add or remove tagsPOST
/api/v1/subscribers/{id}/tags - Record an opt-outPOST
/api/v1/subscribers/{id}/opt_out - Consent historyGET
/api/v1/subscribers/{id}/consent - List tagsGET
/api/v1/tags
Templates
Messages
Webhooks
- List webhook endpointsGET
/api/v1/webhook_endpoints - Add a webhook endpointPOST
/api/v1/webhook_endpoints - Get a webhook endpointGET
/api/v1/webhook_endpoints/{id} - Update a webhook endpointPATCH
/api/v1/webhook_endpoints/{id} - Delete a webhook endpointDELETE
/api/v1/webhook_endpoints/{id} - Rotate the signing secretPOST
/api/v1/webhook_endpoints/{id}/rotate_secret - Reveal the signing secretGET
/api/v1/webhook_endpoints/{id}/secret - Send a test eventPOST
/api/v1/webhook_endpoints/{id}/test - List retained webhook eventsGET
/api/v1/webhook_endpoints/{id}/events - Replay a retained eventPOST
/api/v1/webhook_endpoints/{id}/events/{event_id}/resend - List deliveriesGET
/api/v1/webhook_endpoints/{id}/deliveries - Resend a deliveryPOST
/api/v1/webhook_endpoints/{id}/deliveries/{delivery_id}/resend