Отписать профиль от ресурса

Описание

Передает в платформу информацию об отписке профиля. Статус подписки профиля на ресурс меняется на "Отписан". Также этот метод позволяет отписать от определенных категорий ресурса.

URL-адрес​

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
rtoken	string	"abcdefghijklmnqrstuvwxyz"	Да	Токен ресурса
smid	string	"abcdefghijklmnqrstuvwxyz"	Да	Идентификатор отправляемого сообщения
categories	array	["cat_to_unsub"]	Нет	Категория ресурса

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

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "rtoken":"2fHLS9YR9daS-a90b371eecc2952f",
  "smid": "fGmXiWU9Y4NSIpCwl4QG6QXAAAQEQsQQQEQEAABCRA",  
  "categories": ["cat_to_unsub"]
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <rtoken>2fHLS9YR9daS-a90b371eecc2952f</rtoken>
  <smid>fGmXiWU9Y4NSIpCwl4QG6QXAAAQEQsQQQEQEAABCRA</smid>
  <categories>cat_to_unsub</categories>
</xml>

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

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "profile_id": "658997338e8f4032d92fd56d"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <profile_id>658997338e8f4032d92fd56d</profile_id>
</xml>

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

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