Get Started
Portal api methods
Help

PUT api/2.0/crm/contact/access This function requires authentication

Description

Sets access rights for other users to the list of contacts with the IDs specified in the request

Parameters
Name Description Type Example
contactid
sent in body
Contact ID list Collection of numbers
collection
1234
isShared
sent in body
Company privacy: shared or not Bool value true
managerList
sent in body
List of managers Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/crm/contact/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "contactid": [
    1234
  ],
  "isShared": true,
  "managerList": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Contact list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "firstName": "Tadjeddine",
      "lastName": "Bachir",
      "company": {
        "companyName": "Food and Culture Project",
        "about": "",
        "haveLateTasks": false,
        "displayName": null,
        "isCompany": true,
        "isPrivate": false,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Programmer",
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2019-10-15T09:54:28.5444399Z",
      "about": "",
      "commonData": [
        {
          "id": 0,
          "infoType": 1,
          "category": 0,
          "data": "support@onlyoffice.com",
          "categoryName": "Home",
          "isPrimary": true
        }
      ],
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2019-10-15T09:54:28.5444399Z",
          "fieldType": 5,
          "position": 10,
          "mask": "",
          "id": 0
        }
      ],
      "haveLateTasks": false,
      "displayName": null,
      "isCompany": false,
      "isPrivate": false,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": true,
      "canDelete": true,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <firstName>Tadjeddine</firstName>
    <lastName>Bachir</lastName>
    <company>
      <companyName>Food and Culture Project</companyName>
      <about></about>
      <haveLateTasks>false</haveLateTasks>
      <displayName />
      <isCompany>true</isCompany>
      <isPrivate>false</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </company>
    <title>Programmer</title>
    <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-10-15T09:54:28.5444399Z</created>
    <about></about>
    <commonData>
      <id>0</id>
      <infoType>1</infoType>
      <category>0</category>
      <data>support@onlyoffice.com</data>
      <categoryName>Home</categoryName>
      <isPrimary>true</isPrimary>
    </commonData>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2019-10-15T09:54:28.5444399Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>false</isCompany>
    <isPrivate>false</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>