Get campaign status
Description
Retrieves a campaign status — whether it is active or inactive.
Request URL
Method: POST
https://example.com/api/v1.1/campaigns/get_status
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
id | int | 12 | Yes | Campaign ID |
Request example
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 82
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>82</id>
</xml>
Response example
- JSON
- XML
{
"data": {
"is_active": false,
"is_completed": false,
"status": "Inactive"
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<is_active>false</is_active>
<is_completed>false</is_completed>
<status>"Inactive"</status>
</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 |
is_active | bool | Campaign active flag |
is_completed | bool | Campaign finished flag |
status | string | Current campaign status |