Developers
API referenceBusiness sign in

Webhooks

Disable an endpoint

POST/webhook-endpoints/{endpointId}/disable

Scope webhooks.writeLIVE keys only

Stops queued sends; an attempt already in flight may still finish.

Request

Path parameters

Path parameters
NameInTypeDescription
endpointIdRequiredpathstring

Send an empty JSON object ({}) as the body.

Response

Success responses
StatusMeaning
200Disabled

The body is { "status": "success", "data": … }. Fields of data (WebhookEndpointDisabled):

Response data
FieldTypeDescription
endpointRequiredobject
idRequiredstring
urlOptionalstring
is_activeRequiredboolean

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.