Endpoints
Broadcasts
Create and send bulk email campaigns to contact groups.
A broadcast sends one email to every subscribed contact in a contact group. Create it as a draft, edit it while it is a draft, then call the send endpoint to queue it for immediate delivery.
Only drafts can be edited or deleted. After the send call the status moves queued → sending → sent. Each recipient goes through POST /send, so domain verification, suppressions and the monthly email quota apply per recipient.
- GETList broadcasts
/api/cranl/v1/broadcastsList broadcasts on the connected account, newest first. - POSTCreate broadcast
/api/cranl/v1/broadcastsCreate a draft broadcast. - GETGet broadcast
/api/cranl/v1/broadcasts/{id}Retrieve one broadcast with its body and send progress (total_recipients, sent_count, failed_count). - PATCHUpdate broadcast
/api/cranl/v1/broadcasts/{id}Update a draft broadcast. - DELETEDelete broadcast
/api/cranl/v1/broadcasts/{id}Delete a draft broadcast. - POSTSend broadcast
/api/cranl/v1/broadcasts/{id}/sendQueue a draft for immediate delivery to the group’s currently subscribed contacts. - GETList broadcast recipients
/api/cranl/v1/broadcasts/{id}/recipientsList per-recipient delivery rows in queue order.