Get Started
Portal api methods
Help

PUT api/2.0/crm/opportunity/filter/access This function requires authentication

Description

Sets access rights for other users to the list of all opportunities matching the parameters specified in the request

Parameters
Name Description Type Example
responsibleid
sent in body
Opportunity responsible
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
opportunityStagesid
sent in body
Opportunity stage ID
optional
number 1234
tags
sent in body
Tags
optional
Collection of strings
collection
some text
contactid
sent in body
Contact ID
optional
number 1234
contactAlsoIsParticipant
sent in body
Participation status: take into account opportunities where the contact is a participant or not
optional
Bool value true
fromDate
sent in body
Start date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in body
End date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
stageType
sent in body
Opportunity stage type
optional
ASC.CRM.Core.DealMilestoneStatus
isPrivate
sent in body
Opportunity privacy: private or not Bool value true
accessList
sent in body
List of users with access Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/crm/opportunity/filter/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "responsibleid": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "opportunityStagesid": 1234,
  "tags": [
    "some text"
  ],
  "contactid": 1234,
  "contactAlsoIsParticipant": null,
  "fromDate": "2008-04-10T06-30-00.000Z",
  "toDate": "2008-04-10T06-30-00.000Z",
  "stageType": null,
  "isPrivate": true,
  "accessList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Opportunity list

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-08-17T20:39:00.4206066Z",
      "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-08-17T20:39:00.4206066Z",
      "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-08-17T20:39:00.4206066Z</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-08-17T20:39:00.4206066Z</expectedCloseDate>
    <isPrivate>false</isPrivate>
    <canEdit>false</canEdit>
    <id>0</id>
  </response>
</result>