Update an opportunity stage
PUThttps://localhost:8092/api/2.0/crm/opportunity/stage/{id:[0-9]+}
Updates the selected opportunity stage with the parameters (title, description, success probability, etc.) specified in the request.
Request
- application/json
Body
idinteger
Opportunity stage ID
titlestring
New stage title
descriptionstring
New stage description
colorstring
New stage color
successProbabilityinteger
New stage success probability
stageTypeinteger
New stage type
Responses
- 200
- 401
Updated opportunity stage
- application/json
- Schema
- Example (auto)
Schema
RelativeItemsCountint32
Example:
1
SuccessProbabilityint32
Example:
20
StageTypeint32
[0 - Open, 1 - ClosedAndWon, 2 - ClosedAndLost]
Possible values: [Open
, ClosedAndWon
, ClosedAndLost
]
Example:
0
Titlestring
Example:
Title
Descriptionstring
Example:
Description
Colorstring
Example:
#a7fc00
SortOrderint32
Example:
1
IDint32
Example:
1234
{
"RelativeItemsCount": "1",
"SuccessProbability": "20",
"StageType": "0",
"Title": "Title",
"Description": "Description",
"Color": "#a7fc00",
"SortOrder": "1",
"ID": "1234"
}
Unauthorized
Authorization: Authorization
name: Authorizationtype: apiKeyscopes: read,write
in: header
- curl
- python
- javascript
- php
- csharp
- java
- CURL
curl -L 'https://localhost:8092' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
ResponseClear