No tracking runs without JavaScript.

Skip to content
Sendtier Docs
Dashboard

Update an inbox

Requires a full-scope key. Updates display_name and retention_days. Address, username, domain and test_mode do not change. retention_days must be from 1 through the plan maximum.

PATCH/v1/inboxes/{inbox_id}

Request body

ParameterDescription
display_name
string

Control characters are rejected. At most 64 characters. An empty name is allowed.

Maximum length: 64.

retention_days
integer

Days to keep received mail, from 1 through the plan maximum.

Full request schema and constraints

Request Body

application/json
  1. body
display_name?string

Control characters are rejected. At most 64 characters. An empty name is allowed.

Lengthlength <= 64
retention_days?integer

Days to keep received mail, from 1 through the plan maximum.

Range1 <= value

Path parameters

ParameterDescription
inbox_idrequired
string
Full parameter schemas and constraints

Path Parameters

inbox_id*string

Authorization

headerAuthorizationBearer <token>

API key: st_live_... or st_test_...

Response Body

The updated inbox.

application/json
  1. response
id*string
address*string
username*string
domain*string
display_name*string
Lengthlength <= 64
retention_days*integer
Range1 <= value
test_mode*boolean

Mode of the key or dashboard session that created the inbox. It never changes.

created_at*string
Formatdate-time