跳到主要内容

Set access rights to the contacts by parameters

PUT 

https://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

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

List of contacts

Schema
  • Array [
  • Addresses object[]
  • Array [
  • Streetstring
    Example: Lubanas st. 125a-25
    Citystring
    Example:
    Statestring
    Example:
    Zipstring
    Example: LV-1021
    Countrystring
    Example: Latvia
    Categoryint32
    Example: 0
    CategoryNamestring
    Example: Home
    IsPrimaryboolean
    Example: true
  • ]
  • CreateBy object
    Iduuid
    Example: 00000000-0000-0000-0000-000000000000
    DisplayNamestring
    Example: Mike Zanyatski
    Titlestring
    Example: Manager
    AvatarSmallstring
    Example: url to small avatar
    ProfileUrlstring
    Example: \/Products\/People\/Profile.aspx?user=administrator
    Createdstring
    Example: 2020-12-08T17:37:04.5916406Z
    Aboutstring
    Example: About
    Industrystring
    Example: Industry
    ContactStatus object
    Titlestring
    Example: Title
    Descriptionstring
    Example: Description
    Colorstring
    Example: #a7fc00
    SortOrderint32
    Example: 1
    IDint32
    Example: 1234
    ContactType object
    Titlestring
    Example: Title
    Descriptionstring
    Example: Description
    Colorstring
    Example: #a7fc00
    SortOrderint32
    Example: 1
    IDint32
    Example: 1234
    CommonData object[]
  • Array [
  • InfoTypeint32

    [0 - Phone, 1 - Email, 2 - Website, 3 - Skype, 4 - Twitter, 5 - LinkedIn, 6 - Facebook, 7 - Address, 8 - LiveJournal, 9 - MySpace, 10 - GMail, 11 - Blogger, 12 - Yahoo, 13 - MSN, 14 - ICQ, 15 - Jabber, 16 - AIM, 17 - VK]

    Possible values: [Phone, Email, Website, Skype, Twitter, LinkedIn, Facebook, Address, LiveJournal, MySpace, GMail, Blogger, Yahoo, MSN, ICQ, Jabber, AIM, VK]

    Example: 1
    Categoryint32
    Example: 0
    Datastring
    Example: support@onlyoffice.com
    CategoryNamestring
    Example: Home
    IsPrimaryboolean
    Example: true
    IDint32
    Example: 1234
  • ]
  • CustomFields object[]
  • Array [
  • EntityIdint32
    Example: 14523423
    Labelstring
    Example: Birthdate
    FieldValuestring
    Example: 2020-12-08T17:37:04.5916406Z
    FieldTypeint32

    [0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]

    Possible values: [TextField, TextArea, SelectBox, CheckBox, Heading, Date]

    Example: 5
    Positionint32
    Example: 10
    Maskstring
    Example:
    IDint32
    Example: 1234
  • ]
  • 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[]
  • Array [
  • Iduuid
    Example: 00000000-0000-0000-0000-000000000000
    DisplayNamestring
    Example: Mike Zanyatski
    Titlestring
    Example: Manager
    AvatarSmallstring
    Example: url to small avatar
    ProfileUrlstring
    Example: \/Products\/People\/Profile.aspx?user=administrator
  • ]
  • IsPrivateboolean
    Example: true
    IsSharedboolean
    Example: false
    ShareTypeint32

    [0 - None, 1 - ReadWrite, 2 - Read]

    Possible values: [None, ReadWrite, Read]

    Example: 0
    Currency object
    Titlestring
    Example: Chinese Yuan
    Symbolstring
    Example: ¥
    Abbreviationstring
    Example: CNY
    CultureNamestring
    Example: CN
    IsConvertableboolean
    Example: true
    IsBasicboolean
    Example: false
    CanEditboolean
    Example: true
    CanDeleteboolean
    Example: true
    IDint32
    Example: 1234
  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyscopes: read,writein: header
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"
]
}'
Request Collapse all
Base URL
https://localhost:8092
Auth
Body
{
  "tags": [
    "string"
  ],
  "contactStage": [
    0
  ],
  "contactType": [
    0
  ],
  "contactListView": 0,
  "fromDate": "string",
  "toDate": "string",
  "isPrivate": true,
  "managerList": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!