Webex · Schema

Registrant

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	New registrant's ID.
status	string	New registrant's status. * `approved` - Registrant has been approved. * `pending` - Registrant is in a pending list waiting for host or cohost approval. * `rejected` - Registrant has been rejected by
firstName	string	Registrant's first name.
lastName	string	Registrant's last name.
email	string	Registrant's email.
jobTitle	string	Registrant's job title.
companyName	string	Registrant's company.
address1	string	Registrant's first address line.
address2	string	Registrant's second address line.
city	string	Registrant's city name.
state	string	Registrant's state.
zipCode	number	Registrant's postal code.
countryRegion	string	Registrant's country or region.
workPhone	string	Registrant's work phone number.
fax	string	Registrant's FAX number.
registrationTime	string	Registrant's registration time.
customizedQuestions	array	Registrant's answers for customized questions, Registration options define whether or not this is required.
sourceId	string	Registrant's source id.The `sourceId` is from [Create Invitation Sources](/docs/api/v1/meetings/create-invitation-sources) API.
registrationId	string	Registrant's registration ID. Registrants have a special number to identify a registrations if it is webinar-enabled and enabled registration ID.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Registrant",
  "title": "Registrant",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "fbd83190-97b2-4bb0-b56b-8fde463d137b",
      "description": "New registrant's ID."
    },
    "status": {
      "type": "string",
      "enum": [
        "approved",
        "pending",
        "rejected"
      ],
      "description": "New registrant's status.\n * `approved` - Registrant has been approved.\n * `pending` - Registrant is in a pending list waiting for host or cohost approval.\n * `rejected` - Registrant has been rejected by the host or cohost.\n"
    },
    "firstName": {
      "type": "string",
      "example": "bob",
      "description": "Registrant's first name."
    },
    "lastName": {
      "type": "string",
      "example": "Lee",
      "description": "Registrant's last name."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Registrant's email."
    },
    "jobTitle": {
      "type": "string",
      "example": "manager",
      "description": "Registrant's job title."
    },
    "companyName": {
      "type": "string",
      "example": "cisco",
      "description": "Registrant's company."
    },
    "address1": {
      "type": "string",
      "example": "address1 string",
      "description": "Registrant's first address line."
    },
    "address2": {
      "type": "string",
      "example": "address2 string",
      "description": "Registrant's second address line."
    },
    "city": {
      "type": "string",
      "example": "New York",
      "description": "Registrant's city name."
    },
    "state": {
      "type": "string",
      "example": "New York",
      "description": "Registrant's state."
    },
    "zipCode": {
      "type": "number",
      "example": 123456,
      "description": "Registrant's postal code."
    },
    "countryRegion": {
      "type": "string",
      "example": "United States",
      "description": "Registrant's country or region."
    },
    "workPhone": {
      "type": "string",
      "example": "+1 123456",
      "description": "Registrant's work phone number."
    },
    "fax": {
      "type": "string",
      "example": "123456",
      "description": "Registrant's FAX number."
    },
    "registrationTime": {
      "type": "string",
      "example": "2021-09-07T09:29:13+08:00",
      "description": "Registrant's registration time."
    },
    "customizedQuestions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomizedRegistrant"
      },
      "description": "Registrant's answers for customized questions, Registration options define whether or not this is required."
    },
    "sourceId": {
      "type": "string",
      "example": "cisco",
      "description": "Registrant's source id.The `sourceId` is from [Create Invitation Sources](/docs/api/v1/meetings/create-invitation-sources) API."
    },
    "registrationId": {
      "type": "string",
      "example": "1111",
      "description": "Registrant's registration ID. Registrants have a special number to identify a registrations if it is webinar-enabled and enabled registration ID."
    }
  }
}