Loyalty

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

contact/edit

Метод contact/edit предназначен для редактирования данных клиента, таких как:

  • Бренд
  • ФИО
  • Email
  • Телефон
  • Дата рождения
  • Пол
  • Страна
  • Город
  • Адрес
  • Подписки
  • Произвольных полей в блоке customFields
  • Точка продаж, где выполняется регистрации контакта

При отправке в запросе параметров [Фамилия, Имя, Отчество] происходит нормализация данных

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

{
  "contact": {
    "firstName": "163   Иван !—  –",           //Имя
    "surname": "     21348972Иванов*()@ ",      //Фамилия
    "middleName": "  Иванович      123 ! —",     //Отчество
}

Пример записи в Creatio

Допустимые символы: A-z, А-я, ёЁ, «тире» в центре и на конце.
1. Из указанного значения будут удалены пробелы в начале и в конце строки
2. Все двойные (и более) пробелы будут заменены на одинарные
3. Максимальное количество символов в одном параметре 100

Логика слияния подписок

Во избежании появления дублирования записей подписок, в системе реализован функционал слияния.
Идентификация записи происходит по колонкам:

  • Канал подписки(channel)
  • Тип рассылки(type)
  • Катерогия подписки(category)
  • Источник подписки(source)
"subscriptions": [
      {
        "channel": "Viber",          //Канал
        "status": "subscribed",      //Статус  
        "type": "Info",              //Тип
        "category": "Акции",         //Категория
        "source": "Основной сайт",   //Источник
        "reason": "NotInterested"    //Причина отписки
      }
]

Если запись с указанными значениями существует в системе, будет изменен «Статус подписки» и «Причина отписки»

Если указанные значения по одному из 4 параметров идентификации не совпадут, будет создана новая запись подписки/отписки.

Принимаемые справочные значения описаны в методе /contact/create

Запрос

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

Заголовки

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

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

{
  "contact": {
    "loyaltyId": "41c69179-dfd4-47e9-7011-cfbf13afcb79",
    "brandCode": "default",
    "id": "132",
    "brandCode": "СамараСофт",
    "firstName": "Наринская",
    "surname": "Виктория",
    "middleName": "Алексеевна",
    "email": "narinskaya.viktoria@samarasoft.com",
    "phone": "79270021598",
    "birthday": "1990-05-27T00:00:00Z",
    "gender": Female",
    "country": "USA",
    "city": "NY",
    "address": "Attorney at Law 1556 Broadway",
    "subscriptions": [
      {
        "channel": "Email",
        "status": "Subscribed",
        "type": "Info"
      }
    ],
    "customFields": {
         "Zip": "443086",
         "AchievementLevel": "Gold"
}
  },
  "shopCode": "000365"
}

Ответ

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

{
	"success": true
}

*Для заполнения справочного значения на стороне creatio, в атрибуте customFields необходимо указать значение колонки «Code» записи, которую необходимо присвоить.

Материал был полезен? Да 2 Нет