inboxes

Edit inbox names

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.

patch/v1/inboxes/{inbox_id}

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Request body

namestring nullable

Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.

sender_namestring nullable

Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.

Response

Success.

idstring required

Cherami resource ID.

local_partstring required
addressstring required
namestring nullable required
sender_namestring nullable required
created_atstring date-time required

UTC timestamp with milliseconds.

Changes

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