Update Inbox | AgentMail

**CLI:** ```bash agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name" ```

CLI:

$ agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"

**CLI:** ```bash agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name" ```

Authentication

AuthorizationBearer

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

Path parameters

inbox_idstringRequired

The ID of the inbox.

Request

This endpoint expects an object.

display_namestringOptional

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

metadatamap from strings to strings or doubles or booleansOptional

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. Provide at least one of display_name or metadata.

Response

This endpoint returns an object.

pod_idstring

ID of pod.

inbox_idstring

The ID of the inbox.

emailstring

Email address of the inbox.

updated_atdatetime

Time at which inbox was last updated.

created_atdatetime

Time at which inbox was created.

display_namestring

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

client_idstring

Client ID of inbox.

metadatamap from strings to strings or doubles or booleans

Custom metadata attached to the inbox.

Errors

400

Validation Error

404

Not Found Error

CLI:

$ agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"

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

The ID of the inbox.

This endpoint expects an object.

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

This endpoint returns an object.

The ID of the inbox.

Email address of the inbox.

Time at which inbox was last updated.

Time at which inbox was created.

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

Custom metadata attached to the inbox.

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.inboxes.update(
8	inbox_id="inbox_id",
9	)

1	{
2	"pod_id": "pod_id",
3	"inbox_id": "inbox_id",
4	"email": "email",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"created_at": "2024-01-15T09:30:00Z",
7	"display_name": "display_name",
8	"client_id": "client_id",
9	"metadata": {
10	"metadata": "metadata"
11	}
12	}

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.inboxes.update(
8	inbox_id="inbox_id",
9	)

1	{
2	"pod_id": "pod_id",
3	"inbox_id": "inbox_id",
4	"email": "email",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"created_at": "2024-01-15T09:30:00Z",
7	"display_name": "display_name",
8	"client_id": "client_id",
9	"metadata": {
10	"metadata": "metadata"
11	}
12	}