Deactivate mailing

Description

Deactivates a mailing.

Can also abort message sending, if a mailing is active:

abort_if_running = true property immediately aborts all messages in sending queue. If the value is false the mailing will be deactivated, though its already scheduled messages will be sent.

Request URL

Method: POST

https://example.com/api/v1.1/campaigns/deactivate

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
abort_if_running	bool	true	No	Abort mailing sending By default – false
id	int	12	Yes	Mailing ID

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": "15",
    "abort_if_running": "true"
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>15</id>
    <abort_if_running>true</abort_if_running>
</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