API referenceBroadcasts

POST /broadcasts/{broadcastId}/cancel

Cancel a scheduled or sending broadcast; sent messages are not affected

POST
/broadcasts/{broadcastId}/cancel

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

broadcastId*string

Broadcast id

Response Body

{success, broadcast}

application/json
  1. response
success?boolean
broadcast?
Example Request
curl -X POST 'https://example.com/api/v1/broadcasts/string/cancel'
Example Response
{  "success": true,  "broadcast": {    "id": "string",    "status": "string"  }}

POST /broadcasts/{broadcastId}/send POST

Send now (LIVE): the first batch in the request, the rest by the worker within the number's messaging-limit tier

GET /contacts GET

Contacts (search on name, email, company or a phone; tags; platform; subscription)