Launch a broadcast campaign
Description
Launches a broadcast campaign instantly. A campaign must be active.
override_source_type and override_source_id parameters override campaign audience for the run.
override_limit parameter sets sending limitations for the current run.
If no override options are set — campaigns will use their default audience sources and sending limitations.
Request URL
Method: POST
https://example.com/api/v1.1/campaigns/broadcasts/start
Request parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
| id | int | 12 | Yes | Campaign ID |
| override_source_type | enum | "list" или "segment" | No | Override audience source |
| override_source_id | int | 5 | No | New audience source ID |
| override_limit | int | 300 | No | Override campaign limitations |
| content | JSON object | {"field":"value"} | No | Additional content for API content filter node and template apicontent variables |
| attach | JSON array | [] | No | Attach file(s) to campaign messages |
Request example
{
"id": 4727,
"override_source_id": 2550,
"override_source_type": "segment",
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
Response parameters
| Parameter | Type | Description |
|---|---|---|
| error | int | Error code |
| error_text | string | Error text |