Skip to main content
PATCH
/
inboxes
/
{id}
cURL
curl --request PATCH \
  --url https://api.useanima.sh/v1/inboxes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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

Path Parameters

id
string
required

Unique inbox identifier

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

Body

application/json

Request body for updating an existing inbox

displayName
string | null

Updated human-readable display name (set to null to clear)

Maximum string length: 128
agentId
string | null

Updated agent association (set to null to unlink)

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