Inboxes

Tags: communication, email, messaging

Email inbox and message thread management

Resources

Request and response models used by the endpoints on this page.

InboxListResponse

Field	Type	Required	Description
items	Array	✓
total	Integer	✓

Example:

{
  "items": []  // Array<InboxResponse>,
  "total": 0  // Integer
}

InboxResponse

Field	Type	Required	Description
assistantEnabled	Boolean	✓
autoReplyEnabled	Boolean	✓
createdAt	DateTime	✓
defaultWorkflowId	Integer
emailAddress	EmailStr	✓
emailCount	Integer
generatedEmailAddress	String
id	Integer	✓
name	String	✓
ownerId	Integer	✓
recipient	String
rules	Dict
slug	String
unreadCount	Integer
updatedAt	DateTime	✓
uuid	String	✓

Example:

{
  "id": 0  // Integer,
  "uuid": "string"  // String,
  "emailAddress": "string"  // EmailStr,
  "name": "string"  // String,
  "slug": "string"  // String, optional,
  "generatedEmailAddress": "string"  // String, optional,
  "rules": {}  // Dict, optional,
  "createdAt": "2024-01-01T00:00:00Z"  // DateTime,
  "updatedAt": "2024-01-01T00:00:00Z"  // DateTime,
  "ownerId": 0  // Integer,
  "defaultWorkflowId": 0  // Integer, optional,
  "assistantEnabled": false  // Boolean,
  "autoReplyEnabled": false  // Boolean,
  "recipient": "string"  // String, optional,
  "emailCount": 0  // Integer, optional,
  "unreadCount": 0  // Integer, optional
}

Endpoints

• GET /api/v2/w/{workspace_uuid}/inboxes - List
• POST /api/v2/w/{workspace_uuid}/inboxes - Create
• DELETE /api/v2/w/{workspace_uuid}/inboxes/{inbox_id} - Delete Inbox Id
• GET /api/v2/w/{workspace_uuid}/inboxes/{inbox_id} - Get Inbox Id
• PUT /api/v2/w/{workspace_uuid}/inboxes/{inbox_id} - Update Inbox Id

List

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

Description:

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:

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

Authorization: Requires inboxes:write scope

Parameters:

• request - See InboxCreateRequest

Response: See InboxResponse

---

Delete Inbox Id

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

Description:

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:

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:

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:

• request - See InboxUpdateRequest
• inbox_id (String)

Response: See InboxResponse

---