Ручное изменение аудитории

Описание

Позволяет вручную добавить, обновить или удалить пользователей в аудитории без запуска импорта. Идентификация пользователей выполняется через набор «жёстких» идентификаторов (hardIds) — email, телефон, user_id. Операция определяется параметром action.

URL-адрес

POST/audience/manualUpdate

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

Тело запроса (JSON):

Параметр	Тип	Пример	Обязательный	Описание
audience_id	integer	38	Да	Идентификатор аудитории
hardIds	array	—	Да	Список пользователей для изменения
hardIds[].email	object	—	Нет	Идентификатор по email
hardIds[].email.value	string	"example@email.com"	Да*	Значение идентификатора
hardIds[].email.is_hashed	boolean	true	Да*	Признак, что значение захешировано
hardIds[].phone	object	—	Нет	Идентификатор по телефону
hardIds[].phone.value	string	"89000000000"	Да*	Значение идентификатора
hardIds[].phone.is_hashed	boolean	true	Да*	Признак, что значение захешировано
hardIds[].user_id	object	—	Нет	Идентификатор пользователя
hardIds[].user_id.value	string	"user"	Да*	Значение идентификатора
hardIds[].user_id.is_hashed	boolean	true	Да*	Признак, что значение захешировано
priority	object		Нет	Приоритет идентификаторов при сопоставлении
overwriteType	boolean	true	Нет	Перезаписывать типы данных при конфликте
action	string	"upsert"	Да	Действие: upsert — добавить/обновить, delete — удалить

* Для каждого объекта в hardIds должен быть указан хотя бы один тип идентификатора: email, phone или user_id.

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

bash

curl -X POST "https://example.com/api/audience/manualUpdate" \
  -H "X-MOODREC-API: <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "audience_id": 38,
    "hardIds": [
      {
        "email": {
          "value": "AAAAAAA123",
          "is_hashed": true
        },
        "phone": {
          "value": "AAAAAAA123",
          "is_hashed": true
        },
        "user_id": {
          "value": "aaaaaaa",
          "is_hashed": true
        }
      }
    ],
    "priority": {},
    "overwriteType": true,
    "action": "upsert"
  }'

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

json

"ok"

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

Параметр	Тип	Описание
—	string	В случае успеха возвращается строка "ok"