Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique inbox identifier

Pattern: ^[cC][^\s-]{8,}$

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

Move the inbox to a different agent. Not nullable: an inbox belongs to exactly one agent, so there is no unlinked state to set it to. Fails with 409 if the target agent already has an inbox.

Pattern: ^[cC][^\s-]{8,}$

Response

OK

Inbox resource representation

id
string
required

Unique identifier of the inbox

Pattern: ^[cC][^\s-]{8,}$
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
required

ID of the agent this inbox belongs to

Pattern: ^[cC][^\s-]{8,}$
createdAt
string<date-time>
required

Timestamp when the inbox was created