Accounts / Segments
Create Account Segment
This endpoint allows you to create a Account Segment based on JSON input.
You will only be able to create a Account Segment 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
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Array | In which Branch the Account Segment is visible |
| descriptionBR | String | Account Segment label in Brasilian Portuguese |
| descriptionDE | String | Account Segment label in German |
| descriptionDK | String | Account Segment label in Dutch |
| descriptionEN (Required) | String | Account Segment label in English |
| descriptionES | String | Account Segment label in Spanish |
| descriptionFR | String | Account Segment label in French |
| descriptionIT | String | Account Segment label in Italian |
| descriptionPT | String | Account Segment label in Portuguese |
| descriptionRU | String | Account Segment label in Russian |
| descriptionUS | String | Account Segment label in American English |
| order | Integer | The position of the Account Segment in the Account Segments value list |
| visitCycle | Integer | Visit cycle linked to the value. e.g. visit every 30 days accounts in Segment A |
RESPONSE
Returns a JSON with information about the Account Segment just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Account Segment |
| 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/accountSegments
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountSegments
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Account Segment
Changes
No recorded changes to this operation across all 1 revision of this API.