Skip to main content

/api/lite/domain_notification

Создание нового уведомления

/api/lite/domain_notification

Для регистрации необходимо выполнить следующий запрос

{
    "notificationType" : "PURCHASE_CREATED",
    "notificationChannels" : ["EMAIL","SMS"],
    "notificationReceivers" : "test@email.com,test2@notasoft.ru"
}

Обязательные поля: notificationType, notificationChannels, notificationReceivers

Также  необходимо в Header добавить domain, в котором указать нужный домен магазина и авторизацию

notificationType

enum 

Может содержать значения -> Смотри пункт апи - "Получение возможных типов уведомлений"

notificationChannels

[]enum 

Может содержать значения SMS, EMAIL,TELEGRAM, WHATSAPP

Так же можно получить все актуальные возможные значения вызвав соответствующий пункт апи

notificationReceivers

String

Логины пользователей через запятую, которым нужно отправить уведомление

Успех

возвращается id созданного уведомления

{
    "success": true,
    "id": "efea87fb-91d7-b2f6-d705-148727002b13"
}

Ошибка

{
    "success": false,
    "errors": [
        {
            "code": 0,
            "message": "Не задан тип уведомлений"
        }
    ]
}

Обновление уведомления

/api/lite/domain_notification

Для обновления нужно дополнительно указать id, далее указать нужные для обновления поля

{
    "id" : "efea87fb-91d7-b2f6-d705-148727002b13",
    "notificationChannels" : ["EMAIL"],
    "notificationReceivers" : "test@email.com"
}

Успех

возвращается id созданного уведомления

{
    "success": true,
    "id": "efea87fb-91d7-b2f6-d705-148727002b13"
}

Ошибка

{
    "success": false,
    "errors": [
        {
            "code": 0,
            "message": "Данное уведомление не найдено"
        }
    ]
}

 

 

Наверх