Отписать пользователя от рассылки

Отписывает пользователя от рассылки.

URL

POST https://api.carrotquest.io/v1/users/{id}/unsubscribeemail

В качестве {id} можно использовать:

  • ID из нашей системы
  • Ваш User ID (укажите параметр by_user_id=true). Если пользователя с таким идентификатором не существует, он будет создан автоматически

Аргументы

Этот метод следует общим правилам. Аргументы передаются как GET или POST параметры.

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: user-write)
by_user_id Необязательный. В случае, если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false

Ответ

{
  "meta": {
    "status": 200,
  },
  "data": {}
}

Примеры

Отписать пользователя с CarrotquestId=8173131 (ID из нашей системы):

curl -X POST \
  --data-urlencode "auth_token=XXX" \
  https://api.carrotquest.io/v1/users/8173131/unsubscribeemail

Отписать пользователя с UserId=user-7216 (ID из вашей системы):

curl -X POST \
  --data-urlencode "by_user_id=true" \
  --data-urlencode "auth_token=XXX" \
  https://api.carrotquest.io/v1/users/user-7216/unsubscribeemail