Удалить профиль

Описание

Полное удаление профиля.

URL-адрес

Метод: POST

https://example.com/api/v1.1/profiles/delete

предупреждение

Данный запрос, помимо самого профиля, синхронно удаляет всю его историю и связи.

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
db_id	int	1	Да	Идентификатор базы данных
Поиск профиля подписчика
matching	string	"email" "email_profile" "phone" "profile_id" "custom"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика. По умолчанию - email.
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Нет	Идентификатор ресурса для поиска по email и phone

предупреждение

Для удаления профиля необходимы соответствующие полномочия, которые настраиваются в роли, после чего соответствующая роль может быть назначена токену. Подробнее о ролях можно узнать здесь.

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "db_id": 1,
    "matching": "email",
    "email": "example@example.com"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <db_id>1</db_id>
  <matching>email</matching>
  <email>example@example.com</email>
</xml>

Пример ответа

JSON

{
    "data": {
        "profile_id": "5f33d33ece94481aa9382110"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <profile_id>5f33d33ece94481aa9382110</profile_id>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
data	JSON object	Информация о профиле
error	int	Код ошибки
error_text	string	Текст ошибки
profile_id	string	Идентификатор профиля