Campaigns / Statuses
List Campaign Statuses
Returns all Campaign Statuses available in the user's ForceManager implementation database.
You will only receive the List of Campaign Statuses after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
RESPONSE
This endpoint returns information about all Campaign Statuses available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Campaign Statuses attributes:
| Attribute | Type | Description |
|---|---|---|
| descriptionBR | String | Campaign Status label in Brasilian Portuguese |
| descriptionDE | String | Campaign Status label in German |
| descriptionDK | String | Campaign Status label in Dutch |
| descriptionEN | String | Campaign Status label in English |
| descriptionES | String | Campaign Status label in Spanish |
| descriptionFR | String | Campaign Status label in French |
| descriptionIT | String | Campaign Status label in Italian |
| descriptionPT | String | Campaign Status label in Portuguese |
| descriptionRU | String | Campaign Status label in Russian |
| descriptionUS | String | Campaign Status label in American English |
| id | Integer | Unique identifier for the Campaign Status in ForceManager |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/campaignStatuses
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaignStatuses
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
ExtraFieldDescriptionstring
Response
List Campaign Statuses
Changes
No recorded changes to this operation across all 1 revision of this API.