Update Campaign Account
This endpoint allows you to update a specific Campaign Account. If the specified Campaign Account does not exist, the response will be a "bad request".
You will only be able to update a 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
This endpoint allows updating the information of a specific Campaign Account.
| Parameter | Type | Description |
|---|---|---|
| accountId | Integer | The unique and specific identifier of the Campaign Account |
| id | Integer | The unique and specific identifier of the Campaign |
In order to update a Campaign Account, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all 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 |
RESPONSE
Returns a JSON with information about the Campaign Question just updated.
| Attribute | Description |
|---|---|
| Message | Shows 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 |
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
Request body
Response
Update Campaign Account
Changes
No recorded changes to this operation across all 1 revision of this API.