Документация по iSpring Learn

Дерево страниц

POST  /webhook/unsubscribe

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

Заголовок 

Описание 

X-Auth-Account-Url (обязательный)

Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru.

X-Auth-Email (обязательный)

Логин пользователя.

X-Auth-Password (обязательный)

Пароль пользователя.

Параметр

Описание

subscriberName (обязательное)

Имя существующего подписчика.

subscriptionType

Тип события, от которого нужно отписаться: 

  • USER_REGISTERED
  • LEARNERS_ENROLLED_IN_COURSE
  • TRAINING_MEETING_ADDED
  • TRAINING_MEETING_REMOVED
  • TRAINING_MEETING_UPDATED
  • TRAINING_SESSION_PARTICIPANTS_ADDED
  • TRAINING_SESSION_PARTICIPANT_REMOVED
  • COURSE_COMPLETED_SUCCESSFULLY

  • COURSE_ITEM_COMPLETED_SUCCESSFULLY

  • COURSE_STATUS_CHANGED

  • COURSE_ITEM_STATUS_CHANGED

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

curl --location 'https://api-learn.ispringlearn.ru/webhook/unsubscribe' \
--header 'X-Auth-Account-Url: https://myaccount.ispringlearn.ru' \
--header 'X-Auth-Email: email@email.com' \
--header 'X-Auth-Password: password' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "subscriberName": "name",
  "subscriptionType": "LEARNERS_ENROLLED_IN_COURSE"
}'

Коды ответов

Код

Текст

Описание

200

ОК

Подписка удалена.

400

Bad Request

Ошибка в запросе.

401

Unauthorized

Ошибка авторизации.

403

Permission Denied

У пользователя нет прав.

404

Subscription not found

Подписчик не найден.

  • Нет меток