Disable Webhook Subscription
POST/api/webhook-subscriptions/:id/disable
Pause a subscription without deleting it, and return it in its new state. Deliveries stop immediately; the delivery log and the signing secret are kept, so Enable resumes the same subscription rather than requiring a new one (and a new secret).
webhooks:manageGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Idempotent — calling it on an already-disabled subscription returns 200 with the row unchanged, preserving whatever disabled_reason it already had. A subscription paused this way records disabled_reason: "manual" and is always re-enablable.
Requires the webhooks:manage scope.
Subscriptions are scoped to the tenant, not to the user who created them: any caller holding webhooks:manage on the tenant may act on any subscription it can see in the list. An id that does not exist on the tenant returns 404.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.