Launch a broadcast mailing

Description

Launches a broadcast mailing instantly. A mailing must be active.

override_source_type and override_source_id parameters override mailing audience for the run.

override_limit parameter sets sending limitations for the current run.

If no override options are set — mailings 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	Mailing 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 mailing 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 mailing messages

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 90,
    "override_source_id": 1,
    "override_source_type": "list"   
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>90</id>
  <override_source_id>1</override_source_id>
  <override_source_type>list</override_source_type>
</xml>

Response example

JSON

{
    "data": null,
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data/>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text