Skip to navigation
API ReferencePodsInboxes

Update Inbox

CLI:

agentmail pods inboxes update --pod-id <pod_id> --inbox-id <inbox_id>

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired
ID of pod.
inbox_idstringRequired
The ID of the inbox.

Request

This endpoint expects an object.
display_namestringOptional

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

statusenumOptional

deactivated stops the inbox sending and receiving mail; active reactivates it. Mail that arrived while the inbox was deactivated is not delivered on reactivation.

Allowed values:
deactivate_atdatetime or nullOptional

Schedule a deactivation, or move one already scheduled. Send null to cancel it. Only an organization- or pod-scoped API key can change it; an inbox-scoped key gets 403.

signatureobject or nullOptional
Set or replace the inbox's signature. Send null to remove it.
metadatamap from strings to nullable strings or doubles or booleans or nullOptional

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, status, deactivate_at, signature, 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_namestringOptional

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

client_idstringOptional
Client ID of inbox.
statusenumOptional

deactivated when the inbox is deactivated. Omitted when the inbox is active. Treat any value other than deactivated as an inbox that sends and receives normally.

Allowed values:
deactivate_atdatetimeOptional
When the inbox is scheduled to deactivate. Omitted when no deactivation is scheduled, and cleared once it happens.
signatureobjectOptional
The signature added to messages this inbox sends. Omitted when none is set.
metadatamap from strings to strings or doubles or booleansOptional
Custom metadata attached to the inbox.

Errors

404
Not Found Error
409
Conflict Error