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/

Path parameters

mailbox_idstring uuid required

Request body

namestring required

Human-readable name for this channel

typestring required

Type of channel

is_activeboolean

Uncheck to pause this channel without deleting it.

{"stackTrail":"components:schemas:ChannelRequest:properties:settings","oasType":"schema","type":"unknown","description":"Channel-specific configuration settings"}

Response

Channel created successfully. The response carries the one-time plaintext credential (api_key / secret) which is never returned again.

idstring uuid required

primary key for the record as UUID

namestring required

Human-readable name for this channel

typestring required

Type of channel

scope_level'global' | 'maildomain' | 'mailbox' | 'user' required
  • global - Global
  • maildomain - Maildomain
  • mailbox - Mailbox
  • user - User
is_activeboolean

Uncheck to pause this channel without deleting it.

{"stackTrail":"components:schemas:ChannelCreateResponse:properties:settings","oasType":"schema","type":"unknown","description":"Channel-specific configuration settings"}
mailboxstring uuid nullable required

primary key for the record as UUID

maildomainstring uuid nullable required

primary key for the record as UUID

userstring uuid nullable required

primary key for the record as UUID

last_used_atstring date-time nullable required
token_hashstring nullable required
created_atstring date-time required

date and time at which a record was created

updated_atstring date-time required

date and time at which a record was last updated

api_keystring

Plaintext API key — api_key channels and webhook channels with auth_method=api_key.

secretstring

webhook channels with auth_method=jwt — the HMAC/JWT signing secret.