PATCH /webinars/{webinarId}/registrants/questions
Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
- Registration option for Webinar should be set as required to use this API.
Scopes:
webinar:write:adminwebinar:write
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webinarId |
Integer | Yes |
The webinar ID in "long" format(represented as int64 data type in JSON). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
questions[] |
Array | No |
Array of registration fields whose values should be provided by registrants during registration. |
questions[].required |
Boolean | No |
State whether the selected fields are required or optional. |
questions[].field_name |
String | No |
Field name Valid values:
|
custom_questions[] |
Array | No |
Array of Registrant Custom Questions. |
custom_questions[].required |
Boolean | No |
State whether or not the custom question is required to be answered by a registrant. |
custom_questions[].answers[] |
Array | No |
An array of answer choices. Can't be used for short answer type. |
custom_questions[].title |
String | No |
Custom question. |
custom_questions[].type |
String | No |
The question-answer type. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.