| Method | delete.campaigns |
|---|---|
| Description | Deleting an advertising campaign |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
id |
number | yes | Unique identifier of the advertising campaign |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
It is prohibited to delete system advertising campaignsid = -1or integratedtype = integrated. The response will contain an error with the mnemonic "forbidden".
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"delete.campaigns", "params":{ "access_token":"string", "id":"number", "user_id":"number" } }
### JSON response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": {
},
"metadata": {
}
}
}
List of returned errors
See the section "List of errors for methods with the delete verb"