Campaigns / Questions
List Campaign Questions
Returns all Campaign Questions available in the user's ForceManager implementation database.
You will only receive the List of Campaign Questions 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/campaignQuestions?offset=VALUE&count=VALUE
RESPONSE
This endpoint returns information about all Campaign Questions 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 Questions attributes:
| Attribute | Type | Description |
|---|---|---|
| campaignId | Integer | ID of the corresponding Campaign (see Campaigns resource) |
| textBR | String | Campaign Question topic in Brasilian Portuguese |
| textDE | String | Campaign Question topic in German |
| textDK | String | Campaign Question topic in Dutch |
| textEN | String | Campaign Question topic in English |
| textES | String | Campaign Question topic in Spanish |
| textFR | String | Campaign Question topic in French |
| textIT | String | Campaign Question topic in Italian |
| textPT | String | Campaign Question topic in Portuguese |
| textRU | String | Campaign Question topic in Russian |
| textUS | String | Campaign Question topic in American English |
| type | String | Campaign Question data type. It can take the following values: bool, date, integer, multipleValueList, singleValueList, text |
| mandatory | Boolean | True if the Campaign Question is mandatory, false otherwise |
| order | Integer | The position of the Campaign Question in the Activity fields list |
| valueListName | String | The API name of the table that the Campaign Question type multipleValueList or singleValueList refers too |
| linkedEntity | String | This refers to the case in which the Campaign Question would populate a specific field of an entity through the answer provided by the User. Only accounts value is currently supported |
| linkedEntityField | String | It specifies the API name of the field (standard or custom) present in the linkedEntity table that the Campaing Question answer will populate |
| custom | Boolean | This indicate that for multipleValueList and singleValueList Campaign Questions, the list is not an existing one but a list created on purpose for the Campaign Question. If it is custom, the consumer of the API has to specify the corresponding list items, via the Campaign Question Values API (see Question Values resource) |
| dateCreated | String | Date and time when the Campaign Question was created |
| dateDeleted | String | Date and time when the Campaign Question was deleted |
| dateUpdated | String | Date and time when the Campaign Question was last updated |
| deleted | Boolean | If true, the Campaign Question has been deleted and archived |
| id | Integer | Unique identifier for the Campaign Question in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question |
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/campaignQuestions
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaignQuestions
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
ExtraFieldDescriptionstring
Response
List Campaign Questions
Changes
No recorded changes to this operation across all 1 revision of this API.