Методы API → Адресная книга

Чтобы воспользоваться методами API, перейдите в раздел Интеграции → вкладка Методы API.

Затем в правом меню выберите нужный тип API — «Адресная книга».

• Contacts

  • GET/api/protected/contacts/phone-numbers — Получение номеров телефонов контактов.
  • GET/api/protected/contacts/phone-numbers/duplicates Get duplicate contacts — Получение дубликатов контактов.
  • PATCH/api/protected/contacts/phone-numbers/duplicates/merge/{id} — Объединение дубликатов контактов.
  • GET/api/protected/contacts/phones Get contacts phones — Получение телефонов контактов.
  • PATCH/api/protected/contacts/restore — Восстановление контактов.
  • PATCH/api/protected/contacts/restore/all — Восстановление всех контактов.
  • GET/api/protected/contacts — Получение списка контактов.
  • POST/api/protected/contacts — Создание нового контакта.
  • DELETE/api/protected/contacts — Удаление контактов.
  • GET/api/protected/contacts/{id} — Получение информации о конкретном контакте.
  • PATCH/api/protected/contacts/{id} — Обновление информации о контакте.
  • DELETE/api/protected/contacts/all — Удаление всех контактов.
  • PUT/api/protected/contacts/{id}/bundle — Добавление контакта в группу.
  • PATCH/api/protected/contacts/{id}/bundle — Изменение группы контакта.
  • PUT/api/protected/contacts/bundle — Добавление контактов в группу.
  • PUT/api/protected/contacts/{id}/favorite — Добавление контакта в избранное.
  • PUT/api/protected/contacts/favorite — Добавление контактов в избранное.
  • DELETE/api/protected/contacts/trash — Очистка корзины контактов.

• Contacts/files

  • POST/api/protected/contacts/import Import contacts — Импорт контактов.
  • POST/api/protected/contacts/preview-import Get preview rows — Предварительный просмотр импортируемых данных.
  • POST/api/protected/contacts/export Export contacts — Экспорт контактов.

• Customers

  • GET/api/protected/customers Get customers on account — Получение списка клиентов.
  • POST/api/protected/customers Create legal customer or natural customer on account — Создание нового юридического или физического лица.
  • DELETE/api/protected/customers Delete customers - all or by filter on account — Удаление клиентов (всех или по фильтру).
  • GET/api/protected/customers/{type} Get dedicated legal or natural customers on account — Получение списка юридических или физических лиц.
  • POST/api/protected/customers/external-reference/{hid} Create legal customer on account by external reference id — Создание юридического лица по внешнему идентификатору.
  • PATCH/api/protected/customers/bulk Update bulk customers by ids customer on account — Массовое обновление клиентов по идентификаторам клиентов в аккаунте.
  • PATCH/api/protected/customers/{id} Update legal customer or natural customer on account — Обновление информации о клиенте.
  • DELETE/api/protected/customers/{id} Delete customer on account — Удаление клиента.
  • PATCH/api/protected/customers/{id}/external-reference/{hid} Update legal customer customer on account by external reference — Обновление юридического лица по внешнему идентификатору.
  • POST/api/protected/customers/revert-soft Revert all soft deleted customers on account — Восстановление всех гибко удаленных клиентов.
  • POST/api/protected/customers/revert-soft/bulk Revert bulk soft deleted customers on account — Массовое восстановление гибко удаленных клиентов.
  • POST/api/protected/customers/{id}/revert-soft Revert soft deleted customer on account — Восстановление гибко удаленного клиента.
  • DELETE/api/protected/customers/soft Soft delete all customers on account — Гибкое удаление всех клиентов.
  • DELETE/api/protected/customers/soft/bulk Soft delete bulk customers on account — Массовое гибкое удаление клиентов
  • DELETE/api/protected/customers/{id}/soft Soft delete customer on account — Гибкое удаление клиента.

• Customer-suggestions

  • GET/api/protected/customer-suggestions Get suggestion bulk legal customer — Получение предложений для юридических лиц.
  • GET/api/protected/customer-suggestions/{id} Get suggestion legal customer by id — Получение предложения для юридического лица по ID.

• Bundles

  • POST/api/protected/bundles — Создание новой группы.
  • GET/api/protected/bundles — Получение списка групп.
  • GET/api/protected/bundles/{id} — Получение информации о конкретной группе.
  • DELETE/api/protected/bundles/{id} — Удаление группы.
  • PATCH/api/protected/bundles/{id} — Обновление информации о группе.
  • PATCH/api/protected/bundles/{id}/contacts — Обновление контактов в группе.
  • PATCH/api/protected/bundles/{id}/contacts/all — Обновление всех контактов в группе.

• Contact v2

  • GET/api/protected/v2/contacts Get contacts on account — Получение контактов на аккаунте (версия 2).

• Customers-groups

  • GET/api/protected/customers-groups Get customer groups on account — Получение групп клиентов в аккаунте.
  • POST/api/protected/customers-groups Create customer group — Создание группы клиентов.
  • PATCH/api/protected/customers-groups/{id} Update customer group — Обновление группы клиентов.
  • DELETE/api/protected/customers-groups/{id} Delete customer group — Удаление группы клиентов.
  • PATCH/api/protected/customers-groups/attach/customers/bulk Bulk attached customer to customers group — Массовое добавление клиентов в группу клиенту.
  • PATCH/api/protected/customers-groups/attach/customers/{id} Attach customer to customers group — Добавление клиента в группу клиентов.
  • DELETE/api/protected/customers-groups/{id}/customers Unlink all customers from customer group — Удаление всех клиентов из группы.
  • DELETE/api/protected/customers-groups/{id}/customers/bulk Unlink customers from customer group — Удаление выбранных клиентов из группы.

Также см.:

Методы API → Интеграция

Методы API → Base

Методы API → Автозвонки

Методы API → API ЛК