POST /webinars/{webinarId}/registrants
Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to create and submit the registration of a user for a webinar.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
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" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
occurrence_ids |
String | No |
Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
job_title |
String | No |
Registrant's job title. |
no_of_employees |
String | No |
Number of Employees: |
role_in_purchase_process |
String | No |
Role in Purchase Process: |
industry |
String | No |
Registrant's Industry. |
first_name |
String | Yes |
Registrant's first name. |
custom_questions[] |
Array | No |
Custom questions. |
custom_questions[].title |
String | No | |
custom_questions[].value |
String | No | |
state |
String | No |
Registrant's State/Province. |
city |
String | No |
Registrant's city. |
purchasing_time_frame |
String | No |
This field can be included to gauge interest of webinar attendees towards buying your product or service. Purchasing Time Frame: |
email |
String | Yes |
A valid email address of the registrant. |
last_name |
String | No |
Registrant's last name. |
zip |
String | No |
Registrant's Zip/Postal Code. |
org |
String | No |
Registrant's Organization. |
phone |
String | No |
Registrant's Phone number. |
country |
String | No |
Registrant's country. The value of this field must be in two-letter abbreviated form and must match the ID field provided in the Countries table. |
address |
String | No |
Registrant's address. |
comments |
String | No |
A field that allows registrants to provide any questions or comments that they might have. |
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.