Dixa · Schema

EndUser

Customer ServiceConversationalOmnichannelCXHelp DeskChatKnowledge Base

Properties

Name	Type	Description
id	string	Unique identifier for the contact
createdAt	string	Time when the contact was created
displayName	string	The contact's display name
email	string	The contact's primary email address
phoneNumber	string	The contact's primary phone number
additionalEmails	array	Additional email addresses for the contact
additionalPhoneNumbers	array	Additional phone numbers for the contact
firstName	string	The contact's first name
lastName	string	The contact's last name
middleNames	array	The contact's middle names
avatarUrl	string	The url from which to load the contact's avatar
externalId	string	Custom external identifier for the contact
customAttributes	array	Custom attributes for the contact

View JSON Schema on GitHub

JSON Schema

{
  "title": "EndUser",
  "type": "object",
  "required": [
    "id",
    "createdAt"
  ],
  "properties": {
    "id": {
      "description": "Unique identifier for the contact",
      "type": "string",
      "format": "uuid"
    },
    "createdAt": {
      "description": "Time when the contact was created",
      "type": "string",
      "format": "date-time"
    },
    "displayName": {
      "description": "The contact's display name",
      "type": "string"
    },
    "email": {
      "description": "The contact's primary email address",
      "type": "string"
    },
    "phoneNumber": {
      "description": "The contact's primary phone number",
      "type": "string"
    },
    "additionalEmails": {
      "description": "Additional email addresses for the contact",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "additionalPhoneNumbers": {
      "description": "Additional phone numbers for the contact",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "firstName": {
      "description": "The contact's first name",
      "type": "string"
    },
    "lastName": {
      "description": "The contact's last name",
      "type": "string"
    },
    "middleNames": {
      "description": "The contact's middle names",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "avatarUrl": {
      "description": "The url from which to load the contact's avatar",
      "type": "string"
    },
    "externalId": {
      "description": "Custom external identifier for the contact",
      "type": "string"
    },
    "customAttributes": {
      "description": "Custom attributes for the contact",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomAttribute"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}