Skip to main content
POST
/
inboxes
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/inboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "domain": "<string>",
  "displayName": "<string>",
  "agentId": "<string>"
}
'
{
  "id": "<string>",
  "email": "jsmith@example.com",
  "domain": "<string>",
  "localPart": "<string>",
  "displayName": "<string>",
  "agentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for creating a new inbox

​
username
string

Local part of the inbox email address (letters, numbers, dots, hyphens, underscores). Normalized to lowercase.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9._-]+$
​
domain
string

Domain for the inbox email address; uses the default domain if omitted

​
displayName
string

Human-readable display name for the inbox (max 128 characters)

Maximum string length: 128
​
agentId
string

ID of the agent to associate with this inbox

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

OK

Inbox resource representation

​
id
string
required

Unique identifier of the inbox

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
email
string<email>
required

Full email address of the inbox

​
domain
string
required

Domain portion of the inbox email address

​
localPart
string
required

Local part (before the @) of the inbox email address

​
displayName
string | null
required

Human-readable display name, or null if not set

​
agentId
string | null
required

ID of the associated agent, or null if unassigned

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
createdAt
string<date-time>
required

Timestamp when the inbox was created