Update the order of opportunity stages
PUT /api/2.0/crm/opportunity/stage/reorder
Request
Updates the available order of opportunity stages with a list specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- ids
array of integer
List of opportunity stage IDs
Examples
PUT /api/2.0/crm/opportunity/stage/reorder HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request PUT \
--url https://example.com/api/2.0/crm/opportunity/stage/reorder \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
Opportunity stages in the new order
- RelativeItemsCount
integer
int32 - SuccessProbability
integer
int32 - StageType
enum of integer
int32 [0 - Open, 1 - ClosedAndWon, 2 - ClosedAndLost]
Can be one of:
Open
,ClosedAndWon
,ClosedAndLost
.- Title
string
- Description
string
- Color
string
- SortOrder
integer
int32 - ID
integer
int32
401
Unauthorized