Mindbox
Клиент

Черный список контактов

Изменение списка некорректных контактов.

Описание метода

Осуществляется с помощью POST-запроса. Адрес запроса и набор принимаемых полей настраиваются в системе Майндбокс.

Добавление в черный список
POST https://api.mindbox.ru/v3/operations/bulk?endpointId={уникальный идентификатор сайта и т.п.}&operation=ImportFakeContacts&csvCodePage=65001&transactionId={Значение ключа идемпотентности в формате GUID} Content-Type: text/csv;charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ}

Параметры запроса

  • endpointId - точка доступа, из которой будут взяты настройки интеграции. Значение настраивается в системе.
  • transactionId - ключ идемпотентности, позволяющий избежать повторного выполнения запроса. Ключ идемпотентности обязательно создавать в формате GUID (рекомендуется версия 4). Для повторных запросов c повторяющимся ключом в ответ вернется статус TransactionAlreadyProcessed.

Описание полей

ЗаголовокОписание
ContactTypeТип контакта. Возможные варианты:
  • Email — email
  • MobilePhone — мобильный номер
  • ExternalIdentity — уникальный идентификатор; его системное имя задается в CustomFieldSystemName
  • Device — идентификатор устройства
  • DiscountCardNumber — номер дисконтной карты
ContactСам контакт
CustomFieldSystemNameСистемное имя идентификатора; обязательное поле для типа контакта ExternalIdentity

Пример запроса внесение контактов в черный список

Добавление в черный список
POST https://api.mindbox.ru/v3/operations/bulk?endpointId={уникальный идентификатор сайта и т.п.}&operation=ImportFakeContacts&csvCodePage=65001 Content-Type: text/csv;charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} Contact;ContactType;CustomFieldSystemName 1@1.RU;Email; fale@fake.ru;Email; 77777777777;MobilePhone; 78888888888;MobilePhone; 111111;ExternalIdentity;WebsiteID 844fcf8b-783c-4297-a0ad-ec5ee966a962;Device;

Пример запроса удаления контактов из черного списка

Удаление из черного списка
POST https://api.mindbox.ru/v3/operations/bulk?endpointId={уникальный идентификатор сайта и т.п.}&operation=DeleteFakeContacts&csvCodePage=65001 Content-Type: text/csv;charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} Contact;ContactType;CustomFieldSystemName 1@1.RU;Email; fale@fake.ru;Email; 78005553535;MobilePhone; 78004453535;MobilePhone; 111111;ExternalIdentity;WebsiteID 844fcf8b-783c-4297-a0ad-ec5ee966a962;Device;
Last modified on