Update an opportunity stage color

PUT /api/2.0/crm/opportunity/stage/{id:[0-9]+}/color

Request

Updates the selected opportunity stage with a color 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

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

Opportunity stage ID

colorstring

New stage color

Examples

PUT /api/2.0/crm/opportunity/stage/%7Bid:[0-9]+%7D/color 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/%7Bid:[0-9]+%7D/color' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Opportunity stage with the updated color

RelativeItemsCountintegerformat: int32
SuccessProbabilityintegerformat: int32
StageTypeenum of integerformat: int32

[0 - Open, 1 - ClosedAndWon, 2 - ClosedAndLost]

Can be one of: Open, ClosedAndWon, ClosedAndLost.

Titlestring
Descriptionstring
Colorstring
SortOrderintegerformat: int32
IDintegerformat: int32

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).