Campaigns / Entity
Update Campaign
This endpoint allows you to update a specific Campaign. If the specified Campaign does not exist, the response will be a "bad request".
You will only be able to update a Campaign 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. In order to update a Campaign, 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 |
|---|---|---|
| title | String | A short descriptive name for the specific Campaign |
| description | String | A longer description of the Campaign content, it can be also HTML |
| videoUrl | String | A link to a video that describe the sales Campaign |
| address2 | String | Second address to whom the Campaign is linked |
| startDate | String | Date in wich the Campaign starts |
| endDate | String | Date when the Campaign ends |
| ownerId | Integer | Unique identifier of the User associated to the Campaign (see Users resource) |
| typeId | Integer | Type of the Campaign (see Types resource) |
| statusId | Integer | Status of the Campaign (see Statues resource) |
RESPONSE
Returns a JSON with information about the Campaign 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 |
put/campaigns/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaigns/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Campaign
Changes
No recorded changes to this operation across all 1 revision of this API.