Inboxes
Provision and manage inboxes that your agents use to send and receive email.
Inboxes represent individual mailboxes inside your organization. Each inbox can send, receive, and search messages independently.
Create an inbox
- Method:
POST - Path:
/v1/inboxes - Auth: Required
Request body
{
"name": "Customer Success Bot",
"email": "cs-bot@agents.example.com"
}
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Optional display name for the email. |
email | string | No | Custom email address; auto-generated if omitted. |
Response 201 Created
{
"id": "01J3ZKZ0BRQ9SSJK1GRSCX4N4Z",
"name": "Customer Success Bot",
"email": "cs-bot@agents.example.com",
"createdAt": "2024-10-10T19:12:42Z"
// ...additional configuration data may be present
}
List inboxes
- Method:
GET - Path:
/v1/inboxes - Auth: Required
Response 200 OK
[
{
"id": "ibox_01J3ZKZ0BRQ9SSJK1GRSCX4N4Z",
"name": "Customer Success Bot",
"email": "cs-bot@agents.example.com",
"createdAt": "2024-10-10T19:12:42Z"
}
]
Retrieve inbox details
- Method:
GET - Path:
/v1/inboxes/{inboxId} - Auth: Required
Path parameters
| Parameter | Type | Description |
|---|---|---|
inboxId | string | Identifier returned during creation or listing. |
Response 200 OK
{
"id": "ibox_01J3ZKZ0BRQ9SSJK1GRSCX4N4Z",
"name": "Customer Success Bot",
"email": "cs-bot@agents.example.com",
"createdAt": "2024-10-10T19:12:42Z"
}
Delete an inbox
- Method:
DELETE - Path:
/v1/inboxes/{inboxId} - Auth: Required
Deleting an inbox revokes sending access and archives historical messages.
Response 200 OK
{
"id": "ibox_01J3ZKZ0BRQ9SSJK1GRSCX4N4Z",
"name": "Customer Success Bot",
"email": "cs-bot@agents.example.com",
"createdAt": "2024-10-10T19:12:42Z"
}
Tip: Delete inactive inboxes after migrating data to keep your workspace clean.