Get Started
Portal api methods
Help

PUT api/2.0/crm/case/{caseid}/access This function requires authentication

Description

Sets access rights for the selected case with the parameters specified in the request

Parameters
Name Description Type Example
casesid
sent in body
Case ID number 1234
isPrivate
sent in body
Case privacy: private or not Bool value true
accessList
sent in body
List of users with access to the case Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/crm/case/{caseid}/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "casesid": 1234,
  "isPrivate": true,
  "accessList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Case

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-19T01:39:26.2156024Z",
    "title": "Exhibition organization",
    "isClosed": false,
    "isPrivate": false,
    "canEdit": true,
    "customFields": [
      {
        "entityId": 14523423,
        "label": "Birthdate",
        "fieldValue": "2019-08-19T01:39:26.2156024Z",
        "fieldType": 5,
        "position": 10,
        "mask": "",
        "id": 0
      }
    ],
    "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-19T01:39:26.2156024Z</created>
    <title>Exhibition organization</title>
    <isClosed>false</isClosed>
    <isPrivate>false</isPrivate>
    <canEdit>true</canEdit>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2019-08-19T01:39:26.2156024Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <id>0</id>
  </response>
</result>