Clear sender queue

Description

Purges all messages from a sender queue.

Request URL

Method: POST

https://example.com/api/v1.1/admin/senders/queue/purge/

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
id	int	12	Yes	Sender ID By default–1
account_id	int	12	No	Account ID By default–1
campaign_id	int	12	No	Mailing ID By default–1

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 3,
    "account_id": 1,
    "campaign_id": 3
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>3</id>
    <account_id>1</account_id>
    <campaign_id>3</campaign_id>
</xml>

Response example

JSON

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

XML

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

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text