PATCH · Bearer

PATCH /api/v1/inboxes/:id

All endpoints · Markdown

Summary

Pause or resume an inbox, set display_name (null clears it), merge metadata, set require_sender_auth, or set screening. status is active or paused. screening is off, observe, or hold. Anything else returns 400 invalid_screening. At least one field is required. A metadata null value removes that key. A metadata object allows at most 256 keys, keys of at most 256 characters, and string, number, or boolean values. The stored JSON must be at most 16 KB. Otherwise the call returns 400 invalid_metadata. Pausing sets paused_at and keeps the address and history. Pausing again keeps the original paused_at. Resuming clears paused_at. Sends return 403 inbox_paused. Real inbound mail is dropped while paused. The inbox still counts toward the plan limit. Another account's inbox returns inbox_not_found. PATCH /api/v1/inboxes/batch is the same update for an inbox whose username is batch. Screening is a heuristic and does not drop mail.

Request

{
  "display_name": "Support",
  "screening": "hold",
  "metadata": {
    "team": "ops",
    "retired": null
  }
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 invalid_screening
  • HTTP 400 invalid_metadata
  • HTTP 403 inbox_paused
  • HTTP 400 invalid_send_mode
  • HTTP 409 owner_required

Idempotency

This route does not document Idempotency-Key or client_id.