Update Opportunity Status
This endpoint allows you to update a specific Opportunity Status. If the specified Opportunity Status does not exist, the response will be a "bad request".
You will only be able to update a Opportunity 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 Opportunity Status. In order to update an Opportunity 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 Opportunity Status is visible |
| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |
| won | Boolean | If true, the close opportunity has been won |
| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see Types resource), in the case the Opportunity Types are used to represent multiple pipelines |
| descriptionDE | String | Opportunity Status label in German |
| descriptionDK | String | Opportunity Status label in Dutch |
| descriptionEN | String | Opportunity Status label in English |
| descriptionES | String | Opportunity Status label in Spanish |
| descriptionFR | String | Opportunity Status label in French |
| descriptionIT | String | Opportunity Status label in Italian |
| descriptionPT | String | Opportunity Status label in Portuguese |
| descriptionRU | String | Opportunity Status label in Russian |
| descriptionUS | String | Opportunity Status label in American English |
| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |
RESPONSE
Returns a JSON with information about the Opportunity 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/opportunityStatuses/{ID}
- Auth: API key in header X-Session-Key
Headers
Request body
Response
Update Opportunity Status
Changes
No recorded changes to this operation across all 1 revision of this API.