• Post category:Контакты
  • Запись изменена:03.11.2022

DELETE api/2.0/crm/contact/filter

Для этой функции требуется аутентификация. 

Описание
Удаляет список всех контактов в модуле CRM, соответствующих параметрам, указанным в запросе.

Параметры

Название Описание Тип Пример
tags

sent in body
Теги контактов

необязательно
Коллекция строк
коллекц
текст
contactStage

sent in body
Contact stage ID (warmth)

необязательно
номер 1234
contactType

sent in body
Идентификатор типа контакта

необязательно
номер 1234
contactListView

sent in body
Просмотр списка контактов

Допустимые значения: Company, Person, WithOpportunity
необязательно
All, Company, Person, WithOpportunity
fromDate

sent in body
Дата начала

необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
toDate

sent in body
Дата конца

необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
Пример
DELETE api/2.0/crm/contact/filter
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "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": [
    {
      "smallFotoUrl": "url to foto",
      "displayName": "Tadjeddine Bachir",
      "isCompany": false,
      "isPrivate": true,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": false,
      "canDelete": false,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <smallFotoUrl>url to foto</smallFotoUrl>
    <displayName>Tadjeddine Bachir</displayName>
    <isCompany>false</isCompany>
    <isPrivate>true</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <id>0</id>
  </response>
</result>