Get Started
Portal api methods
Help

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
Title string some text
description
sent in body
Description string some text
color
sent in body
Color string some text
successProbability
sent in body
Success probability number 1234
stageType
sent in body
Stage type Open, ClosedAndWon, ClosedAndLost
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

Opportunity stage

Example Response

application/json

{
  "status": 0,
  "response": {
    "relativeItemsCount": 1,
    "successProbability": 20,
    "stageType": 0,
    "title": "Discussion",
    "description": "The potential buyer showed his\/her interest and sees how your offering meets his\/her goal",
    "color": "#B9AFD3",
    "sortOrder": 2,
    "id": 30
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>1</relativeItemsCount>
    <successProbability>20</successProbability>
    <stageType>0</stageType>
    <title>Discussion</title>
    <description>The potential buyer showed his/her interest and sees how your offering meets his/her goal</description>
    <color>#B9AFD3</color>
    <sortOrder>2</sortOrder>
    <id>30</id>
  </response>
</result>