cherami.
API referenceInboxes and rules

Edit inbox names

PATCH /v1/inboxes/{inbox_id}

Read as Markdown ↗

PATCH /v1/inboxes/{inbox_id}

Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.

Changes name, sender_name or both. An omitted field stays as it is; null or a blank string clears it. The address can't be changed.

A new sender_name applies to mail sent afterwards.

Parameters

ParameterLocationRequiredTypeMeaning
inbox_idpathYesstringCherami resource ID returned by the API.

Request body

JSON object, at most 4 KiB in total.

Schema: UpdateInbox

FieldRequiredTypeMeaning and constraints
nameNostring or nullIdentifies the inbox within the account; not shown to recipients. At most 256 UTF-8 bytes; null or blank means none.
sender_nameNostring or nullDisplay name recipients see on the inbox's mail. At most 256 UTF-8 bytes; null or blank means none.

Unknown fields are rejected.

At least 1 field must be supplied.

curl example

Supply CHERAMI_API_KEY privately.

Save the payload as request.json, replacing the example values.

{
  "name": "Travel correspondence",
  "sender_name": null
}
curl --silent --show-error --include --request PATCH \
  "https://cherami.to/v1/inboxes/INBOX_ID" \
  --header "Authorization: Bearer $CHERAMI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

HTTP 200

Success.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Inbox

{
  "id": "11111111-1111-4111-8111-111111111111",
  "local_part": "my-agent",
  "address": "my-agent@cherami.to",
  "name": null,
  "sender_name": null,
  "created_at": "2026-10-01T00:00:00.000Z"
}

HTTP 400

invalid_json: Send a valid UTF-8 JSON object, not an array or scalar.

invalid_inbox: Creation takes only local_part, name, sender_name and idempotency_key; an edit takes at least one of name and sender_name, and nothing else.

invalid_name: Use plain text without control characters, at most 256 UTF-8 bytes after trimming. The message names the field.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 401

unauthorized: Send a valid API key as Authorization: Bearer <key>. If the key stopped working, get a new one through recovery.

  • X-Request-ID: Identifies this request; include it when reporting a problem.
  • WWW-Authenticate: "Bearer"

Content type: application/json.

Error

HTTP 404

not_found: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 413

body_too_large: Reduce the JSON request to the operation's body limit.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 415

unsupported_media_type: Send Content-Type: application/json.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 500

internal_error: The operation failed. Retry a read; after a write the change may have happened, so recover as retry by operation describes.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

Schema: Inbox

FieldRequiredTypeMeaning and constraints
idYesstringCherami resource ID.
local_partYesstring
addressYesstring
nameYesstring or null
sender_nameYesstring or null
created_atYesstringUTC timestamp with milliseconds. format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Schema: Error

FieldRequiredTypeMeaning and constraints
errorYesobject

error fields

FieldRequiredTypeMeaning and constraints
codeYesstringCode to handle. Handle a code you don't recognize by its HTTP status.
messageYesstringExplanation of this case; its wording can change.

Errors, limits and pagination · Download OpenAPI 3.1

On this page