Sign in
PodsInboxes

Update Inbox

CLI:

agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
patch/v0/pods/{pod_id}/inboxes/{inbox_id}

Path parameters

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

Request body

display_namestring

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

metadataInboxesUpdateMetadata

Custom key-value pairs to merge into the inbox's existing metadata. A value may be a string, number, boolean, or null. Setting a key to null removes it. Up to 256 keys; keys and string values are each limited to 256 characters.

Response

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

emailstring required

Email address of the inbox.

display_namestring

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

client_idstring

Client ID of inbox.

metadataInboxesMetadata

Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.

Changes

Changed in 5 of the 34 revisions of this API.110

  • 394ddcdd9c297See the full diff
    • ○

      added the new optional request property metadata

      new-optional-request-property

    • ○

      the request property display_name became nullable

      request-property-became-nullable

    • ○

      the request property display_name became optional

      request-property-became-optional

    • ○

      added the optional property code to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property docs to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property fix to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property metadata to the response with the 200 status

      response-optional-property-added

  • 27965096e6181See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8a5b5e92ae2d1See the full diff
    • ▲

      api removed without deprecation

      api-removed-without-deprecation

    This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7fdcd6b4651f1See the full diff
    • ○

      added the required property email to the response with the 200 status

      response-required-property-added

  • b1919d0d52ac1See the full diff
    • ○

      endpoint added

      endpoint-added