Loyalty

  1. Домой
  2. Документация
  3. Loyalty
  4. API работы с контактами
  5. contact/unsubscribe

contact/unsubscribe

Метод contact/unsubscribe предназначен для отписки контакта от рассылки.

Принимаемые справочные значения

Массив subscriptions:

  • Парметр «channel» принимает значения:

«Email»
«Sms»
«Push»
«Viber»
«Telegram»

  • Параметр «type» принимает значения:

«Info»
«News»
«Promo»
«Trigger»
«Service»

  • Параметр «category» принимает значения из объекта «SmrSubscriptionCategory», если указанное значение не найдено, будет создано новое
  • Параметр «source» принимает значения из объекта «SmrSubscriptionSource», если указанное значение не найдено, будет создано новое
  • Параметр «reason» принимает значения указанные в объекте «SmrUnsubscribeReason»
    по умолчанию существую значения:

«NotInterested»
«InappropriateContent»
«OnlyOnePromo»
«OtherSources»
«TooOften»
«Spam»
«SeekInformationMyself»

Запрос

URL: https://<адрес сервиса личного кабинета>/contact/unsubscribe
Метод: POST

Заголовки

Authorization: Bearer <token>
Content-Type: application/json

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

{
	"contact": {
		"loyaltyId": "41c69179-dfd4-47e9-7011-cfbf13afcb79",
		"id": "132",
		"phone": "79270021598",
		"brandCode": "default"
	},
	"type": "Info",
	"source": "ДетскийМир.рф",
	"category": "Детские товары",
	"channel": "sms",
	"reason": "NotInterested"
}

Описание параметров

ПараметрТипОписание
contactobjectДанные клиента для авторизации
В зависимости от способа идентификации клиента может содержать внешний идентификатор либо идентификатор программы лояльности, либо номер телефона
loyaltyIdstringИдентификатор программы лояльности
Значение должно быть в формате «guid»
idstringВнешний идентификатор
phonestringМобильный телефон контакта
Значение должно быть в формате «телефон»
brandCode string Код бренда в котором зарегистрирован клиент
Длина строки должна быть меньше или равна 50
typestringТип подписки
Может принимать значения: «Info», «News», «Promo», «Trigger», «Service»
Если параметр не указан, ему будет присвоено значение «Info»
Используется для идентификации подписки при изменении
sourcestringИсточник подписки
Длина строки должна быть меньше или равна 150
Используется для идентификации подписки при изменении
categorystringКатегория подписки
Длина строки должна быть меньше или равна 250
Используется для идентификации подписки при изменении
channelstringКанал подписки
Может принимать значения: «Email», «Sms», «Push», «Viber», «Telegram»
Если параметр не указан, ему будет присвоено значение «Email»
Используется для идентификации подписки при изменении
reasonstringПричина отписки
Может принимать значения колонки [Код] хранящиеся в справочнике «Причина отписки», либо «null»
Если параметр не указан, ему будет присвоено значение null

Ответ

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

{
    "success": true
}
Материал был полезен? Да 2 Нет