Webex · Schema

RegistrationForUpdate

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
hostEmail string - Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site the
autoAcceptRequest boolean Whether or not meeting registration requests are accepted automatically.
requireFirstName boolean Whether or not a registrant's first name is required for meeting registration. This option must always be `true`.
requireLastName boolean Whether or not a registrant's last name is required for meeting registration. This option must always be `true`.
requireEmail boolean Whether or not a registrant's email is required for meeting registration. This option must always be `true`.
requireJobTitle boolean Whether or not a registrant's job title is shown or required for meeting registration.
requireCompanyName boolean Whether or not a registrant's company name is shown or required for meeting registration.
requireAddress1 boolean Whether or not a registrant's first address field is shown or required for meeting registration.
requireAddress2 boolean Whether or not a registrant's second address field is shown or required for meeting registration.
requireCity boolean Whether or not a registrant's city is shown or required for meeting registration.
requireState boolean Whether or not a registrant's state is shown or required for meeting registration.
requireZipCode boolean Whether or not a registrant's postal code is shown or required for meeting registration.
requireCountryRegion boolean Whether or not a registrant's country or region is shown or required for meeting registration.
requireWorkPhone boolean Whether or not a registrant's work phone number is shown or required for meeting registration.
requireFax boolean Whether or not a registrant's fax number is shown or required for meeting registration.
maxRegisterNum number Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a togg
customizedQuestions array Customized questions for meeting registration.
rules array The approval rule for standard questions.
View JSON Schema on GitHub

JSON Schema

webex-registrationforupdate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RegistrationForUpdate",
  "title": "RegistrationForUpdate",
  "type": "object",
  "properties": {
    "hostEmail": {
      "type": "string",
      "example": "'[email protected]'",
      "description": "- Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return an update for a meeting that is hosted by that user."
    },
    "autoAcceptRequest": {
      "type": "boolean",
      "description": "Whether or not meeting registration requests are accepted automatically."
    },
    "requireFirstName": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not a registrant's first name is required for meeting registration. This option must always be `true`."
    },
    "requireLastName": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not a registrant's last name is required for meeting registration. This option must always be `true`."
    },
    "requireEmail": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not a registrant's email is required for meeting registration. This option must always be `true`."
    },
    "requireJobTitle": {
      "type": "boolean",
      "description": "Whether or not a registrant's job title is shown or required for meeting registration."
    },
    "requireCompanyName": {
      "type": "boolean",
      "description": "Whether or not a registrant's company name is shown or required for meeting registration."
    },
    "requireAddress1": {
      "type": "boolean",
      "description": "Whether or not a registrant's first address field is shown or required for meeting registration."
    },
    "requireAddress2": {
      "type": "boolean",
      "description": "Whether or not a registrant's second address field is shown or required for meeting registration."
    },
    "requireCity": {
      "type": "boolean",
      "description": "Whether or not a registrant's city is shown or required for meeting registration."
    },
    "requireState": {
      "type": "boolean",
      "description": "Whether or not a registrant's state is shown or required for meeting registration."
    },
    "requireZipCode": {
      "type": "boolean",
      "description": "Whether or not a registrant's postal code is shown or required for meeting registration."
    },
    "requireCountryRegion": {
      "type": "boolean",
      "description": "Whether or not a registrant's country or region is shown or required for meeting registration."
    },
    "requireWorkPhone": {
      "type": "boolean",
      "description": "Whether or not a registrant's work phone number is shown or required for meeting registration."
    },
    "requireFax": {
      "type": "boolean",
      "description": "Whether or not a registrant's fax number is shown or required for meeting registration."
    },
    "maxRegisterNum": {
      "type": "number",
      "example": 1000,
      "description": "Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity."
    },
    "customizedQuestions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomizedQuestionForCreateMeeting"
      },
      "description": "Customized questions for meeting registration."
    },
    "rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StandardRegistrationApproveRule"
      },
      "description": "The approval rule for standard questions."
    }
  }
}