Webex · Schema

RegistrantFormObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
firstName string The registrant's first name.
lastName string The registrant's last name. (Required)
email string The registrant's email.
sendEmail boolean If `true` send email to the registrant. Default: `true`.
jobTitle string The registrant's job title. Registration options define whether or not this is required.
companyName string The registrant's company. Registration options define whether or not this is required.
address1 string The registrant's first address line. Registration options define whether or not this is required.
address2 string The registrant's second address line. Registration options define whether or not this is required.
city string The registrant's city name. Registration options define whether or not this is required.
state string The registrant's state. Registration options define whether or not this is required.
zipCode number The registrant's postal code. Registration options define whether or not this is required.
countryRegion string The America is not a country or a specific region. Registration options define whether or not this is required.
workPhone string The registrant's work phone number. Registration options define whether or not this is required.
fax string The registrant's FAX number. Registration options define whether or not this is required.
customizedQuestions array The registrant's answers for customized questions. Registration options define whether or not this is required.
View JSON Schema on GitHub

JSON Schema

webex-registrantformobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RegistrantFormObject",
  "title": "RegistrantFormObject",
  "type": "object",
  "required": [
    "firstName",
    "lastName",
    "email"
  ],
  "properties": {
    "firstName": {
      "type": "string",
      "example": "Bob",
      "description": "The registrant's first name."
    },
    "lastName": {
      "type": "string",
      "example": "Lee",
      "description": "The registrant's last name. (Required)"
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The registrant's email."
    },
    "sendEmail": {
      "type": "boolean",
      "example": true,
      "description": "If `true` send email to the registrant. Default: `true`."
    },
    "jobTitle": {
      "type": "string",
      "example": "manager",
      "description": "The registrant's job title. Registration options define whether or not this is required."
    },
    "companyName": {
      "type": "string",
      "example": "Cisco Systems, Inc.",
      "description": "The registrant's company. Registration options define whether or not this is required."
    },
    "address1": {
      "type": "string",
      "example": "address1 string",
      "description": "The registrant's first address line. Registration options define whether or not this is required."
    },
    "address2": {
      "type": "string",
      "example": "address2 string",
      "description": "The registrant's second address line. Registration options define whether or not this is required."
    },
    "city": {
      "type": "string",
      "example": "New York",
      "description": "The registrant's city name. Registration options define whether or not this is required."
    },
    "state": {
      "type": "string",
      "example": "New York",
      "description": "The registrant's state. Registration options define whether or not this is required."
    },
    "zipCode": {
      "type": "number",
      "example": 123456,
      "description": "The registrant's postal code. Registration options define whether or not this is required."
    },
    "countryRegion": {
      "type": "string",
      "example": "United States",
      "description": "The America is not a country or a specific region. Registration options define whether or not this is required."
    },
    "workPhone": {
      "type": "string",
      "example": "+1 123456",
      "description": "The registrant's work phone number. Registration options define whether or not this is required."
    },
    "fax": {
      "type": "string",
      "example": "123456",
      "description": "The registrant's FAX number. Registration options define whether or not this is required."
    },
    "customizedQuestions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomizedRegistrant"
      },
      "description": "The registrant's answers for customized questions. Registration options define whether or not this is required."
    }
  }
}