Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
channels

Manage integration channels for a mailbox

post/api/v1.0/mailboxes/{mailbox_id}/channels/{id}/regenerate-secret/

Path parameters

idstring required
mailbox_idstring uuid required

Response

Rotates the channel's secret. Single-active: the previous credential is invalidated immediately. The response carries exactly one of api_key / secret matching the channel's type (and, for webhooks, its current auth_method).

idstring required

Channel id.

api_keystring

Present for api_key channels and webhook channels with auth_method='api_key' — the plaintext API key. api_key channels send it as X-API-Key on inbound API calls; api_key webhooks present it as Authorization: Bearer. Returned ONCE; for api_key webhooks it changes whenever the root rotates.

secretstring

Present for webhook channels with auth_method='jwt' — the freshly minted root receivers use to verify the HMAC sig and JWT.