Cisco Webex · Schema

CreatePersonRequest

CollaborationCommunicationsMeetingsMessagingTeamsVideo Conferencing

Properties

Name	Type	Description
emails	array	Email addresses for the person.
phoneNumbers	array	Phone numbers for the person.
extension	string	Webex Calling extension.
locationId	string	Location ID for Webex Calling.
displayName	string	Full name of the person.
firstName	string	First name.
lastName	string	Last name.
avatar	string	URL to the avatar image.
orgId	string	Organization ID.
roles	array	Roles to assign.
licenses	array	Licenses to assign.
department	string	Department.
manager	string	Manager name.
managerId	string	Person ID of the manager.
title	string	Job title.
addresses	array	Physical addresses.
siteUrls	array	Webex site URLs.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreatePersonRequest",
  "title": "CreatePersonRequest",
  "type": "object",
  "required": [
    "emails"
  ],
  "properties": {
    "emails": {
      "type": "array",
      "description": "Email addresses for the person.",
      "items": {
        "type": "string",
        "format": "email"
      }
    },
    "phoneNumbers": {
      "type": "array",
      "description": "Phone numbers for the person.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "extension": {
      "type": "string",
      "description": "Webex Calling extension."
    },
    "locationId": {
      "type": "string",
      "description": "Location ID for Webex Calling."
    },
    "displayName": {
      "type": "string",
      "description": "Full name of the person."
    },
    "firstName": {
      "type": "string",
      "description": "First name."
    },
    "lastName": {
      "type": "string",
      "description": "Last name."
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "URL to the avatar image."
    },
    "orgId": {
      "type": "string",
      "description": "Organization ID."
    },
    "roles": {
      "type": "array",
      "description": "Roles to assign.",
      "items": {
        "type": "string"
      }
    },
    "licenses": {
      "type": "array",
      "description": "Licenses to assign.",
      "items": {
        "type": "string"
      }
    },
    "department": {
      "type": "string",
      "description": "Department."
    },
    "manager": {
      "type": "string",
      "description": "Manager name."
    },
    "managerId": {
      "type": "string",
      "description": "Person ID of the manager."
    },
    "title": {
      "type": "string",
      "description": "Job title."
    },
    "addresses": {
      "type": "array",
      "description": "Physical addresses.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "streetAddress": {
            "type": "string"
          },
          "locality": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        }
      }
    },
    "siteUrls": {
      "type": "array",
      "description": "Webex site URLs.",
      "items": {
        "type": "string"
      }
    }
  }
}