Webex · Schema

EmailObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
value	string	The email address.
type	string	The type of the email.
display	string	A human-readable description, primarily used for display purposes.
primary	boolean	Email status boolean value. If the type is work and primary is true, the value must equal `userName`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmailObject",
  "title": "EmailObject",
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address."
    },
    "type": {
      "type": "string",
      "enum": [
        "work",
        "home",
        "room",
        "other"
      ],
      "description": "The type of the email."
    },
    "display": {
      "type": "string",
      "example": "home email description",
      "description": "A human-readable description, primarily used for display purposes."
    },
    "primary": {
      "type": "boolean",
      "description": "Email status boolean value. If the type is work and primary is true, the value must equal `userName`."
    }
  }
}