Inboxes

Update an inbox

patch/v1/inboxes/{inbox_id}

Request

  • Base URL: https://api.send0.dev
  • URL: https://api.send0.dev/v1/inboxes/{inbox_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Inbox id (ibx_…)

Request body

display_namestring nullable
send_policy'open' | 'reply_only' | 'approval'
retention_daysinteger

Days to keep message content (1 to 30, default 7). After that, bodies, extracted fields, attachments and the raw message are deleted and the message reads as expired: true; the rest of the message is deleted after 35 days.

metadataobject
expires_atstring date-time nullable

Response

Inbox

object'inbox' required
idstring required
addressstring required
local_partstring required
domainstring required
display_namestring nullable required
mode'live' | 'sandbox' required
send_policy'open' | 'reply_only' | 'approval' required
status'active' | 'suspended' | 'deleted' required
retention_daysinteger required
metadataobject required
expires_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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