{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 95204914252,
      "description": "Webinar ID in **long** format, represented as int64 data type in JSON, also known as the webinar number."
    },
    "uuid": {
      "type": "string",
      "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
      "description": "Webinar UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Name of the user who submitted answers to the poll. If the `anonymous` option is enabled for a poll, the participant's polling information will be kept anonymous and the value of `name` field will be `Anonymous Attendee`."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the user who submitted answers to the poll. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "Good",
                  "description": "Answer submitted by the user."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "Question asked during the poll."
                },
                "date_time": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2022-03-26T05:37:59Z",
                  "description": "Date and time when the answer to the poll was submitted."
                },
                "polling_id": {
                  "type": "string",
                  "example": "QalIoKWLTJehBJ8e1xRrbQ",
                  "description": "Unique identifier of the poll."
                }
              }
            }
          }
        }
      }
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T05:37:59Z",
      "description": "The webinar's start time."
    }
  }
}

{
  "type": "object",
  "title": "Poll List",
  "properties": {
    "polls": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Meeting and Webinar Polling Object",
        "properties": {
          "id": {
            "type": "string",
            "example": "QalIoKWLTJehBJ8e1xRrbQ",
            "description": "ID of Poll"
          },
          "title": {
            "type": "string",
            "example": "Learn something new",
            "maxLength": 64,
            "description": "The poll's title, up to 64 characters."
          },
          "status": {
            "enum": [
              "notstart",
              "started",
              "ended",
              "sharing"
            ],
            "type": "string",
            "example": "notstart",
            "extensions": {
              "x-enum-descriptions": [
                "Poll not start",
                "Poll started",
                "Poll ended",
                "Poll is sharing"
              ]
            },
            "description": "Status of Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
          },
          "anonymous": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
          },
          "poll_type": {
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer",
            "example": 2,
            "description": "The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "How useful was this meeting?",
                  "maxLength": 255,
                  "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
                },
                "type": {
                  "enum": [
                    "single",
                    "multiple",
                    "matching",
                    "rank_order",
                    "short_answer",
                    "long_answer",
                    "fill_in_the_blank",
                    "rating_scale"
                  ],
                  "type": "string",
                  "example": "single",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Single choice",
                      "Multiple choice",
                      "Matching",
                      "Rank order",
                      "Short answer",
                      "Long answer",
                      "Fill in the blank",
                      "Rating scale"
                    ]
                  },
                  "description": "The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale."
                },
                "answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Extremely useful"
                  },
                  "minItems": 2,
                  "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
                },
                "prompts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "prompt_question": {
                        "type": "string",
                        "example": "How are you?",
                        "description": "The question prompt's title."
                      },
                      "prompt_right_answers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "Good"
                        },
                        "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                      }
                    }
                  },
                  "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
                },
                "right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "minItems": 1,
                  "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
                },
                "case_sensitive": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`."
                },
                "answer_required": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
                },
                "rating_max_label": {
                  "type": "string",
                  "example": "Extremely Likely",
                  "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_max_value": {
                  "type": "integer",
                  "example": 4,
                  "maximum": 10,
                  "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_label": {
                  "type": "string",
                  "example": "Not likely",
                  "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_value": {
                  "type": "integer",
                  "example": 0,
                  "minimum": 0,
                  "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
                },
                "show_as_dropdown": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`."
                },
                "answer_max_character": {
                  "type": "integer",
                  "example": 200,
                  "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
                },
                "answer_min_character": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
                }
              }
            },
            "description": "Information about the poll's questions."
          }
        },
        "description": "Information about meeting and webinar polling."
      },
      "description": "Array of Polls"
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages"
    }
  },
  "description": "Poll List"
}

{
  "type": "object",
  "title": "Registration list",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated** This field will be deprecated. We will no longer support this field in a future release. Instead, use `next_page_token` for pagination."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "Registrant ID."
          },
          "org": {
            "type": "string",
            "example": "Cooking Org",
            "description": "The registrant's organization."
          },
          "zip": {
            "type": "string",
            "example": "94045",
            "description": "The registrant's ZIP or postal code."
          },
          "city": {
            "type": "string",
            "example": "Mountain View",
            "description": "The registrant's city."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "maxLength": 128,
            "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "phone": {
            "type": "string",
            "example": "5550100",
            "description": "The registrant's phone number."
          },
          "state": {
            "type": "string",
            "example": "CA",
            "description": "The registrant's state or province."
          },
          "status": {
            "enum": [
              "approved",
              "denied",
              "pending"
            ],
            "type": "string",
            "example": "approved",
            "description": "The status of the registrant's registration.   \n  `approved` - User has been successfully approved for the webinar.  \n  `pending` -  The registration is still pending.  \n  `denied` - User has been denied from joining the webinar."
          },
          "address": {
            "type": "string",
            "example": "1800 Amphibious Blvd.",
            "description": "The registrant's address."
          },
          "country": {
            "type": "string",
            "example": "US",
            "description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
          },
          "comments": {
            "type": "string",
            "example": "Looking forward to the discussion.",
            "description": "The registrant's questions and comments."
          },
          "industry": {
            "type": "string",
            "example": "Food",
            "description": "The registrant's industry."
          },
          "join_url": {
            "type": "string",
            "format": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL that an approved registrant can use to join the meeting or webinar."
          },
          "job_title": {
            "type": "string",
            "example": "Chef",
            "description": "The registrant's job title."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "maxLength": 64,
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "maxLength": 64,
            "description": "The registrant's first name."
          },
          "create_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-22T05:59:09Z",
            "description": "The time when the registrant registered."
          },
          "no_of_employees": {
            "enum": [
              "",
              "1-20",
              "21-50",
              "51-100",
              "101-250",
              "251-500",
              "501-1,000",
              "1,001-5,000",
              "5,001-10,000",
              "More than 10,000"
            ],
            "type": "string",
            "example": "1-20",
            "description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
          },
          "custom_questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "What do you hope to learn from this?",
                  "description": "The title of the custom question."
                },
                "value": {
                  "type": "string",
                  "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
                  "maxLength": 128,
                  "description": "The custom question's response value. This has a limit of 128 characters."
                }
              },
              "description": "Information about custom questions."
            },
            "description": "Information about custom questions."
          },
          "purchasing_time_frame": {
            "enum": [
              "",
              "Within a month",
              "1-3 months",
              "4-6 months",
              "More than 6 months",
              "No timeframe"
            ],
            "type": "string",
            "example": "1-3 months",
            "description": "The registrant's purchasing time frame. \n* `Within a month.` \n* `1-3 months.` \n* `4-6 months.` \n* `More than 6 months.` \n* `No timeframe.`"
          },
          "role_in_purchase_process": {
            "enum": [
              "",
              "Decision Maker",
              "Evaluator/Recommender",
              "Influencer",
              "Not involved"
            ],
            "type": "string",
            "example": "Influencer",
            "description": "The registrant's role in the purchase process. \n* `Decision maker` \n* `Evaluator/Recommender.` \n* `Influencer.` \n* `Not involved.`"
          }
        },
        "description": " Registrant."
      },
      "description": "List of registrant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
    }
  },
  "description": "List of users."
}

{
  "type": "object",
  "title": "Webinar Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the selected fields are required or optional."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last Name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal Code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job Title",
                "Purchasing Time Frame",
                "Role in Purchase Process",
                "Number of Employees",
                "Questions & Comments"
              ]
            },
            "description": "Field name"
          }
        }
      },
      "description": "Array of registration fields whose values should be provided by registrants during registration."
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single_radio",
              "single_dropdown",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Radio Answer",
                "Single Dropdown Answer",
                "Multiple Answer"
              ]
            },
            "description": "The question-answer type."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "An array of answer choices. Can't be used for short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether or not the custom question is required to be answered by a registrant."
          }
        }
      },
      "description": "Array of Registrant Custom Questions."
    }
  },
  "description": "Webinar Registrant Questions"
}

{
  "type": "object",
  "properties": {
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of registration records for this Webinar."
    },
    "tracking_sources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "5516482804110",
            "description": "Unique Identifier of the tracking source."
          },
          "source_name": {
            "type": "string",
            "example": "https://example.com",
            "description": "Name of the source (platform) where the registration URL was shared."
          },
          "tracking_url": {
            "type": "string",
            "example": "https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg",
            "description": "Tracking URL. The URL that was shared for the registration."
          },
          "visitor_count": {
            "type": "integer",
            "example": 1,
            "description": "Number of visitors who visited the registration page from this source."
          },
          "registration_count": {
            "type": "integer",
            "example": 1,
            "description": "Number of registrations made from this source."
          }
        }
      },
      "description": "Tracking Sources object."
    }
  }
}

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "ull6574eur",
            "description": "The webinar template's ID."
          },
          "name": {
            "type": "string",
            "example": "Weekly Meeting Template",
            "description": "The webinar template's name."
          },
          "type": {
            "type": "integer",
            "example": 1,
            "description": "The webinar template type.  `1`: Webinar template    `2`: Admin webinar template"
          }
        }
      },
      "description": "Information about the webinar templates."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of records returned."
    }
  }
}

{
  "type": "object",
  "properties": {
    "webinars": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 1234567890,
            "description": "The webinar ID."
          },
          "type": {
            "enum": [
              5,
              6,
              9
            ],
            "type": "integer",
            "default": 5,
            "example": 9,
            "description": "The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time."
          },
          "uuid": {
            "type": "string",
            "example": "4444AAAiAAAAAiAiAiiAii==",
            "description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Webinar",
            "description": "The webinar's topic."
          },
          "agenda": {
            "type": "string",
            "example": "Learn more about Zoom APIs",
            "description": "Webinar description. The agenda length gets truncated to 250 characters when you list all webinars for a user. To view the complete agenda, retrieve details for a single webinar, use the [**Get a webinar**](https://developers.zoom.us) API."
          },
          "host_id": {
            "type": "string",
            "example": "x1yCzABCDEfg23HiJKl4mN",
            "description": "The host's ID."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "The webinar's duration, in minutes."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL to join the webinar."
          },
          "timezone": {
            "type": "string",
            "example": "America/Los_Angeles",
            "description": "The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2021-07-01T22:00:00Z",
            "description": "The webinar's creation time."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-07-13T21:00:00Z",
            "description": "The webinar's start time."
          },
          "is_simulive": {
            "type": "boolean",
            "example": true,
            "description": "Whether the webinar is `simulive`."
          }
        }
      },
      "description": "List of webinar objects."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
    }
  },
  "description": "List of webinars."
}

{
  "type": "object",
  "title": "Webinar Registrant",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "95204914252"
    },
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "status": {
      "enum": [
        "approved",
        "denied",
        "pending"
      ],
      "type": "string",
      "example": "approved",
      "description": "The registrant's status: \n* `approved` — Registrant is approved. \n* `denied` — Registrant is denied. \n* `pending` — Registrant is waiting for approval."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "join_url": {
      "type": "string",
      "format": "string",
      "example": "https://example.com/j/11111"
    },
    "language": {
      "enum": [
        "en-US",
        "de-DE",
        "es-ES",
        "fr-FR",
        "jp-JP",
        "pt-PT",
        "ru-RU",
        "zh-CN",
        "zh-TW",
        "ko-KO",
        "it-IT",
        "vi-VN",
        "pl-PL",
        "Tr-TR"
      ],
      "type": "string",
      "example": "en-US",
      "description": "The registrant's language preference for confirmation emails: \n* `en-US` — English (US) \n* `de-DE` — German (Germany) \n* `es-ES` — Spanish (Spain) \n* `fr-FR` — French (France) \n* `jp-JP` — Japanese \n* `pt-PT` — Portuguese (Portugal) \n* `ru-RU` — Russian \n* `zh-CN` — Chinese (PRC) \n* `zh-TW` — Chinese (Taiwan) \n* `ko-KO` — Korean \n* `it-IT` — Italian (Italy) \n* `vi-VN` — Vietnamese \n* `pl-PL` — Polish \n* `Tr-TR` — Turkish"
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "create_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T06:44:14Z"
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-250",
        "251-500",
        "501-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The title of the custom question."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": "Webinar registrant."
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "name",
      "description": "The name tag's name.\n\n**Note:** This value cannot exceed more than 50 characters."
    },
    "is_default": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether set the name tag as the default name tag or not."
    },
    "text_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's text color."
    },
    "accent_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's accent color."
    },
    "background_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's background color."
    },
    "set_default_for_all_panelists": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether to set the name tag as the new default for all panelists or not. This includes panelists not currently assigned a default name tag."
    }
  },
  "description": "Name tag information"
}

{
  "type": "object",
  "required": [
    "page_url",
    "stream_key",
    "stream_url"
  ],
  "properties": {
    "page_url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/livestream/123",
      "maxLength": 1024,
      "description": "The webinar live stream page's URL."
    },
    "resolution": {
      "type": "string",
      "example": "720p",
      "description": "The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`"
    },
    "stream_key": {
      "type": "string",
      "example": "contact-it@example.com",
      "maxLength": 512,
      "description": "The webinar live stream name and key."
    },
    "stream_url": {
      "type": "string",
      "example": "https://example.com/livestream",
      "maxLength": 1024,
      "description": "The webinar live stream URL."
    }
  },
  "description": "Webinar live stream."
}

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "start",
        "stop"
      ],
      "type": "string",
      "example": "start",
      "extensions": {
        "x-enum-descriptions": [
          "Start a webinar live stream.",
          "Stop a webinar live stream."
        ]
      },
      "description": "Update the live stream's status. \n\n* `start` - Start a webinar live stream.\n\n* `stop`- Stop an ongoing webinar live stream."
    },
    "settings": {
      "type": "object",
      "properties": {
        "display_name": {
          "type": "string",
          "example": "Jill Chill",
          "maxLength": 50,
          "minLength": 1,
          "description": "Display the live stream's name."
        },
        "active_speaker_name": {
          "type": "boolean",
          "example": true,
          "description": "Display the name of the active speaker during a live stream."
        }
      },
      "description": "Update the live stream session's settings.  **Only** settings for a stopped live stream can be updated."
    }
  },
  "description": "Webinar live stream status."
}

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "approve",
        "deny",
        "cancel"
      ],
      "type": "string",
      "example": "approve",
      "extensions": {
        "x-enum-descriptions": [
          "Approve",
          "Deny",
          "Cancel"
        ]
      },
      "description": "The registration action to perform. \n* `approve` - Approve the registrant. \n* `deny` - Reject the registrant. \n* `cancel` - Cancel the registrant's approval."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "The registrant's ID."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The registrant's email address."
          }
        }
      },
      "maximum": 30,
      "description": "The registrant information."
    }
  }
}

{
  "type": "object",
  "title": "Webinar registrant questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the selected fields are required or optional."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job title",
                "Purchasing time frame",
                "Role in purchase process",
                "Number of employees",
                "Questions & comments"
              ]
            },
            "description": "Field name"
          }
        }
      },
      "description": "Array of registration fields whose values should be provided by registrants."
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single_radio",
              "single_dropdown",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Radio Answer",
                "Single Dropdown Answer",
                "Multiple Answer"
              ]
            },
            "description": "The question-answer type."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "An array of answer choices. Can't be used for short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether or not a registrant is required to answer the custom question."
          }
        }
      },
      "description": "Array of custom questions for registrants."
    }
  },
  "description": "Webinar registrant questions."
}

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        5,
        6,
        9
      ],
      "type": "integer",
      "default": 5,
      "example": 5,
      "extensions": {
        "x-enum-descriptions": [
          "Webinar",
          "Recurring Webinar with no fixed time",
          "Recurring Webinar with fixed time"
        ]
      },
      "description": "Webinar types. \n `5` - webinar.  \n `6` - Recurring webinar with no fixed time.  \n `9` - Recurring webinar with a fixed time."
    },
    "topic": {
      "type": "string",
      "example": "My webinar",
      "description": "The webinar topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Webinar",
      "description": "Webinar description."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Webinar duration, in minutes. Used for scheduled webinar only."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "[Webinar passcode](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords). By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ * !] and can have a maximum of 10 characters.\n\n**Note:** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements.   \n   \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](https://developers.zoom.us) API or the [**Get account settings**](https://developers.zoom.us) API. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the webinar in the response even if it is not provided in the API request."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the webinar."
        },
        "hd_video": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Default to HD video."
        },
        "on_demand": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Make the webinar on-demand."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when host joins the webinar."
        },
        "survey_url": {
          "type": "string",
          "example": "https://example.com",
          "description": "Survey url for post webinar survey"
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "add_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add watermark that identifies the viewing participant."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.** \n\n As an alternative, use the ``meeting_authentication`, `authentication_option`, and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the webinar."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "email_language": {
          "type": "string",
          "example": "en-US",
          "description": "Set the email language to one of the following.\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
        },
        "panelists_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when panelists join the webinar."
        },
        "practice_session": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable practice session."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Alternative host emails or IDs. Separate multiple values by commas."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration types. Only used for recurring webinars with a fixed time.  \n `1` - Attendees register once and can attend any of the webinar sessions.  \n `2` - Attendees need to register for each session in order to attend.  \n `3` - Attendees register once and can choose one or more sessions to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the registration page."
        },
        "close_registration": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Close registration after event date."
        },
        "notify_registrants": {
          "type": "boolean",
          "example": true,
          "description": "Send notification email to registrants when the host updates a webinar."
        },
        "add_audio_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add audio watermark that identifies the participants."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f)."
        },
        "post_webinar_survey": {
          "type": "boolean",
          "example": true,
          "description": "Zoom will open a survey page in attendees' browsers after leaving the webinar."
        },
        "question_and_answer": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Enable [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false` - Disable Q&A for webinar."
            },
            "auto_reply_text": {
              "type": "string",
              "example": "Thank you for your question. We will get back to you shortly.",
              "description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
            },
            "allow_auto_reply": {
              "type": "boolean",
              "example": true,
              "description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
            },
            "answer_questions": {
              "enum": [
                "only",
                "all"
              ],
              "type": "string",
              "example": "all",
              "description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n*  `all` - Attendees are able to view all questions submitted in the Q&A."
            },
            "attendees_can_upvote": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.\n\n* `false` - Attendees can't click the thumbs up button on questions."
            },
            "attendees_can_comment": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can't answer questions or leave a comment in the question thread."
            },
            "allow_submit_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to submit questions.\n\n* `false` - Do not allow submit questions."
            },
            "allow_anonymous_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false` - Do not allow anonymous questions."
            }
          },
          "description": "[Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Webinar authentication option ID."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**\n\n As an alternative, use the `meeting_authentication`, `authentication_option`, and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the webinar."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Allow attendees to join from multiple devices."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "If user has configured [**Sign Into Zoom with Specified Domains**](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated."
        },
        "hd_video_for_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether HD video for attendees is enabled."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Only authenticated users can join the webinar."
        },
        "enable_session_branding": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [Webinar Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the virtual background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,CN",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two letter [country codes](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nIf the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the webinar's language interpreters."
            }
          },
          "description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note** This feature is only available for certain webinar add-ons, and for Education, and Business, and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "panelist_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Require panelists to authenticate to join."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "registrants_restrict_number": {
          "type": "integer",
          "default": 0,
          "example": 100,
          "maximum": 20000,
          "minimum": 0,
          "description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the webinar's sign language interpreters."
            }
          },
          "description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "send_1080p_video_to_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Always send 1080p video to attendees."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Send confirmation email to registrants"
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
        },
        "follow_up_absentees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 days after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 days after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
            }
          },
          "description": "Send follow-up email to absentees."
        },
        "follow_up_attendees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 day after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 day after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to attendees.\n\n* `false` - Do not send follow-up email to attendees."
            }
          },
          "description": "Send follow-up email to attendees."
        },
        "panelists_invitation_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
        },
        "attendees_and_panelists_reminder_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 hour before webinar.",
                  "Send 1 day before webinar.",
                  "Send 1 hour and 1 day before webinar.",
                  "Send 1 week before webinar.",
                  "Send 1 hour and 1 week before webinar.",
                  "Send 1 day and 1 week before webinar.",
                  "Send 1 hour, 1 day and 1 week before webinar."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 hour before webinar.  \n `2` - Send 1 day before webinar.  \n `3` - Send 1 hour and 1 day before webinar.  \n `4` - Send 1 week before webinar.  \n `5` - Send 1 hour and 1 week before webinar.  \n `6` - Send 1 day and 1 week before webinar.  \n `7` - Send 1 hour, 1 day and 1 week before webinar."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
            }
          },
          "description": "Send reminder email to attendees and panelists."
        }
      },
      "description": "Webinar settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring webinars with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types. \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nIf you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. If you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat.   \n    \n  The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as the value of this field.  \n   \n  **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `1,3` as the value of this field.\n\n   \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "Select the final date when the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with `end_times`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the meeting should recur. If you would like to schedule a meeting that recurs every two months, set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time."
    },
    "is_simulive": {
      "type": "boolean",
      "example": true,
      "description": "Whether to set the webinar simulive."
    },
    "schedule_for": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "The user's email address or `userId` to schedule a webinar for."
    },
    "record_file_id": {
      "type": "string",
      "example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
      "description": "The previously recorded file's ID for `simulive`."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    }
  },
  "description": "Webinar object."
}

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "end"
      ],
      "type": "string",
      "example": "end",
      "extensions": {
        "x-enum-descriptions": [
          "end a webinar"
        ]
      }
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "title": "Webinar survey object",
  "properties": {
    "custom_survey": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "Learn something new",
          "maxLength": 64,
          "description": "The survey's title, up to 64 characters."
        },
        "feedback": {
          "type": "string",
          "example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
          "maxLength": 320,
          "description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey, your feedback really makes a difference.`."
        },
        "anonymous": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Allow participants to anonymously answer survey questions. \n* `true` - Anonymous survey enabled. \n* `false` - Participants cannot answer survey questions anonymously. \n\n This value defaults to `true`."
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "How useful was this webinar?",
                "description": "The survey question, up to 420 characters."
              },
              "type": {
                "enum": [
                  "single",
                  "multiple",
                  "matching",
                  "rank_order",
                  "short_answer",
                  "long_answer",
                  "fill_in_the_blank",
                  "rating_scale"
                ],
                "type": "string",
                "example": "single",
                "extensions": {
                  "x-enum-descriptions": [
                    "Single choice",
                    "Multiple choice",
                    "Matching",
                    "Rank order",
                    "Short answer",
                    "Long answer",
                    "Fill in the blank",
                    "Rating scale"
                  ]
                },
                "description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
              },
              "answers": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "Extremely useful",
                  "maxLength": 200
                },
                "minItems": 2,
                "description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
              },
              "prompts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "prompt_question": {
                      "type": "string",
                      "example": "How are you?",
                      "maxLength": 200,
                      "description": "The question prompt's title."
                    }
                  }
                },
                "maxItems": 10,
                "minItems": 2,
                "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
              },
              "answer_required": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
              },
              "rating_max_label": {
                "type": "string",
                "example": "Extremely Likely",
                "maxLength": 50,
                "description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_max_value": {
                "type": "integer",
                "example": 4,
                "maximum": 10,
                "description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_label": {
                "type": "string",
                "example": "Not likely",
                "maxLength": 50,
                "description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_value": {
                "type": "integer",
                "example": 1,
                "minimum": 0,
                "description": "The rating scale's minimum value. This value can't be less than zero. \n\n This field only applies to the `rating_scale` survey."
              },
              "show_as_dropdown": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
              },
              "answer_max_character": {
                "type": "integer",
                "example": 200,
                "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
              },
              "answer_min_character": {
                "type": "integer",
                "example": 1,
                "minimum": 1,
                "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
              }
            }
          },
          "maxItems": 100,
          "minItems": 1,
          "description": "Information about the webinar survey's questions."
        },
        "numbered_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
        },
        "show_question_type": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
        }
      },
      "description": "Information about the customized webinar survey."
    },
    "third_party_survey": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 64,
      "description": "The link to the third party webinar survey."
    },
    "show_in_the_browser": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the **Show in the browser when the webinar ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
    },
    "show_in_the_follow_up_email": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the **Show the link on the follow-up email** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `false`."
    }
  },
  "description": "Information about the webinar survey."
}

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "example": "WVVoU01HTklUVFpNZVRsc1pVZEdkR05IZUd4TWJVNTJZbEU5UFE9PQ==",
      "description": "The Virtual Background's file path, in binary format."
    },
    "default": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether set the file as the default Virtual Background file."
    },
    "set_default_for_all_panelists": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background."
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "J0sFXN2PSOCGrqTqLRwgAQ",
      "description": "The Virtual Background file's ID."
    },
    "name": {
      "type": "string",
      "example": "beach.jpg",
      "description": "The Virtual Background file's name."
    },
    "size": {
      "type": "integer",
      "example": 524288,
      "description": "The Virtual Background file's size, in bytes."
    },
    "type": {
      "enum": [
        "image"
      ],
      "type": "string",
      "example": "image",
      "description": "The Virtual Background file's file type: \n* `image` — An image file."
    },
    "is_default": {
      "type": "boolean",
      "example": true,
      "description": "Whether the file is the default Virtual Background file."
    }
  }
}

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "description": "The wallpaper's file path, in binary format."
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "zazQjwDuQkS3Q2EprNd7jQ",
      "description": "The wallpaper file's ID."
    },
    "name": {
      "type": "string",
      "example": "logo.jpg",
      "description": "The wallpaper file's name."
    },
    "size": {
      "type": "integer",
      "example": 262144,
      "description": "The wallpaper file's size, in bytes."
    },
    "type": {
      "enum": [
        "image"
      ],
      "type": "string",
      "example": "image",
      "description": "The wallpaper file's file type: \n* `image` — An image file."
    }
  }
}