Campaigns / Questions
Create Campaign Question
This endpoint allows you to create a Campaign Question based on JSON input.
You will only be able to create a Campaign Question 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 |
|---|---|---|
| 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 (Required) | 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 (Required) | 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) |
RESPONSE
Returns a JSON with information about the Campaign Question just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Campaign Question |
| Message | The operation status |
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 |
post/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
Request body
object[] required
Response
Create Campaign Question
Changes
No recorded changes to this operation across all 1 revision of this API.