Campaigns / Accounts
Get Campaign Account
This endpoint retrieves data of a specific Campaign Account based on JSON input. The API returns a single Campaign Account available to the user, according to the unique ID provided. If the specified Campaign Account does not exist, the response will be a "bad request".
You will only receive the Campaign Account 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 |
|---|---|---|
| accountId | Integer | The unique and specific identifier of the Campaign Account |
| id | Integer | The unique and specific identifier of the Campaign |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| campaignId | Integer | ID of the corresponding Campaign (see Campaigns resource) |
| activityId | Integer | The ID of an Activity done for a sales Campaign (see Activities resource) |
| accountId | Integer | ID of the Account targeted by the Campaign (see Accounts resource) |
| completed | Boolean | If true, an Activity related to the Account had been done for the corresponding Campaign |
| dateCreated | String | Date and time when the Campaign Account was created |
| dateDeleted | String | Date and time when the Campaign Account was deleted |
| dateUpdated | String | Date and time when the Campaign Account was last updated |
| deleted | Boolean | If true, the Campaign Account has been deleted and archived |
| id | Integer | Unique identifier for the Campaign Account in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Account |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Account |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Account |
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}/entities/VALUE
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaigns/{ID}/entities/VALUE
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Campaign Account
Changes
No recorded changes to this operation across all 1 revision of this API.