Золотенков
Выпустить ключ

Изменить подписку

PATCH https://mrp.zolotenkov.ru/api/external/v1/webhook-subscriptions/{id}

Требуемое право ключа: write:webhook.subscription.update

Меняет набор событий, признак включенности и описание. Отсутствующее в теле поле сохраняет прежнее значение. Адрес получателя не меняется: под другой адрес заводится другая подписка, иначе журнал доставок перестает отвечать на вопрос «куда это уходило».

"enabled": true возвращает в строй сбойную подписку: пометка failing снимается, счетчик неудач обнуляется. События, накопившиеся за время простоя, повторно не рассылаются.

Параметры пути

  • id целое число обязателен

    id подписки

Заголовки

  • Idempotency-Key строка обязателен

    Обязателен, до 200 символов. Повтор с тем же ключом возвращает прежний ответ.

Тело запроса

Формат — application/json.

  • description строка необязателен может быть пустым
  • enabled флаг необязателен может быть пустым

    Включить или выключить доставку. Включение снимает пометку failing и обнуляет счетчик неудач.

  • events массив строк необязателен может быть пустым

    Новый набор типов событий целиком, а не добавка к прежнему.

Ответы

  • 200 Подписка изменена
  • 400 Пустой или неизвестный набор событий, слишком длинное описание
  • 401 Ключ не передан, недействителен или отозван
  • 403 У ключа нет права write:webhook.subscription.update
  • 404 Подписки с таким id у этого клиента нет
  • 409 Idempotency-Key повторен с другим телом
  • 429 Превышена частота обращений. Задержка до повтора — в заголовке Retry-After