Send a broadcast. Can only send broadcasts in DRAFT, CANCELLED or FAILED status.
cURL
curl --request POST \ --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send
{ "id": "<string>", "name": "<string>", "status": "DRAFT", "scheduled_at": "2023-11-07T05:31:56Z", "started_at": "2023-11-07T05:31:56Z", "completed_at": "2023-11-07T05:31:56Z", "contacts_count": 123, "recipients_count": 123, "skipped_count": 123, "sent_count": 123, "failed_count": 123, "delivered_count": 123, "opened_count": 123, "played_count": 123, "click_count": 123, "complained_count": 123, "unsubscribed_count": 123, "error_message": "<string>", "segments": [ { "id": "<string>", "name": "<string>", "contacts_count": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "send_to_all": true, "templates": [ { "id": "<string>", "broadcast_id": "<string>", "connection_id": "<string>", "integration_id": "internal", "recipients_count": 123, "config": {}, "error": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }
Org ID
Broadcast ID
Schema for a broadcast
The status of the broadcast
DRAFT
SCHEDULED
SENDING
SENT
CANCELLED
FAILED
Show child attributes
Was this page helpful?