Deletes an advertising campaign.
| Method | delete.campaigns |
|---|---|
| Description | Deletes an advertising campaign. |
| Who has access | Agents and clients |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Session key used to authenticate the request |
id |
number | yes | Unique ID of the advertising campaign to delete |
user_id |
number | no | Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users". |
System campaigns (id = -1) and integrated campaigns (type = integrated) cannot be deleted. Attempts return the forbidden error.
Example request
{
"jsonrpc": "2.0",
"id": "number",
"method": "delete.campaigns",
"params": {
"access_token": "string",
"id": "number",
"user_id": "number"
}
}
Example response
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": {},
"metadata": {}
}
}
List of returned errors
See the "List of errors for delete methods" section.