EndUser

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ada/main/json-schema/ada-end-user-schema.json",
  "title": "EndUser",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ada-end-users-api-openapi.yml#/components/schemas/EndUser",
  "type": "object",
  "properties": {
    "end_user_id": {
      "type": "string",
      "description": "The unique Ada-generated id for the end user"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Caller-supplied identifier that links this end user to your own system (for example a CRM contact ID or a phone number). Unique per AI Agent. Null if not set. Maximum 36 characters; values are case-insensitive. Available for custom channel integrations only (V1)."
    },
    "profile": {
      "$ref": "#/$defs/EndUserProfile",
      "description": "The end user's profile information"
    },
    "created_at": {
      "type": "string",
      "description": "The date and time the end user was created"
    },
    "updated_at": {
      "type": "string",
      "description": "The date and time the end user was updated"
    }
  },
  "$defs": {
    "EndUserProfile": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end user's first name"
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end user's last name"
        },
        "display_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end user's display name"
        },
        "avatar": {
          "type": [
            "string",
            "null"
          ],
          "description": "URL to the end user's avatar image"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end user's email address"
        },
        "language": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end user's language in BCP 47 format"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "description": "Any type"
          },
          "description": "A dictionary of arbitrary key, value pairs assigned to the end user                      - `metadata` keys may only be of type: `string`                      - `metadata` values may only be one of type: `string`, `boolean`, or `integer`"
        },
        "system_properties": {
          "$ref": "#/$defs/EndUserProfileSystemProperties",
          "description": "Read-only profile information set by Ada"
        }
      },
      "description": "The end user's profile information",
      "title": "EndUserProfile"
    },
    "EndUserProfileSystemProperties": {
      "type": "object",
      "properties": {
        "sunshine_user_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Sunshine Conversations user id for the end user"
        }
      },
      "description": "Read-only profile information set by Ada",
      "title": "EndUserProfileSystemProperties"
    }
  }
}