Skip to navigation
API ReferenceInboxes

Update Inbox

CLI:

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

To pause an inbox, set status to paused; set it back to active to resume. See Pausing an inbox.

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

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

display_namestringOptional

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

statusenumOptional

paused stops the inbox sending and receiving mail; active resumes it. Mail that arrived while the inbox was paused is not delivered on resume.

Allowed values:
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, 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

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

Allowed values:
metadatamap from strings to strings or doubles or booleansOptional
Custom metadata attached to the inbox.

Errors

400
Validation Error
404
Not Found Error
409
Conflict Error