PUT api/2.0/crm/opportunity/stage/{id} This function requires authentication

Description

Updates the selected opportunity stage with the parameters (title, description, success probability, etc.) specified in the request.

Parameters

Name	Description	Type	Example
id sent in url	Opportunity stage ID	number	1234
title sent in body	New stage title	string	some text
description sent in body	New stage description	string	some text
color sent in body	New stage color	string	some text
successProbability sent in body	New stage success probability	number	1234
stageType sent in body	New stage type Allowed values: Open, ClosedAndWon, ClosedAndLost	Open, ClosedAndWon, ClosedAndLost	Open

Example

PUT api/2.0/crm/opportunity/stage/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "description": "some text",
  "color": "some text",
  "successProbability": 1234,
  "stageType": "Open"
}

Returns

Updated opportunity stage

Example Response

application/json

{
  "status": 0,
  "response": {
    "RelativeItemsCount": 1,
    "id": 1234,
    "Title": "Title",
    "Description": "Description",
    "Color": "#a7fc00",
    "SortOrder": 1,
    "SuccessProbability": 20,
    "StageType": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <RelativeItemsCount>1</RelativeItemsCount>
    <id>1234</id>
    <Title>Title</Title>
    <Description>Description</Description>
    <Color>#a7fc00</Color>
    <SortOrder>1</SortOrder>
    <SuccessProbability>20</SuccessProbability>
    <StageType>0</StageType>
  </response>
</result>