Campaigns / Entity
Create Campaign
This endpoint allows you to create a Campaign based on JSON input.
You will only be able to create 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 BODY
| Attribute | Type | Description |
|---|---|---|
| title (Required) | 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 (Required) | String | Date in wich the Campaign starts |
| endDate (Required) | String | Date when the Campaign ends |
| ownerId (Required) | Integer | Unique identifier of the User associated to the Campaign (see Users resource) |
| typeId (Required) | Integer | Type of the Campaign (see Types resource) |
| statusId (Required) | Integer | Status of the Campaign (see Statues resource) |
RESPONSE
Returns a JSON with information about the Campaign just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Campaign |
| 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/campaigns
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/campaigns
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Campaign
Changes
No recorded changes to this operation across all 1 revision of this API.