Platitun · API · Event subscription · Turn delivery off

Turn delivery off

DELETE /api/v1/hooks

Key scope: hooks · changes data, the Idempotency-Key header is required

The subscription is deleted and the delivery log goes with it: the log is about delivery to that address, and keeping it without the address is pointless. Order polling keeps working as before.

Response fields

Field	Type	What it is
`removed`	`boolean`	Turned off.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

Code	What happened and what to do
`not_found`	The record does not exist or is not yours. The ownership condition is in the database query itself, so someone else’s record looks like a missing one.

Nearby in this section

GET /api/v1/hooks — My event subscription
PUT /api/v1/hooks — Set the address and events
POST /api/v1/hooks/secret — Rotate the signing secret
POST /api/v1/hooks/resume — Turn delivery back on
POST /api/v1/hooks/test — A test event
GET /api/v1/hooks/deliveries — The delivery log
POST /api/v1/hooks/probe — Issue a test receiver address
GET /api/v1/hooks/probe — What the test receiver got