Changelog
Every change to the API, newest first. v1 changes only add things, so code written for an earlier version keeps working. See versioning.
1.1.0 · 2026-10-08
Templates, custom fields, opt-out writes, estimates, weekly repeats, inbox, reports and campaign controls.
Added
POST /api/v1/templatesGET /api/v1/templates/{template_id}PATCH /api/v1/templates/{template_id}DELETE /api/v1/templates/{template_id}GET /api/v1/custom-fieldsPOST /api/v1/custom-fieldsPATCH /api/v1/custom-fields/{field_id}DELETE /api/v1/custom-fields/{field_id}GET /api/v1/members/{member_id}/custom-fieldsPATCH /api/v1/members/{member_id}/custom-fieldsPOST /api/v1/opt-outsPOST /api/v1/opt-outs/bulkPOST /api/v1/recipients/validatePOST /api/v1/messages/estimateGET /api/v1/inboxGET /api/v1/inbox/unread-countPOST /api/v1/inbox/{message_id}/readPOST /api/v1/inbox/read-allGET /api/v1/messages/{message_id}/deliveriesGET /api/v1/analyticsGET /api/v1/campaignsGET /api/v1/campaigns/{campaign_id}POST /api/v1/campaigns/{campaign_id}/pausePOST /api/v1/campaigns/{campaign_id}/resumePOST /api/v1/campaigns/{campaign_id}/cancel
Changed
- POST /api/v1/messages accepts template_id instead of text, and repeat for weekly sends.
- GET /api/v1/scheduled items include repeat.
- Bulk opt-outs, recipient checks, delivery reports and analytics share a 10 per minute limit per key.
- member.opted_out is also sent when your integration records an opt-out.
1.0.0 · 2026-10-08
First release: team, members, groups, messages, scheduled messages, templates, opt-outs, inbound messages and webhooks.
The machine-readable description is /api/v1/openapi.json, and a Postman collection is built from it.