Platitun · API · Подписка на события · Отключить доставку

Отключить доставку

DELETE /api/v1/hooks

Область ключа: hooks · изменяет данные, нужен заголовок Idempotency-Key

Подписка удаляется, и журнал доставки уходит вместе с ней: он о доставке по этому адресу, и держать его без адреса незачем. Опрос заказов при этом работает как работал.

Поля ответа

Поле	Тип	Что это
`removed`	`boolean`	Отключено.

Поводы отказа

Отказ по правилам приходит как {"error":"rejected","refusal":{"kind":"…"}} с кодом 409. Общие для всех путей отказы — в разделе правил.

Код	Что случилось и что делать
`not_found`	Записи нет или она не ваша. Условие владения стоит в самом запросе к базе, поэтому чужая запись выглядит как отсутствующая.

Рядом в этом разделе

GET /api/v1/hooks — Своя подписка на события
PUT /api/v1/hooks — Задать адрес и события
POST /api/v1/hooks/secret — Заменить секрет подписи
POST /api/v1/hooks/resume — Включить доставку снова
POST /api/v1/hooks/test — Пробное событие
GET /api/v1/hooks/deliveries — Журнал доставки
POST /api/v1/hooks/probe — Выдать адрес служебного приёмника
GET /api/v1/hooks/probe — Что принял служебный приёмник