CreateInbox

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cherami-to/json-schema/cherami-to-create-inbox-schema.json",
  "title": "CreateInbox",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cherami-to-inboxes-api-openapi.yml#/components/schemas/CreateInbox",
  "type": "object",
  "properties": {
    "local_part": {
      "type": "string",
      "description": "The part before @cherami.to, lowercased: 1–64 letters, digits, hyphens or underscores, starting and ending with a letter or digit. Taken, reserved and retired addresses are unavailable."
    },
    "name": {
      "anyOf": [
        {
          "type": "string",
          "description": "Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.",
          "x-max-utf8-bytes": 256
        },
        {
          "type": "null"
        }
      ],
      "description": "Identifies the inbox within the account; not shown to recipients. At most 256 UTF-8 bytes; null or blank means none."
    },
    "sender_name": {
      "anyOf": [
        {
          "type": "string",
          "description": "Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.",
          "x-max-utf8-bytes": 256
        },
        {
          "type": "null"
        }
      ],
      "description": "Display name recipients see on the inbox's mail. At most 256 UTF-8 bytes; null or blank means none."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Your unique value for this one operation. Save it with the exact request before sending; repeating that request with the same key within 24 hours returns what the first one did instead of acting again.",
      "pattern": "^[A-Za-z0-9_-]{1,128}$"
    }
  },
  "required": [
    "local_part"
  ],
  "additionalProperties": false
}