Skip to main content
PATCH
https://api.aisa.one/apis/v1
/
agentmail
/
inboxes
/
{inbox_id}
Update Inbox
curl --request PATCH \
  --url https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "metadata": {}
}
'
{
  "pod_id": "<string>",
  "inbox_id": "<string>",
  "email": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "client_id": "<string>",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer authentication

Path Parameters

inbox_id
string
required

The ID of the inbox.

Body

application/json

Expects an object; provide at least one of display_name or metadata.

display_name
string

Display name: Display Name <username@domain.com>.

metadata
UpdateMetadata · object

Metadata to merge into the inbox's existing metadata. Keys you include are added or overwritten; keys you omit are left unchanged. To remove a single key, send it with a null value. To clear all metadata, send metadata as null. Sending an empty object is rejected; use null to clear. Each update must include at least one of display_name or metadata.

Response

Response with status 200

pod_id
string
required

ID of pod.

inbox_id
string
required

The ID of the inbox.

email
string
required

Email address of the inbox.

updated_at
string<date-time>
required

Time at which inbox was last updated.

created_at
string<date-time>
required

Time at which inbox was created.

display_name
string

Display name: Display Name <username@domain.com>.

client_id
string

Client ID of inbox.

metadata
Metadata · object

Custom metadata attached to the inbox.