Skip to main content

Inboxes

Tags: communication, email, messaging

Endpoints​

List​

GET /api/v2/w/{workspace_uuid}/inboxes

Description:

Email inbox and message thread management

List all inboxes that the current member has permissions to access.

Authorization: Requires inboxes:read scope

Response: See InboxListResponse

Create​

POST /api/v2/w/{workspace_uuid}/inboxes

Description:

Email inbox and message thread management

Create a new inbox for the current member. Requires inboxes:admin scope.

Authorization: Requires inboxes:write scope

Parameters:

Response: See InboxResponse

Delete Inbox Id​

DELETE /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}

Description:

Email inbox and message thread management

Delete an inbox and its global mapping by ID or UUID. Requires INBOXES_ADMIN scope or being the owner.

Authorization: Requires inboxes:admin scope

Parameters:

  • inbox_id (String)

Get Inbox Id​

GET /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}

Description:

Email inbox and message thread management

Get a specific inbox by ID or UUID.

Authorization: Requires inboxes:read scope

Parameters:

  • inbox_id (String)

Response: See InboxResponse

Update Inbox Id​

PUT /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}

Description:

Email inbox and message thread management

Update an existing inbox by ID or UUID. Requires INBOXES_WRITE scope and admin permission on the inbox.

If orgDomainUuid is provided, the inbox's hosting domain is switched to the referenced verified OrgDomain — the same ownership + email-config validation used on create is applied, and the resulting email address becomes <slug>@<domain>. Omitting the field leaves the hosting domain unchanged (the inbox stays on whatever domain it was already on).

Authorization: Requires inboxes:write scope

Parameters:

Response: See InboxResponse