Update Account Status
This endpoint allows you to update a specific Account Status. If the specified Account Status does not exist, the response will be a "bad request".
You will only be able to update a Account Status 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 Account Status. In order to update an Account Status, 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 |
|---|---|---|
| branchVisibility | Array | In which Branch the Account Status is visible |
| won | Boolean | If true, the Account Status has been won |
| lost | Boolean | If true, the Account Status has been lost |
| descriptionDE | String | Account Status label in German |
| descriptionDK | String | Account Status label in Dutch |
| descriptionEN | String | Account Status label in English |
| descriptionES | String | Account Status label in Spanish |
| descriptionFR | String | Account Status label in French |
| descriptionIT | String | Account Status label in Italian |
| descriptionPT | String | Account Status label in Portuguese |
| descriptionRU | String | Account Status label in Russian |
| descriptionUS | String | Account Status label in American English |
| order | Integer | The position of the Account Status in the Account Statuses value list |
RESPONSE
Returns a JSON with information about the Account Status 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/accountStatuses/{ID}
- Auth: API key in header X-Session-Key
Headers
Request body
Response
Update Account Status
Changes
No recorded changes to this operation across all 1 revision of this API.