Use this API to create and submit a user's registration for a webinar. Zoom users with a Webinar plan have access to creating and managing webinars. Webinars allow hosts 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.
Scopes: webinar:write:admin
, webinar:write
Rate Limit Label: Light
Prerequisites:
- A Pro or higher plan with the Webinar add-on.
type: object
properties:
parameters:
type: object
properties:
webinarId:
format: int64
type: integer
example: 99289110036
description: The webinar's ID.
occurrence_ids:
type: string
example: '1648538280000'
description: >-
A comma-separated list of webinar occurrence IDs. You can get this
value with the [Get a
webinar](/docs/api-reference/zoom-api/methods/#operation/webinar) API.
Make sure the `registration_type` is 3 if updating multiple
occurrences with this API.
required:
- webinarId
title: Parameters
data:
type: object
properties:
first_name:
type: string
maxLength: 64
description: The registrant's first name.
example: Jill
last_name:
type: string
maxLength: 64
description: The registrant's last name.
example: Chill
email:
type: string
format: email
maxLength: 128
description: The registrant's email address.
example:
[email protected]
address:
type: string
description: The registrant's address.
example: 1800 Amphibious Blvd.
city:
type: string
description: The registrant's city.
example: Mountain View
state:
type: string
description: The registrant's state or province.
example: CA
zip:
type: string
description: The registrant's ZIP or postal code.
example: '94045'
country:
type: string
description: >-
The registrant's two-letter [country
code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
example: US
phone:
type: string
description: The registrant's phone number.
example: '5550100'
comments:
type: string
description: The registrant's questions and comments.
example: Looking forward to the discussion.
custom_questions:
type: array
description: Information about custom questions.
items:
type: object
properties:
title:
type: string
description: The title of the custom question.
example: What do you hope to learn from this?
value:
type: string
maxLength: 128
description: >-
The custom question's response value. This has a limit of 128
characters.
example: >-
Look forward to learning how you come up with new recipes and
what other services you offer.
industry:
type: string
description: The registrant's industry.
example: Food
job_title:
type: string
description: The registrant's job title.
example: Chef
no_of_employees:
type: string
description: |-
The registrant's number of employees:
* `1-20`
* `21-50`
* `51-100`
* `101-500`
* `500-1,000`
* `1,001-5,000`
* `5,001-10,000`
* `More than 10,000`
enum:
- ''
- 1-20
- 21-50
- 51-100
- 101-500
- 500-1,000
- 1,001-5,000
- 5,001-10,000
- More than 10,000
example: 1-20
org:
type: string
description: The registrant's organization.
example: Cooking Org
purchasing_time_frame:
type: string
description: |-
The registrant's purchasing time frame:
* `Within a month`
* `1-3 months`
* `4-6 months`
* `More than 6 months`
* `No timeframe`
enum:
- ''
- Within a month
- 1-3 months
- 4-6 months
- More than 6 months
- No timeframe
example: 1-3 months
role_in_purchase_process:
type: string
description: |-
The registrant's role in the purchase process:
* `Decision Maker`
* `Evaluator/Recommender`
* `Influencer`
* `Not involved`
enum:
- ''
- Decision Maker
- Evaluator/Recommender
- Influencer
- Not involved
example: Influencer
language:
type: string
description: |-
The registrant's language preference for confirmation emails:
* `en-US` — English (US)
* `de-DE` — German (Germany)
* `es-ES` — Spanish (Spain)
* `fr-FR` — French (France)
* `jp-JP` — Japanese
* `pt-PT` — Portuguese (Portugal)
* `ru-RU` — Russian
* `zh-CN` — Chinese (PRC)
* `zh-TW` — Chinese (Taiwan)
* `ko-KO` — Korean
* `it-IT` — Italian (Italy)
* `vi-VN` — Vietnamese
* `pl-PL` — Polish
* `Tr-TR` — Turkish
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
example: en-US
source_id:
type: string
description: Unique Identifier of the tracking source.
example: '4816766181770'
title: Data
type: object
properties:
id:
type: integer
format: int64
description: The webinar's ID.
example: 92674392836
join_url:
type: string
description: The URL the registrant can use to join the webinar.
example: https://example.com/j/22222
registrant_id:
type: string
description: The registrant's ID.
example: fdgsfh2ey82fuh
start_time:
type: string
format: date-time
description: The webinar's start time.
example: '2021-07-13T21:44:51Z'
topic:
type: string
maxLength: 200
description: The webinar's topic.
example: My Webinar
occurrences:
description: Array of occurrence objects.
type: array
items:
type: object
properties:
duration:
description: Duration.
type: integer
example: 60
occurrence_id:
description: >-
Occurrence ID: Unique Identifier that identifies an occurrence of a
recurring webinar. [Recurring
webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar)
can have a maximum of 50 occurrences.
type: string
example: '1648194360000'
start_time:
description: Start time.
format: date-time
type: string
example: '2022-03-25T07:46:00Z'
status:
description: Occurrence status.
type: string
example: available