Set access rights to the contacts by parameters
PUThttps://localhost:8092/api/2.0/crm/contact/filter/access
Sets access rights to the list of contacts with the parameters specified in the request.
Request
- application/json
Body
tagsstring[]
Contact tags
contactStageint32[]
Contact stage ID (warmth)
contactTypeint32[]
Contact type ID
contactListViewinteger
Contact list view
fromDatestring
Start date
toDatestring
End date
isPrivateboolean
Contact privacy: private or not
managerListuuid[]
List of managers
Responses
- 200
- 401
List of contacts
- application/json
- Schema
- Example (auto)
Schema
- Array [
- ]
Addresses object[]
CreateBy object
Createdstring
Example:
2020-12-08T17:37:04.5916406Z
Aboutstring
Example:
About
Industrystring
Example:
Industry
ContactStatus object
ContactType object
CommonData object[]
CustomFields object[]
Tagsstring[]
TaskCountint32
Example:
1
HaveLateTasksboolean
Example:
true
SmallFotoUrlstring
Example:
url to foto
MediumFotoUrlstring
Example:
url to foto
DisplayNamestring
Example:
Tadjeddine Bachir
IsCompanyboolean
Example:
false
AccessList object[]
IsPrivateboolean
Example:
true
IsSharedboolean
Example:
false
ShareTypeint32
[0 - None, 1 - ReadWrite, 2 - Read]
Possible values: [None
, ReadWrite
, Read
]
Example:
0
Currency object
CanEditboolean
Example:
true
CanDeleteboolean
Example:
true
IDint32
Example:
1234
[
{
"Addresses": [
{
"Street": "Lubanas st. 125a-25",
"City": "",
"State": "",
"Zip": "LV-1021",
"Country": "Latvia",
"Category": "0",
"CategoryName": "Home",
"IsPrimary": "true"
}
],
"CreateBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
},
"Created": "2020-12-08T17:37:04.5916406Z",
"About": "About",
"Industry": "Industry",
"ContactStatus": {
"Title": "Title",
"Description": "Description",
"Color": "#a7fc00",
"SortOrder": "1",
"ID": "1234"
},
"ContactType": {
"Title": "Title",
"Description": "Description",
"Color": "#a7fc00",
"SortOrder": "1",
"ID": "1234"
},
"CommonData": [
{
"InfoType": "1",
"Category": "0",
"Data": "support@onlyoffice.com",
"CategoryName": "Home",
"IsPrimary": "true",
"ID": "1234"
}
],
"CustomFields": [
{
"EntityId": "14523423",
"Label": "Birthdate",
"FieldValue": "2020-12-08T17:37:04.5916406Z",
"FieldType": "5",
"Position": "10",
"Mask": "",
"ID": "1234"
}
],
"Tags": [
"Tag1,Tag2"
],
"TaskCount": "1",
"HaveLateTasks": "true",
"SmallFotoUrl": "url to foto",
"MediumFotoUrl": "url to foto",
"DisplayName": "Tadjeddine Bachir",
"IsCompany": "false",
"AccessList": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
}
],
"IsPrivate": "true",
"IsShared": "false",
"ShareType": "0",
"Currency": {
"Title": "Chinese Yuan",
"Symbol": "¥",
"Abbreviation": "CNY",
"CultureName": "CN",
"IsConvertable": "true",
"IsBasic": "false"
},
"CanEdit": "true",
"CanDelete": "true",
"ID": "1234"
}
]
Unauthorized
Authorization: Authorization
name: Authorizationtype: apiKeyscopes: read,write
in: header
- curl
- python
- javascript
- php
- csharp
- java
- CURL
curl -L -X PUT 'https://localhost:8092/api/2.0/crm/contact/filter/access' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
"tags": [
"string"
],
"contactStage": [
0
],
"contactType": [
0
],
"contactListView": 0,
"fromDate": "string",
"toDate": "string",
"isPrivate": true,
"managerList": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}'
ResponseClear