Get Started
Portal api methods
Help

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

Description

Updates the selected opportunity to the stage with the ID specified in the request

Parameters
Name Description Type Example
opportunityid
sent in url
Opportunity ID number 1234
stageid
sent in body
Opportunity stage ID number 1234
Example
PUT api/2.0/crm/opportunity/1234/stage/{id}
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "stageid": 1234
}
Returns

Opportunity

Example Response

application/json

{
  "status": 0,
  "response": {
    "createBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2019-06-23T18:26:26.8405965Z",
    "contact": {
      "smallFotoUrl": "url to foto",
      "displayName": "Tadjeddine Bachir",
      "isCompany": false,
      "isPrivate": false,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": false,
      "canDelete": false,
      "id": 0
    },
    "title": "Hotel catalogue",
    "description": "",
    "responsible": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "stage": {
      "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
    },
    "successProbability": 65,
    "expectedCloseDate": "2019-06-23T18:26:26.8405965Z",
    "isPrivate": false,
    "canEdit": false,
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2019-06-23T18:26:26.8405965Z</created>
    <contact>
      <smallFotoUrl>url to foto</smallFotoUrl>
      <displayName>Tadjeddine Bachir</displayName>
      <isCompany>false</isCompany>
      <isPrivate>false</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </contact>
    <title>Hotel catalogue</title>
    <description></description>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <stage>
      <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>
    </stage>
    <successProbability>65</successProbability>
    <expectedCloseDate>2019-06-23T18:26:26.8405965Z</expectedCloseDate>
    <isPrivate>false</isPrivate>
    <canEdit>false</canEdit>
    <id>0</id>
  </response>
</result>