Update a sandbox inbox

PATCH/api/v1/sandbox/inboxes/{id}
Requires anorganization API keywith the scopesandbox:write

Rename it, change how many messages it keeps (at most 50) or for how long (at most 30 days), or make it the default. Setting is_default clears it on your other inboxes. Owners and admins only.

Parameters

NameInTypeDescription
idrequiredpathstringThe id identifier.

Request body

  • namestring

    Its name, shown in the dashboard.

  • max_messagesinteger

    How many messages the inbox keeps. Past this, the oldest are deleted.

  • retention_daysinteger

    How many days messages are kept.

  • is_defaultboolean

    Make this your default Sandbox inbox.

Request

PATCH/api/v1/sandbox/inboxes/{id}
curl -X PATCH 'https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Spring newsletter",
    "max_messages": 500
  }'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • idstring

      ULID, issued by the mail server (uppercase).

    • organization_idstring
    • namestring

      Your label, e.g. "Staging" or "CI".

    • usernamestring

      The SMTP username for this inbox (sbx_…). Authenticate with it on smtp_host.

    • smtp_hoststring

      The sandbox SMTP host, sandbox.smtp.mailyte.com.

    • smtp_portsarray<integer>

      2525 (STARTTLS) and 2465 (implicit TLS). The production ports 587/465 do not accept sandbox credentials.

    • max_messagesinteger

      How many messages the inbox keeps. The oldest is deleted when a new one would exceed it.

    • retention_daysinteger

      Messages older than this are deleted.

    • inbound_addressstring

      An address anyone can send to from anywhere, with no SMTP login, that lands in this inbox. Use it as a third-party service's notification address.

    • is_defaultboolean

      Test-mode API sends land in the default inbox. The first inbox you create is the default.

    • share_enabledboolean

      The inbox's public link is on. Read the link and access code with GET /sandbox/inboxes/{id}/share.

    • message_countinteger
    • unread_countinteger
    • last_message_atstring

      When the newest message arrived. Null when the inbox has never had one.

    • created_atstring

      When the inbox was created.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.