Campaigns / Accounts
List Campaign Accounts
Returns all Campaign Accounts available in the user's ForceManager implementation database.
You will only receive the List of Campaign Accounts 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 |
REQUEST
You can apply filters. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| offset | Integer | Define position from which the records must be returned |
| count | Integer | Define the number of results to return |
e.g.
https://api.forcemanager.com/api/v4/campaigns/:ID/entities/VALUE?offset=VALUE&count=VALUE
RESPONSE
This endpoint returns information about all Campaign Accounts 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 Accounts attributes:
| 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
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaigns/{ID}/entities
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
ExtraFieldDescriptionstring
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.