Campaigns / Entity
Get Campaign
This endpoint retrieves data of a specific Campaign based on JSON input. The API returns a single Campaign available to the user, according to the unique ID provided. If the specified Campaign does not exist, the response will be a "bad request".
You will only receive the Campaign 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 |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Campaign |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| title | String | A short descriptive name for the specific Campaign |
| description | String | A longer description of the Campaign content, it can be also HTML |
| videoUrl | String | A link to a video that describe the sales Campaign |
| address2 | String | Second address to whom the Campaign is linked |
| startDate | String | Date in wich the Campaign starts |
| endDate | String | Date when the Campaign ends |
| ownerId | Integer | Unique identifier of the User associated to the Campaign (see Users resource) |
| typeId | Integer | Type of the Campaign (see Types resource) |
| statusId | Integer | Status of the Campaign (see Statues resource) |
| dateCreated | String | Date and time when the Campaign was created |
| dateDeleted | String | Date and time when the Campaign was deleted |
| dateUpdated | String | Date and time when the Campaign was last updated |
| deleted | Boolean | If true, the Campaign has been deleted and archived |
| id | Integer | Unique identifier for the Campaign in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign |
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/campaigns/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaigns/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Campaign
Changes
No recorded changes to this operation across all 1 revision of this API.