PUT /webinars/{webinarId}/registrants/status
Update a webinar registrant's status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.
Scopes: webinar:write:admin webinar:write
Rate Limit Label: Medium
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_id |
String | No |
The meeting occurrence ID. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
action |
String | Yes |
Used to approve a registrant, deny a registrant, or cancel a previously approved registrant. Valid values:
|
registrants[] |
Array | No |
List of registrants. |
registrants[].id |
String | No |
Registrant ID |
registrants[].email |
String | No |
Registrant's email address. |
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.