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

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

URL

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

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

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

Параметры

Параметры аутентификации.

Параметр	Тип	Описание
by_user_id	Optional[boolean]	Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
app	Optional[ID]	ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Замечания

При попытке отписать пользователя, у которого не установлено свойство $email будет возвращена ошибка 400 BadRequest.

Отписать можно только пользователей, которые в текущий момент имеют статус подписки на рассылки Подписан, Ожидает подтверждения, Отписан. При попытке отписать пользователя с другим статусом, будет возвращена ошибка 400 BadRequest.

Ответ

Поле data ответа будет пустым.
Поле meta ответа будет стандартным.

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

Ошибки

Стандартные ошибки Web API.

Примеры

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

curl -X POST \
  -H "Authorization: Token XXX" \
  https://api.carrotquest.io/users/8173131/unsubscribeemail

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

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