Get Started
Usage API
More information

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

Description

Sets access rights to the list of all the cases matching the parameters specified in the request.

Parameters
Name Description Type Example
contactid
sent in body
Contact ID
optional
number 1234
isClosed
sent in body
Case status
optional
Bool value true
tags
sent in body
Case tags
optional
Collection of strings
collection
some text
isPrivate
sent in body
Case 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/case/filter/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "contactid": 1234,
  "isClosed": null,
  "tags": [
    "some text"
  ],
  "isPrivate": true,
  "accessList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

List of cases

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": "2021-10-27T14:55:38.5219336Z",
      "title": "Exhibition organization",
      "isClosed": false,
      "isPrivate": false,
      "canEdit": true,
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2021-10-27T14:55:38.5219336Z",
          "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>2021-10-27T14:55:38.5219336Z</created>
    <title>Exhibition organization</title>
    <isClosed>false</isClosed>
    <isPrivate>false</isPrivate>
    <canEdit>true</canEdit>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2021-10-27T14:55:38.5219336Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <id>0</id>
  </response>
</result>