Cakemail icon

Cakemail

Interact with Cakemail API

Webhook → Archive

AI-generated

Summary

Archive the specified webhook by ID to disable it.

Inputs

  • webhookId (required) — The ID of the webhook (e.g., X1qRXqz1upM9).
  • accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.

Output shape

no body — success/failure only

Returns a success response if the webhook is archived successfully.

Examples

Example 1: Archive a specific webhook for a multi-tenant account

Set accountId to specify a multi-tenant account and provide the webhookId to archive the webhook.

Example 2: Archive a webhook using the authenticated account

Only provide the webhookId, leaving accountId empty to use the authenticated account.

Discussion