PUT api/2.0/crm/contact/filter/access
Sets access rights for the selected user to the list of contacts with the parameters specified in the request
Name |
Description |
Type |
Example |
isPrivate
sent in body
|
Contact privacy: private or not
|
Bool value
|
true
|
managerList
sent in body
|
List of managers
|
Collection of guids
collection
|
9924256A-739C-462b-AF15-E652A3B1B6EB
|
tags
sent in body
|
Tag
optional
|
Collection of strings
collection
|
some text
|
contactStage
sent in body
|
Contact stage ID (warmth)
optional
|
number
|
1234
|
contactType
sent in body
|
Contact type ID
optional
|
number
|
1234
|
contactListView
sent in body
|
optional
|
All, Company, Person, WithOpportunity
|
|
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
|
PUT api/2.0/crm/contact/filter/access
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"isPrivate": true,
"managerList": [
"00000000-0000-0000-0000-000000000000"
],
"tags": [
"some text"
],
"contactStage": null,
"contactType": null,
"contactListView": "all",
"fromDate": "2008-04-10T06-30-00.000Z",
"toDate": "2008-04-10T06-30-00.000Z"
}
application/json
{
"status": 0,
"response": [
{
"firstName": "Tadjeddine",
"lastName": "Bachir",
"company": {
"companyName": "Food and Culture Project",
"about": "",
"haveLateTasks": false,
"displayName": null,
"isCompany": true,
"isPrivate": true,
"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": "2021-04-23T05:12:39.9059085Z",
"about": "",
"commonData": [
{
"id": 0,
"infoType": 1,
"category": 0,
"data": "support@onlyoffice.com",
"categoryName": "Home",
"isPrimary": true
}
],
"customFields": [
{
"entityId": 14523423,
"label": "Birthdate",
"fieldValue": "2021-04-23T05:12:39.9059085Z",
"fieldType": 5,
"position": 10,
"mask": "",
"id": 0
}
],
"haveLateTasks": false,
"displayName": null,
"isCompany": false,
"isPrivate": true,
"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>true</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>2021-04-23T05:12:39.9059085Z</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>2021-04-23T05:12:39.9059085Z</fieldValue>
<fieldType>5</fieldType>
<position>10</position>
<mask></mask>
<id>0</id>
</customFields>
<haveLateTasks>false</haveLateTasks>
<displayName />
<isCompany>false</isCompany>
<isPrivate>true</isPrivate>
<isShared>false</isShared>
<shareType>0</shareType>
<currency />
<canEdit>true</canEdit>
<canDelete>true</canDelete>
<id>0</id>
</response>
</result>