Inboxes

Update an inbox

{ display_name?, metadata?, ttl_seconds?, promotions_filter? }. Metadata is merged; a null value deletes the key. See Metadata. ttl_seconds extends a temporary inbox, counted from now, up to 24 hours after it was created. promotions_filter turns the Promotions & spam view on or off; null goes back to the default (on for role addresses such as hello@ and support@).

Permission: inboxes:write.

patch/v1/inboxes/{id}

Request

  • Base URL: https://api.agentboxd.com
  • URL: https://api.agentboxd.com/v1/inboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

display_namestring nullable
metadataobject
ttl_secondsinteger
promotions_filterboolean nullable

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.