API Reference/Webhooks/Delete a webhook

Delete a webhook

DELETEhttps://api.postpress.ai/v1/webhooks/{id}

Delete a webhook by id. Once deleted, no further deliveries will be sent for the associated events. This action is irreversible - to resume deliveries you'll have to create a new webhook.

Authorization

X-API-KEYstringrequired
API key from your postpress dashboard. Sent as a request header.

Path parameters

idstringrequired
The id of the webhook to delete.

Response 200 OK

objectstringWebhookDeletedrequired

Example request

curl --request DELETE \
  --url 'https://api.postpress.ai/api/v1/webhooks/wh_01HXYZ4QK3WJ8FN3M6QH7TZ8GR' \
  --header 'X-API-KEY: pp_live_...' \
  --header 'accept: application/json'

Example response

{
  "object": "WebhookDeleted"
}

Errors

Every error response follows the same envelope:

titlestringrequired
Short error title.
detailstringoptional
Human-readable explanation.
instancestringoptional
Request identifier for support.
typestringrequired
Error type identifier.
statusnumberrequired
HTTP status code.
400 Bad Request8 types

The request is malformed or a parameter is invalid.

  • errors/invalid_parameters - One or more parameters are invalid.
  • errors/malformed_request - The request is malformed.
  • errors/content_too_large - The request is too large.
  • errors/invalid_url - A URL parameter is not a valid URL.
  • errors/too_many_characters - A string parameter exceeds the allowed length.
  • errors/unescaped_characters - The path contains unescaped characters.
  • errors/missing_parameters - A required parameter is missing.
  • errors/limit_too_high - A list parameter exceeds the allowed maximum.
401 Unauthorized13 types

API key is missing, expired, or otherwise invalid.

  • errors/missing_credentials - API key is missing from the request.
  • errors/invalid_credentials - API key is invalid.
  • errors/expired_credentials - API key has expired. Rotate it from the dashboard.
  • errors/insufficient_privileges - This resource is out of your API-key scopes.
  • errors/multiple_sessions - Multiple sessions detected on the same account.
  • errors/wrong_account - The credentials do not match the correct account.
  • errors/invalid_proxy_credentials - The provided proxy credentials are invalid.
  • errors/invalid_checkpoint_solution - The checkpoint resolution did not pass successfully.
  • errors/checkpoint_error - The checkpoint does not appear to be resolvable.
  • errors/expired_link - This link has expired. Generate a new one.
  • errors/disconnected_account - The account is disconnected from the provider service.
  • errors/disconnected_feature - The feature you're trying to reach is disconnected.
  • errors/invalid_credentials_but_valid_account_imap - IMAP/SMTP credentials are invalid but the account is otherwise valid.
403 Forbidden9 types

Authenticated but the action is not allowed.

  • errors/insufficient_permissions - Insufficient permissions to perform the request.
  • errors/account_restricted - The account has been restricted by the provider.
  • errors/account_mismatch - This action cannot be done with your account.
  • errors/unknown_authentication_context - An additional step seems necessary to complete login.
  • errors/session_mismatch - Token user id does not match client session id.
  • errors/feature_not_subscribed - The requested feature has not been subscribed.
  • errors/subscription_required - A subscription is required to use this feature.
  • errors/resource_access_restricted - You don't have access to this resource.
  • errors/action_required - An additional step is required.
404 Not Found2 types

The webhook does not exist or the id is malformed.

  • errors/resource_not_found - No webhook matches the provided id.
  • errors/invalid_resource_identifier - The webhook id is malformed.
500 Internal Server Error3 types

Something went wrong on our side.

  • errors/unexpected_error - Something went wrong.
  • errors/provider_error - The provider is experiencing operational problems. Retry later.
  • errors/authentication_intent_error - The current authentication intent was killed after failure.
503 Service Unavailable5 types

postpress is temporarily unable to handle the request.

  • errors/no_client_session - No client session is currently running.
  • errors/no_channel - No channel to client session.
  • errors/no_handler - Handler missing for that request.
  • errors/network_down - Network is down on the server side. Retry shortly.
  • errors/service_unavailable - Service temporarily unavailable. Retry later.
504 Gateway Timeout1 types

The upstream provider did not respond in time.

  • errors/request_timeout - Request timed out. Retry, and contact support if it persists.
Updated May 2026