{"openapi":"3.0.0","info":{"title":"Events","description":" The Webinars Plus & Events APIs let developers integrate [Zoom Webinars Plus & Events](https://developers.zoom.us/docs/events/) to create, manage, and customize virtual event experiences in their apps and services.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/zoom_events/events/{eventId}/attendee_action":{"get":{"tags":["Attendee Actions"],"summary":"List event attendee actions","description":"Retrieves the attendee actions performed by the host for an event.\n \n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:read`,`zoom_events_attendee_actions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_attendee_actions`,`zoom_events:read:list_attendee_actions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListEventAttendeeActions","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"email","in":"query","description":"The email of attendee.\n","required":false,"schema":{"type":"string","example":"test@example.com"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`    Attendee check-in Information.","content":{"application/json":{"schema":{"title":"Attendee checkins pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the response.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"attendees":{"maxItems":300,"type":"array","description":"The list of event attendee actions.","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the checked-in attendee.","example":"email@zoom.us"},"source":{"type":"string","description":"The source of the action. Any information that can be used for tracking the source of this action.","example":"Console-1"},"action":{"type":"string","description":"The action name.","example":"Check-in","enum":["check-in"]}},"description":"The attendee and the action performed."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_attendee_actions:read","zoom_events_attendee_actions:read:admin","zoom_events:read:list_attendee_actions","zoom_events:read:list_attendee_actions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_attendee_actions:read","zoom_events_attendee_actions:read:admin"],"x-granular-scopes":["zoom_events:read:list_attendee_actions","zoom_events:read:list_attendee_actions:admin"]}},"patch":{"tags":["Attendee Actions"],"summary":"Update event attendee actions","description":"Retrieves attendee onsite action for an event. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation. In the case of a batch operation, the API response can be a partial success.  Any errors are returned in the **errors** object.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:write`,`zoom_events_attendee_actions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:batch_attendee_actions`,`zoom_events:update:batch_attendee_actions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateEventAttendeeActions","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendees":{"maxItems":300,"type":"array","items":{"required":["action","email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"action":{"type":"string","description":"The action name.","example":"check-in","enum":["check-in"]}},"description":"The attendee and the action performed."}},"source":{"type":"string","description":"The source of the action. Any information that can be used for tracking the source of this action.","example":"console-1"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`    Attendee check-in Information.","content":{"application/json":{"schema":{"title":"Attendee checkins result","type":"object","properties":{"errors":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the failed checked-in attendee.","example":"email@zoom.us"},"message":{"type":"string","description":"Error message.","example":"User doesn't have an on-site ticket"}},"description":"The list of check-in failures."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2003` <br>\n Event Not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_attendee_actions:write","zoom_events_attendee_actions:write:admin","zoom_events:update:batch_attendee_actions","zoom_events:update:batch_attendee_actions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_attendee_actions:write","zoom_events_attendee_actions:write:admin"],"x-granular-scopes":["zoom_events:update:batch_attendee_actions","zoom_events:update:batch_attendee_actions:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/attendee_action":{"get":{"tags":["Attendee Actions"],"summary":"List session attendee actions","description":"Retrieves the attendee actions performed by the host for an event session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:read`,`zoom_events_attendee_actions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_attendee_actions`,`zoom_events:read:list_session_attendee_actions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListSessionAttendeeActions","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"email","in":"query","description":"The email of attendee.\n","required":false,"schema":{"type":"string","example":"test@example.com"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`    Attendee check-in Information.","content":{"application/json":{"schema":{"title":"Attendee checkins pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the response.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"attendees":{"maxItems":300,"type":"array","description":"The list of session attendee actions.","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the checked-in attendee.","example":"email@zoom.us"},"source":{"type":"string","description":"The source of the action. Any information that can be used for tracking the source of this action.","example":"Console-1"},"action":{"type":"string","description":"The action name.","example":"Check-in","enum":["check-in"]}},"description":"The attendee and the action performed."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request.  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_attendee_actions:read","zoom_events_attendee_actions:read:admin","zoom_events:read:list_session_attendee_actions","zoom_events:read:list_session_attendee_actions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_attendee_actions:read","zoom_events_attendee_actions:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_attendee_actions","zoom_events:read:list_session_attendee_actions:admin"]}},"patch":{"tags":["Attendee Actions"],"summary":"Update session attendee actions","description":"Performs attendee onsite action for an event session. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation. In the case of a batch operation, the API response can be a partial success.  Any errors are returned in the **errors** object.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:write`,`zoom_events_attendee_actions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:batch_session_attendee_actions`,`zoom_events:update:batch_session_attendee_actions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateSessionAttendeeActions","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendees":{"maxItems":300,"type":"array","items":{"required":["action","email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"action":{"type":"string","description":"The action name.","example":"Check-in","enum":["check-in"]}},"description":"The attendee and the action performed."}},"source":{"type":"string","description":"The source of the action. Any information that can be used for tracking the source of this action.","example":"Console-1"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`    Attendee check-in Information.","content":{"application/json":{"schema":{"title":"Attendee checkins result","type":"object","properties":{"errors":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the failed checked-in attendee.","example":"email@zoom.us"},"message":{"type":"string","description":"The error message.","example":"User doesn't have an on-site ticket."}},"description":"The list of check-in failures."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2003` <br>\n Event not found. <br>\n**Error Code:** `2005` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_attendee_actions:write","zoom_events_attendee_actions:write:admin","zoom_events:update:batch_session_attendee_actions","zoom_events:update:batch_session_attendee_actions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_attendee_actions:write","zoom_events_attendee_actions:write:admin"],"x-granular-scopes":["zoom_events:update:batch_session_attendee_actions","zoom_events:update:batch_session_attendee_actions:admin"]}}},"/zoom_events/events/{eventId}/coeditors":{"get":{"tags":["Co Editors"],"summary":"  List coeditors","description":"Retrieves the list of co-editors and their edit permissions for an event.   Co-editors can make changes to the event details. Co-editors have view permission to all sections of the event.\n\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_coeditors:read`,`zoom_events_coeditors:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_coeditors`,`zoom_events:read:list_coeditors:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getCoEditors","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of co-editors returned.","content":{"application/json":{"schema":{"title":"List of co-editors","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the response.","example":1},"coeditors":{"maxItems":3,"type":"array","description":"Co-editors","items":{"title":"Co-editor","type":"object","properties":{"email":{"type":"string","description":"The co-editor's email address.","example":"coeditor@example.com"},"permission_groups":{"maxItems":12,"type":"array","description":"Permission Groups","items":{"type":"string","description":"The permissions given for the co-editor to edit particular sections of the event: \n * `Publish` Event publish access \n * `EventConfiguration` Event Configuration page \n * `EventBranding` Event Branding page \n * `Registration & Join` Registration & Join page \n * `Venue` Event Experience page \n * `EventExperience` Event Experience page \n * `EventPlanning` Event Content page \n * `SpecialRole` Special Roles page \n * `PostEvent` Post Event page \n * `Analytics` Analytics page \n * `Email` Communications page \n * `Integrations` Integrations page","example":"EventConfiguration","enum":["Publish","EventConfiguration","EventBranding","Registration & Join","Venue","EventExperience","EventPlanning","SpecialRole","PostEvent","Analytics","Email","Integrations"]}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_coeditors:read","zoom_events_coeditors:read:admin","zoom_events:read:list_coeditors","zoom_events:read:list_coeditors:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_coeditors:read","zoom_events_coeditors:read:admin"],"x-granular-scopes":["zoom_events:read:list_coeditors","zoom_events:read:list_coeditors:admin"]}},"patch":{"tags":["Co Editors"],"summary":" Add or remove event co-editors","description":"Adds or removes event co-editor actions.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_coeditor:write`,`zoom_events_coeditor:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:coeditor`,`zoom_events:write:coeditor:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"coeditoractions","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","description":"The co-editor actions for the event\n. *`add` &mdash; add co-editor the event. \\n *`update` Update event co-editor permissions \n\n *`delete` delete co-editors from the event.","example":"add","enum":["add","update","delete"]},"coeditors":{"maxItems":3,"type":"array","description":"Co-Editor information.","items":{"title":"co-editor","type":"object","properties":{"email":{"type":"string","description":"The co-editor's email address.","example":"coeditor@example.com"},"permission_groups":{"maxItems":12,"type":"array","description":"Permission Groups.","items":{"type":"string","description":"The permissions given for the co-editor to edit particular sections of the event: \n * `Publish` Event publish access \n * `EventConfiguration` Event Configuration page \n * `EventBranding` Event Branding page \n * `Registration & Join` Registration & Join page \n * `Venue` Event Experience page \n * `EventExperience` Event Experience page \n * `EventPlanning` Event Content page \n * `SpecialRole` Special Roles page \n * `PostEvent` Post Event page \n * `Analytics` Analytics page \n * `Email` Communications page \n * `Integrations` Integrations page","example":"EventConfiguration","enum":["Publish","EventConfiguration","EventBranding","Registration & Join","Venue","EventExperience","EventPlanning","SpecialRole","PostEvent","Analytics","Email","Integrations"]}}}}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \n Updates event co-editors.","content":{"application/json":{"schema":{"title":"coeditor action result","type":"object","properties":{"errors":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the failed co-editor.","example":"email@zoom.us"},"message":{"type":"string","description":"Error message.","example":"User not elgible for co-editor."}},"description":"The list of co-editor failures."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_coeditor:write","zoom_events_coeditor:write:admin","zoom_events:write:coeditor","zoom_events:write:coeditor:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_coeditor:write","zoom_events_coeditor:write:admin"],"x-granular-scopes":["zoom_events:write:coeditor","zoom_events:write:coeditor:admin"]}}},"/zoom_events/events/{eventId}/email_types":{"get":{"tags":["Emails"],"summary":"List event email types","description":"Get the list of email types defined for an event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_email:read`,`zoom_events_email:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_email_types`,`zoom_events:read:list_email_types:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"listEmailTypes","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"status","in":"query","description":"The email delivery status. \n * `scheduled - Scheduled`  \n *  `ongoing - ongoing`  \n *  `sent - sent - done`  \n * `deactivated - this email is deactivated`","required":false,"schema":{"type":"string","example":"scheduled","enum":["scheduled","ongoing","sent","deactivated"]}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"Email types","content":{"application/json":{"schema":{"title":"List of email types","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":15},"next_page_token":{"type":"string","description":"The next page token paginates through a large set results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"email_types":{"maxItems":300,"type":"array","description":"Email types array.","items":{"title":"Email types","type":"object","properties":{"email_type":{"type":"string","description":"The email type name.","example":"Free ticket confirmation"},"email_type_id":{"type":"string","description":"The email type ID.","example":"SLar6n5ATsWSqZ_EZv_9jw"},"trigger_overview":{"type":"string","description":"The email trigger information.","example":"Sent when user is registered"},"trigger_date":{"type":"string","description":"The trigger date-time of the email.","format":"date-time","example":"2025-08-24T22:30:00Z"},"status":{"type":"string","description":"The email delivery status. \n * `scheduled - Scheduled`  \n *  `ongoing - ongoing`  \n *  `sent - sent - done`  \n * `deactivated - this email is deactivated`","example":"scheduled","enum":["scheduled","ongoing","sent","deactivated"]}},"description":"The event email types."}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_email:read","zoom_events_email:read:admin","zoom_events:read:list_email_types","zoom_events:read:list_email_types:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_email:read","zoom_events_email:read:admin"],"x-granular-scopes":["zoom_events:read:list_email_types","zoom_events:read:list_email_types:admin"]}}},"/zoom_events/events/{eventId}/email_types/{emailTypeId}/send_status":{"get":{"tags":["Emails"],"summary":"List event emails sent status","description":"Get the list of email sent status for an event email type.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_email:read`,`zoom_events_email:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_emails_status`,`zoom_events:read:list_emails_status:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"listEmailSentStatuses","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"emailTypeId","in":"path","description":"The email type ID. Get this value from the list event email types API.","required":true,"schema":{"type":"string","example":"jNqLPC6hSFiZ9NpgjA549w"}},{"name":"status","in":"query","description":"The email delivery status.\n* `scheduled` - Scheduled to send\n* `pending` - Pending or ready to send\n* `delivered` - Email sent successfully\n* `failed` - Email delivery failed\n* `missed_schedule` - Missed the original schedule date-time","required":false,"schema":{"type":"string","example":"pending","enum":["scheduled","pending","delivered","failed","missed_schedule"]}},{"name":"search_text","in":"query","description":"The search word for searching the emails.","required":false,"schema":{"type":"string","example":"John"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"Email send details.","content":{"application/json":{"schema":{"title":"List of emails","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. The next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"emails":{"maxItems":300,"type":"array","description":"Array of emails.","items":{"title":"Emails","type":"object","properties":{"name":{"type":"string","description":"The recipient name.","example":"John Doe"},"email":{"type":"string","description":"The email address of the recipient.","example":"john.doe@test.com"},"status":{"type":"string","description":"The email delivery status.\n* `scheduled` - Scheduled to send\n* `pending` - Pending or ready to send\n* `delivered` - Email sent successfully\n* `failed` - Email delivery failed\n* `missed_schedule` - Missed the original schedule date-time","example":"delivered","enum":["scheduled","pending","delivered","failed","missed_schedule"]},"failure_reason":{"type":"string","description":"The email failure reason.\n* `bounced` - The email was bounced\n* `system_error` - Network error - Please try sending again\n* `blocked` - This email was blocked and hence not sent\n* `rate_limited` - Daily email limit met\n* `unsubscribed` - This email was unsubscribed from email communications","example":"bounced","enum":["bounced","system_error","blocked","rate_limited","unsubscribed"]},"sent_date":{"type":"string","description":"The actual sent date-time of the email.","format":"date-time","example":"2025-08-24T22:30:00Z"}},"description":"The event email delivery status."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_email:read","zoom_events_email:read:admin","zoom_events:read:list_emails_status","zoom_events:read:list_emails_status:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_email:read","zoom_events_email:read:admin"],"x-granular-scopes":["zoom_events:read:list_emails_status","zoom_events:read:list_emails_status:admin"]}}},"/zoom_events/events/{eventId}/access_links":{"get":{"tags":["Event Access"],"summary":"List event access links","description":"Retrieves a list of all the event's access links associated with the event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:read:admin`,`zoom_events_access_links:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_access_links`,`zoom_events:read:list_access_links:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEventAccessLinks","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of events access links.","content":{"application/json":{"schema":{"title":"Event's Access","type":"object","properties":{"access_links":{"maxItems":300,"type":"array","description":"The list of event's access links.","items":{"title":"Access Link information","type":"object","properties":{"access_link_id":{"type":"string","description":"The event access link ID.","example":"234kjhg23kl4jhlaksjdh3"},"name":{"type":"string","description":"The name of the access link.","example":"Event Access Link 1"},"type":{"type":"string","description":"The type of access link of the event. \n * `registration` - Attendees will be required to authenticate with the email that was used at registration when joining. \n * `group-join` - The attendee group specified by the chosen authentication will join without registration.","example":"registration","enum":["registration","group-join"]},"is_default":{"type":"boolean","description":"The default link ensures compatibility with the event links that are used throughout the attendee experience. These existing event links will operate as a registration link or group join link based upon the default setting.. It will be set to false by default.","example":true},"url":{"type":"string","description":"The event access link.","example":"https://gobranding.zipow.com/ev/Ar7HuZc3rtKwaVqLz0QdBYN-2jTOMeGGgLe-G7JzOUQZTIBOpBaH~Aq9NeHNgGwwg2eyFH7eEtP4bXRXiiYCM8pDiTuTbrigbqJ1uK2K6Ga-Ghg"},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Sign in with Zoom account or with an email OTP  * `corporate_idp` Sign in to external Single Sign-On (SSO)  * `bypass_auth` Bypass authentication * `accelerated_auth` Authentication through vanity url","example":"bypass_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","bypass_auth","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account.","example":"okta"},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The registration restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@email.com"}},"security_at_join":{"type":"object","properties":{"email_authentication":{"type":"boolean","description":"Attendees will be required to authenticate with the email that was used at registration when joining.","example":true},"security_code_verification":{"type":"boolean","description":"Require additional authentication through a security code.","example":true}},"description":"The security at join."},"ticket_type_id":{"type":"string","description":"Ticket Type ID. This establishes the access permissions of the user within the event.","example":"234kjhg23kl4jhlaksjdh3"},"recurring_registration_option":{"type":"string","description":"The recurring event registration type. This is applicable only for recurring events. \n * `all_sessions` One registration for all the sessions. \n * `single_session` Registration only for one session at a time. \n * `multiple_sessions` Registration allowed one or more sessions. ","example":"all_sessions","enum":["all_sessions","single_session","multiple_sessions"]}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n  Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_access_links:read:admin","zoom_events_access_links:read","zoom_events:read:list_access_links","zoom_events:read:list_access_links:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_access_links:read:admin","zoom_events_access_links:read"],"x-granular-scopes":["zoom_events:read:list_access_links","zoom_events:read:list_access_links:admin"]}},"post":{"tags":["Event Access"],"summary":"Create event access link","description":"Creates an access link for an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:access_links`,`zoom_events:write:access_links:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createEventAccessLink","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Access","required":["authentication_method","name","type"],"type":"object","properties":{"name":{"type":"string","description":"The access link's name.","example":"Event Access Link 1"},"type":{"type":"string","description":"The type of access link of the event.\n * `registration` - Attendees will be required to authenticate with the email that was used at registration when joining.\n * `group-join` - The attendee group specified by the chosen authentication will join without registration.","example":"registration","enum":["registration","group-join"]},"is_default":{"type":"boolean","description":"The default link ensures compatibility with the event links that are used throughout the attendee experience. These existing event links will operate as a registration link or group join link based upon the default setting. It will be set to false by default. Only one link is set to default, at any time.","example":false},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type.\n * `zoom_account` - Zoom account holder.\n * `zoom_account_otp` - Sign in with Zoom account or with an email OTP.\n * `corporate_idp` - Sign in to external single sign-on (SSO). Configure the Zoom account with a valid one SSO configuration. Accounts with multiple identity providers (IDP) are not supported using the API.\n * `bypass_auth` - Bypass authentication.\n * `accelerated_auth` - Authentication through vanity URL.","example":"bypass_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","bypass_auth","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account. If the authentication type is corporate IDP and Zoom Accounts configured with more than one IDP provider this field is required.","example":"okta"},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The registration restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@email.com"}},"security_at_join":{"type":"object","properties":{"email_authentication":{"type":"boolean","description":"This field applies only to registration link type. Attendees will be required to authenticate with the email that was used at registration when joining.","example":true},"security_code_verification":{"type":"boolean","description":"Require additional authentication through a security code.","example":true}},"description":"Security at the time of joining."},"ticket_type_id":{"type":"string","description":"The ticket type ID. This field applies only to group-join link type. This establishes the access permissions of the user within the event.","example":"PTYwAknYQXaDStOP7O3ExA"},"recurring_registration_option":{"type":"string","description":"The recurring event registration type. This is applicable only for recurring events.\n * `all_sessions` - One registration for all the sessions.\n * `single_session` - Registration only for one session at a time.\n * `multiple_sessions` - Registration allowed one or more sessions.","example":"all_sessions","enum":["all_sessions","single_session","multiple_sessions"]}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` <br>\n Event access link created successfully.\n\n ","content":{"application/json":{"schema":{"title":"Event Access Link","type":"object","properties":{"access_link_id":{"type":"string","description":"The event access link ID.","example":"234kjhg23kl4jhlaksjdh3"},"name":{"type":"string","description":"The name of the access link.","example":"Event Access Link 1"},"type":{"type":"string","description":"The type of access link of the event.\n * `registration` - Attendees will be required to authenticate with the email that was used at registration when joining.\n * `group-join` - The attendee group specified by the chosen authentication will join without registration.","example":"registration","enum":["registration","group-join"]},"is_default":{"type":"boolean","description":"The default link ensures compatibility with the event links that are used throughout the attendee experience. These existing event links will operate as a registration link or group join link based upon the default setting. It will be set to false by default.","example":true},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type.\n * `zoom_account` - Zoom account holder.\n * `zoom_account_otp` - Sign in with Zoom account or with an email OTP.\n * `corporate_idp` - Sign in to external single sign-on (SSO).\n * `bypass_auth` - Bypass authentication.\n * `accelerated_auth` - Authentication through vanity URL.","example":"bypass_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","bypass_auth","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account. If the authentication type is corporate IDP and Zoom Accounts configured with more than one IDP provider this field is required.","example":"okta"},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The registration restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@example.com"}},"security_at_join":{"type":"object","properties":{"email_authentication":{"type":"boolean","description":"This field applies only to registration link type. Attendees will be required to authenticate with the email that was used at registration when joining.","example":true},"security_code_verification":{"type":"boolean","description":"Require additional authentication through a security code.","example":true}},"description":"Security at the time of joining."},"ticket_type_id":{"type":"string","description":"The ticket type ID. This field applies only to group-join link type. This establishes the access permissions of the user within the event.","example":"PTYwAknYQXaDStOP7O3ExA"},"recurring_registration_option":{"type":"string","description":"The recurring event registration type. This is applicable only for recurring events.\n * `all_sessions` - One registration for all the sessions.\n * `single_session` - Registration only for one session at a time.\n * `multiple_sessions` - Registration allowed one or more sessions.","example":"all_sessions","enum":["all_sessions","single_session","multiple_sessions"]}},"description":"Information about the event access link."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n **Error Code:** `261202` <br>\n The ticket type could not be found. <br>\n**Error Code:** `261203` <br>\n Please ensure that each join link has a unique name.\n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden\n\n **Error Code:** `260200` <br>\n Event access denied.\n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found\n\n **Error Code:** `2002` <br>\n Event not found.\n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).\n\n "}},"security":[{"openapi_oauth":["zoom_events_access_links:write","zoom_events_access_links:write:admin","zoom_events:write:access_links","zoom_events:write:access_links:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_access_links:write","zoom_events_access_links:write:admin"],"x-granular-scopes":["zoom_events:write:access_links","zoom_events:write:access_links:admin"]}}},"/zoom_events/events/{eventId}/access_links/{accessLinkId}":{"get":{"tags":["Event Access"],"summary":"Get event access link","description":"Retrieves event access link information.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:read`,`zoom_events_access_links:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:access_links`,`zoom_events:read:access_links:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetEventAccessLink","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"accessLinkId","in":"path","description":"The event access link ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Requested session details.","content":{"application/json":{"schema":{"title":"Event access link","type":"object","properties":{"access_link_id":{"type":"string","description":"The event access link ID.","example":"234kjhg23kl4jhlaksjdh3"},"name":{"type":"string","description":"The name of the access link.","example":"Event Access Link 1"},"type":{"type":"string","description":"The type of access link of the event. \n *`registration` - Attendees will be required to authenticate with the email that was used at registration when joining. \n *`group-join` - The attendee group specified by the chosen authentication will join without registration.","example":"registration","enum":["registration","group-join"]},"is_default":{"type":"boolean","description":"The default link ensures compatibility with the event links that are used throughout the attendee experience. These existing event links will operate as a registration link or group join link based upon the default setting. It will be set to false by default.","example":true},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type. \n * `zoom_account` - Zoom account holder.  * `zoom_account_otp` - Sign in with Zoom account or with an email OTP.  * `corporate_idp` - Sign in to external single sign-on (SSO).  * `bypass_auth` - Bypass authentication. * `accelerated_auth` - Authentication through vanity URL.","example":"bypass_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","bypass_auth","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account.","example":"okta"},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The registration restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@example.com"}},"security_at_join":{"type":"object","properties":{"email_authentication":{"type":"boolean","description":"This field applies only to registration link type. Attendees will be required to authenticate with the email that was used at registration when joining.","example":true},"security_code_verification":{"type":"boolean","description":"Require additional authentication through a security code.","example":true}},"description":"Security at the time of joining."},"ticket_type_id":{"type":"string","description":"The ticket type ID. This field applies only to group-join link type. This establishes the access permissions of the user within the event.","example":"PTYwAknYQXaDStOP7O3ExA"},"recurring_registration_option":{"type":"string","description":"The recurring event registration type. This is applicable only for recurring events. \n * `all_sessions` One registration for all the sessions. \n * `single_session` Registration only for one session at a time. \n * `multiple_sessions` Registration allowed one or more sessions. ","example":"all_sessions","enum":["all_sessions","single_session","multiple_sessions"]}},"description":"The information about the event access link."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `261201` <br>\n Event access link not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_access_links:read","zoom_events_access_links:read:admin","zoom_events:read:access_links","zoom_events:read:access_links:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_access_links:read","zoom_events_access_links:read:admin"],"x-granular-scopes":["zoom_events:read:access_links","zoom_events:read:access_links:admin"]}},"delete":{"tags":["Event Access"],"summary":"Delete event access link","description":"Deletes an event access link.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:access_links`,`zoom_events:delete:access_links:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteEventAccessLink","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"accessLinkId","in":"path","description":"The event access link ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`   Event access deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `261201` <br>\n Event access link not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_access_links:write","zoom_events_access_links:write:admin","zoom_events:delete:access_links","zoom_events:delete:access_links:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_access_links:write","zoom_events_access_links:write:admin"],"x-granular-scopes":["zoom_events:delete:access_links","zoom_events:delete:access_links:admin"]}},"patch":{"tags":["Event Access"],"summary":"Update event access","description":"Updates the event access for an event ID.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:access_links`,`zoom_events:update:access_links:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateEventAccess","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"accessLinkId","in":"path","description":"The event access link ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Access information","type":"object","properties":{"name":{"type":"string","description":"The name of the access link.","example":"Event Access Link 1"},"is_default":{"type":"boolean","description":"The default link ensures compatibility with the event links that are used throughout the attendee experience. These existing event links will operate as a registration link or group join link based upon the default setting. It will be set to false by default. Only one link is set to default, at any time. On;y `true` is considered for update.","example":true},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type. \n * `zoom_account` - Zoom account holder. \n * `zoom_account_otp` - Sign in with Zoom account or with an email OTP. \n * `corporate_idp` - Sign in to external single sign-on (SSO). Configure the Zoom account with a valid one SSO configuration. Accounts with multiple identity providers (IDP) are not supported using the API. \n * `bypass_auth` - Bypass authentication. \n * `accelerated_auth` - Authentication through vanity URL.","example":"bypass_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","bypass_auth","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account. If the authentication type is corporate IDP and Zoom Accounts configured with more than one IDP provider this field is required.","example":"okta"},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The registration restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@email.com"}},"security_at_join":{"type":"object","properties":{"email_authentication":{"type":"boolean","description":"This field applies only to registration link type. Attendees will be required to authenticate with the email that was used at registration when joining.","example":true},"security_code_verification":{"type":"boolean","description":"This field requires additional authentication through a security code.","example":true}},"description":"The security at the time of joining."},"ticket_type_id":{"type":"string","description":"The ticket type ID. This field applies only to group-join link type. This establishes the access permissions of the user within the event.","example":"PTYwAknYQXaDStOP7O3ExA"},"recurring_registration_option":{"type":"string","description":"The recurring event registration type. This is applicable only for recurring events. \n * `all_sessions` One registration for all the sessions. \n * `single_session` Registration only for one session at a time. \n * `multiple_sessions` Registration allowed one or more sessions. ","example":"all_sessions","enum":["all_sessions","single_session","multiple_sessions"]}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \n Event access link updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `261202` <br>\n The ticket type could not be found. <br>\n**Error Code:** `261203` <br>\n Please ensure that each join link has a unique name.. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `261201` <br>\n Event access link not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_access_links:write","zoom_events_access_links:write:admin","zoom_events:update:access_links","zoom_events:update:access_links:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_access_links:write","zoom_events_access_links:write:admin"],"x-granular-scopes":["zoom_events:update:access_links","zoom_events:update:access_links:admin"]}}},"/zoom_events/events":{"get":{"tags":["Events"],"summary":"List events","description":"Retrieves all events associated with the user.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:read`,`zoom_events_basic:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_events`,`zoom_events:read:list_events:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEvents","parameters":[{"name":"role_type","in":"query","description":"The user role type:\n*`Host` - All hosted events.\n*`Attendee` - All non-hosted ticketed events.","required":false,"schema":{"type":"string","example":"host","default":"attendee","enum":["host","attendee"]}},{"name":"event_status_type","in":"query","description":"The type of event status:\n* `Upcoming` - All upcoming events.\n* `Past` - All past events.\n* `Draft` - All events marked as draft.\n* `Cancelled` - All cancelled events.\n\nFor the `ATTENDEE` role type, only `upcoming` and `past` are valid status types. As a `HOST`, all status types are valid.","required":false,"schema":{"type":"string","example":"upcoming","default":"upcoming","enum":["upcoming","past","draft","cancelled"]}},{"name":"hub_id","in":"query","description":"Filter data by event hub ID.","required":false,"schema":{"type":"string","example":"23asdfasdf3asdf"}},{"name":"from","in":"query","description":"Filter data records modified on or after the specified date. If the `to` parameter is not provided, all events created within 3 years from this date will be returned.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-24T22:30:00Z"}},{"name":"to","in":"query","description":"Filter data records modified on or before the specified date. If the `from` parameter is not provided, all events created within 3 years before this date will be returned.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-09-24T22:30:00Z"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. The maximum is 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token is used to paginate through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nList of requested events.","content":{"application/json":{"schema":{"title":"Events pagination","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a large set results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"events":{"maxItems":300,"type":"array","items":{"title":"Event information","type":"object","properties":{"event_id":{"type":"string","description":"The ID of the event.","example":"234kj2h34kljgh23lkhj3"},"name":{"type":"string","description":"The name of the event.","example":"OpenAPI Conference Name"},"description":{"type":"string","description":"The description of the event.","example":"This event was created with the OpenAPI"},"timezone":{"type":"string","description":"The timezone of the event.","example":"America/Indianapolis"},"event_type":{"type":"string","description":"The event types as enum:\n * `CONFERENCE` - Multi session event\n * `SIMPLE_EVENT` - Single session event\n * `RECURRING` - Recurring session event","example":"CONFERENCE"},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring session: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The session's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week on which the recurring weekly session occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"},"monthly_days":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly session is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring session will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring session's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring session occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","enum":[-1,1,2,3,4]},"duration":{"type":"integer","description":"Session duration in minutes."}},"description":"Information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"access_level":{"type":"string","description":" The type of [access level](https://support.zoom.us/hc/en-us/articles/13471207223437-Managing-the-Event-Access-tab): * `PUBLIC` - Public events\n* `PRIVATE_UNRESTRICTED` - Private and unrestricted.\n* `PRIVATE_RESTRICTED` - Private and restricted.\n","example":"PRIVATE_RESTRICTED"},"meeting_type":{"type":"string","description":"The type of meeting (for single session and recurring session events): * `MEETING` - Meeting\n * `WEBINAR` - Webinar.","example":"MEETING"},"categories":{"maxItems":20,"type":"array","description":"The category of the event.\n\n**Example:**\n* Education and Family.\n* Business and Networking.\n* Entertainment and Visual Arts.\n* Food and Drinks.\n","items":{"type":"string","example":"Food and Drinks"}},"tags":{"maxItems":200,"type":"array","description":"The tags for the event.","items":{"type":"string","example":"Event tag1"}},"calendar":{"maxItems":6,"type":"array","description":"The start and end time of the calendar invitations in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","items":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","example":"2022-06-03T20:51:00Z"},"end_time":{"type":"string","format":"date-time","example":"2022-06-03T20:51:00Z"}}}},"status":{"type":"string","description":"The event status: \nOptions:\n * `PUBLISHED` - Published event\n * `DRAFT` - Draft event","example":"PUBLISHED"},"hub_id":{"type":"string","description":"The ID of the event hub.","example":"23asdfasdf3asdf"},"start_time":{"type":"string","description":"The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2022-06-03T20:51:00Z"},"end_time":{"type":"string","description":"The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2022-06-03T20:51:00Z"},"contact_name":{"type":"string","description":"The contact person's name for the event.","example":"user contact name"},"contact_email":{"type":"string","description":"The contact person's email address for the event.","example":"user@zoom.us"},"lobby_start_time":{"type":"string","description":"The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2022-06-03T20:51:00Z"},"lobby_end_time":{"type":"string","description":"The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2022-06-03T20:51:00Z"},"event_url":{"type":"string","description":"The defaul event access link.","example":"www.example.com/zoomEvents"},"blocked_countries":{"maxItems":200,"type":"array","items":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).","example":"US"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees","example":"hybrid","enum":["virtual","in-person","hybrid"]},"tagline":{"type":"string","description":"This field displays under the event detail page image.","example":"Unlocking Innovation: Join Us for the Day of Insipiration and Insight!"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:read","zoom_events_basic:read:admin","zoom_events:read:list_events","zoom_events:read:list_events:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:read","zoom_events_basic:read:admin"],"x-granular-scopes":["zoom_events:read:list_events","zoom_events:read:list_events:admin"]}},"post":{"tags":["Events"],"summary":"Create an event","description":"Creates an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:event`,`zoom_events:write:event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createEvent","requestBody":{"content":{"application/json":{"schema":{"title":"Event information","required":["access_level","attendance_type","description","event_type","hub_id","name","timezone"],"type":"object","properties":{"name":{"type":"string","description":"The name of the event.","example":"OpenAPI Conference Name"},"description":{"type":"string","description":"The description of the event.","example":"This event was created with the OpenAPI."},"timezone":{"type":"string","description":"The timezone of the event.   For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).","example":"America/Indianapolis"},"event_type":{"type":"string","description":"The event types as enum:\n *`CONFERENCE` - Multi session events.\n *`SIMPLE_EVENT` - Single session event.\n *`RECURRING` - Recurring sessions event.\n","example":"CONFERENCE","enum":["SIMPLE_EVENT","CONFERENCE","RECURRING"]},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring session: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","example":1,"enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The session's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months.","example":1},"weekly_days":{"maxItems":7,"type":"array","items":{"type":"integer","description":"A list of the days of the week on which the recurring weekly session occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","example":1,"enum":[1,2,3,4,5,6,7]}},"monthly_days":{"maxItems":31,"type":"array","items":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31.","example":1}},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly session is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","example":1,"enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring session will occur before it is canceled.","example":7},"end_date_time":{"type":"string","description":"The recurring session's final ending date and time before it is canceled, in UTC format.","format":"date-time","example":"2022-04-02T15:59:00Z"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring session occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","example":1,"enum":[-1,1,2,3,4]},"duration":{"type":"integer","description":"Session duration in minutes.","example":15}},"description":"Information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"access_level":{"type":"string","description":" *`PRIVATE_UNRESTRICTED` - Private and unrestricted.\n *`PRIVATE_RESTRICTED` - Private and restricted.\n","example":"PRIVATE_RESTRICTED"},"meeting_type":{"type":"string","description":"This value is required only for a single session event. \n *`MEETING` - Meeting.\n *`WEBINAR` - Webinar. \n","example":"MEETING"},"categories":{"maxItems":20,"type":"array","description":"The category of the event.\n* Education & Family.\n* Business & Networking.\n* Entertainment & Visual Arts.\n* Food & Drinks. \n* Fitness & Health. \n* Home & Lifestyle \n* Community & Spirituality. \n* Other","items":{"type":"string","example":"Food & Drink"},"enum":["Education & Family","Business & Networking","Entertainment & Visual Arts","Food & Drink","Fitness & Health","Home & Lifestyle","Community & Spirituality","Other"]},"tags":{"maxItems":200,"type":"array","description":"The tags for the event.","items":{"type":"string","example":"Event tag1"}},"calendar":{"maxItems":6,"type":"array","description":"The start and end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","items":{"required":["end_time","start_time"],"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the event in UTC.","format":"date-time","example":"2024-07-28T13:00:00Z"},"end_time":{"type":"string","description":"The start time of the event in UTC.","format":"date-time","example":"2024-07-30T13:00:00Z"}},"description":"Event's start and end time."}},"hub_id":{"type":"string","description":"The ID of the event hub.","example":"23asdfasdf3asdf"},"start_time":{"type":"string","description":"The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is read only field.","format":"date-time","example":"2022-06-03T20:51:00Z","deprecated":true},"end_time":{"type":"string","description":"The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is a read only field.","format":"date-time","example":"2022-06-03T20:51:00Z","deprecated":true},"contact_name":{"type":"string","description":"The contact person's name for the event.","example":"user contact name"},"lobby_start_time":{"type":"string","description":"The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"lobby_end_time":{"type":"string","description":"The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"blocked_countries":{"maxItems":200,"type":"array","description":"Attendees from the countries listed here will not be allowed to register to the event.","items":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).","example":"US"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `VIRTUAL` - virtual attendees only. \n * `IN-PERSON` - in-person attendees only.\n * `HYBRID` - both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001","deprecated":true},"tagline":{"type":"string","description":"This field displays under the event detail page image.","example":"Unlocking Innovation: Join Us for the Day of Insipiration and Insight!"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nSuccessfully created an event.","content":{"application/json":{"schema":{"title":"Event information","type":"object","properties":{"event_id":{"type":"string","description":"The ID of the event.","example":"234kj2h34kljgh23lkhj3"},"name":{"type":"string","description":"The name of the event.","example":"OpenAPI Conference Name"},"description":{"type":"string","description":"The description of the event.","example":"This event was created with the OpenAPI"},"timezone":{"type":"string","description":"The timezone of the event.","example":"America/Indianapolis"},"event_type":{"type":"string","description":"The event types as enum:\n *`CONFERENCE` - Multi session event.\n *`SIMPLE_EVENT` - Single session event.\n","example":"CONFERENCE"},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring session: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The session's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months."},"weekly_days":{"maxItems":7,"type":"array","items":{"type":"integer","description":"A list of the days of the week on which the recurring weekly session occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","example":1,"enum":[1,2,3,4,5,6,7]}},"monthly_days":{"maxItems":31,"type":"array","items":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31.","example":1}},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly session is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring session will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring session's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring session occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","enum":[-1,1,2,3,4]},"duration":{"type":"integer","description":"Session duration in minutes."}},"description":"Information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"access_level":{"type":"string","description":"* `PRIVATE_UNRESTRICTED` - Private and unrestricted.\n* `PRIVATE_RESTRICTED` - Private and restricted.\n","example":"PRIVATE_RESTRICTED"},"meeting_type":{"type":"string","description":"*This value is required only for single session Event `MEETING` - Meeting.\n* `WEBINAR` - Webinar. \n","example":"MEETING"},"categories":{"maxItems":20,"type":"array","description":"The category of the event.\n\n**Example:**\n* Education and Family.\n* Business and Networking.\n* Entertainment and Visual Arts.\n* Food and Drinks.\n","items":{"type":"string","example":"Food and Drinks"}},"tags":{"maxItems":200,"type":"array","description":"The tags for the event.","items":{"type":"string","example":"Event tag1"}},"calendar":{"maxItems":6,"type":"array","description":"The start and end time of the calendar invitations in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","items":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","example":"2024-07-28T13:00:00Z"},"end_time":{"type":"string","format":"date-time","example":"2024-07-30T13:00:00Z"}}}},"status":{"type":"string","description":"The event status options:\n * `PUBLISHED` - Published event.\n * `DRAFT` - Draft event.","example":"PUBLISHED"},"hub_id":{"type":"string","description":"The ID of the event hub.","example":"23asdfasdf3asdf"},"start_time":{"type":"string","description":"The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"end_time":{"type":"string","description":"The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"contact_name":{"type":"string","description":"The contact person's name for the event.","example":"user contact name"},"lobby_start_time":{"type":"string","description":"The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"lobby_end_time":{"type":"string","description":"The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"event_url":{"type":"string","description":"The default event access link.","example":"www.example.com/zoomEvents"},"blocked_countries":{"maxItems":200,"type":"array","items":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).","example":"US"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n *`VIRTUAL` - virtual attendees only. \n *`IN-PERSON` - in-person attendees only. \n *`HYBRID` - both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001","deprecated":true},"tagline":{"type":"string","description":"This field displays under the event detail page image.","example":"Unlocking Innovation: Join Us for the Day of Insipiration and Insight!"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26202` <br>\n Event schedule cannot be more than 6 days. <br>\n**Error Code:** `26203` <br>\n Event end_time must be after event start_time. <br>\n**Error Code:** `26204` <br>\n Calender must contains start_time and end_time. <br>\n**Error Code:** `260207` <br>\n Hub is not supported for conference type events. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `26201` <br>\n No permission to create the event under the hub ID. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:write","zoom_events_basic:write:admin","zoom_events:write:event","zoom_events:write:event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:write","zoom_events_basic:write:admin"],"x-granular-scopes":["zoom_events:write:event","zoom_events:write:event:admin"]}}},"/zoom_events/events/{eventId}":{"get":{"tags":["Events"],"summary":"Get an event","description":"Returns information on a specified event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:read`,`zoom_events_basic:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event`,`zoom_events:read:event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEventInfo","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nEvent returned.","content":{"application/json":{"schema":{"title":"Event information","type":"object","properties":{"event_id":{"type":"string","description":"The ID of the event.","example":"234kj2h34kljgh23lkhj3"},"name":{"type":"string","description":"The name of the event.","example":"OpenAPI Conference Name"},"description":{"type":"string","description":"The description of the event.","example":"This event was created with the OpenAPI."},"timezone":{"type":"string","description":"The timezone of the event.","example":"America/Indianapolis"},"event_type":{"type":"string","description":"The event types as enum:\n * `CONFERENCE` - Multi session event.\n * `SIMPLE_EVENT` - Single session event. \n * `RECURRING` - Recurring session event.","example":"CONFERENCE"},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring session: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The session's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week on which the recurring weekly session occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"},"monthly_days":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly session is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring session will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring session's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring session occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","enum":[-1,1,2,3,4]},"duration":{"type":"integer","description":"Session duration in minutes."}},"description":"Information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"access_level":{"type":"string","description":"The type of [access level](https://support.zoom.us/hc/en-us/articles/13471207223437-Managing-the-Event-Access-tab):\n* `PUBLIC` - Public events.\n* `PRIVATE_UNRESTRICTED` - Private and unrestricted.\n* `PRIVATE_RESTRICTED` - Private and restricted.\n","example":"PRIVATE_RESTRICTED"},"meeting_type":{"type":"string","description":" The type of meeting (for single session and recurring session events):\n * `MEETING` - Meeting.\n * `WEBINAR` - Webinar.","example":"MEETING"},"categories":{"maxItems":20,"type":"array","description":"The category of the event.\n\n**Example:**\n* Education and Family.\n* Business and Networking.\n* Entertainment and Visual Arts.\n* Food and Drinks.\n","items":{"type":"string","example":"Food and Drinks"}},"tags":{"maxItems":200,"type":"array","description":"The tags for the event.","items":{"type":"string","example":"Event tag1"}},"calendar":{"maxItems":6,"type":"array","description":"The start and end time of the calendar invitations in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","items":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","example":"2022-06-03T20:51:00Z"},"end_time":{"type":"string","format":"date-time","example":"2022-06-03T20:51:00Z"}}}},"status":{"type":"string","description":"The event status options:\n * `PUBLISHED` - Published event.\n * `DRAFT` - Draft event.","example":"PUBLISHED"},"hub_id":{"type":"string","description":"The ID of the event hub.","example":"23asdfasdf3asdf"},"host_id":{"type":"string","description":"The event host(creator)'s user ID.","example":"XMgGb1i6Qlah8mn3e5GYMX"},"start_time":{"type":"string","description":"The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"end_time":{"type":"string","description":"The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"contact_name":{"type":"string","description":"The contact person's name for the event.","example":"user contact name"},"contact_email":{"type":"string","description":"The contact person's email address for the event.","example":"user@zoom.us"},"lobby_start_time":{"type":"string","description":"The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"lobby_end_time":{"type":"string","description":"The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"event_url":{"type":"string","description":"The default event access link.","example":"www.example.com/zoomEvents"},"blocked_countries":{"maxItems":200,"type":"array","items":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).","example":"US"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `VIRTUAL` - virtual attendees only. \n * `IN-PERSON` - in-person attendees only. \n * `HYBRID` - both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001","deprecated":true},"venue":{"type":"object","properties":{"name":{"type":"string","description":"The name of the venue.","example":"Washington Convention Center"},"street_address":{"type":"string","description":"The street address of the venue.","example":"801 Allen Y. Lew Place NW"},"city":{"type":"string","description":"The city of the venue.","example":"Ashburn"},"postal_code":{"type":"string","description":"The ZIP code or postal code of the venue.","example":"23112"},"state":{"type":"string","description":"The state, province, or region where the venue is located.","example":"VA"},"country":{"type":"string","description":"The two-digit country code of the venue. For supported values, see the [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries) list.","example":"US"}},"description":"The event location. This is used instead of the `physical_location` field for all new events."},"tagline":{"type":"string","description":"This field displays under the event detail page image.","example":"Unlocking Innovation: Join Us for the Day of Insipiration and Insight!"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:read","zoom_events_basic:read:admin","zoom_events:read:event","zoom_events:read:event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:read","zoom_events_basic:read:admin"],"x-granular-scopes":["zoom_events:read:event","zoom_events:read:event:admin"]}},"delete":{"tags":["Events"],"summary":"Delete an event","description":"Delete a draft event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:event`,`zoom_events:delete:event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteEvent","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nEvent deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:write","zoom_events_basic:write:admin","zoom_events:delete:event","zoom_events:delete:event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:write","zoom_events_basic:write:admin"],"x-granular-scopes":["zoom_events:delete:event","zoom_events:delete:event:admin"]}},"patch":{"tags":["Events"],"summary":"Update an event","description":"Updates an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:event`,`zoom_events:update:event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateEvent","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event information","type":"object","properties":{"name":{"type":"string","description":"The name of the event.","example":"OpenAPI Conference Name"},"description":{"type":"string","description":"The description of the event.","example":"This event was created with the OpenAPI"},"timezone":{"type":"string","description":"The timezone of the event.  \n For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).","example":"America/Indianapolis"},"event_type":{"type":"string","description":"The event types as enum:\n * `CONFERENCE` &mdash; Multi session events.\n * `SIMPLE_EVENT` &mdash; Single session event.\n * `RECURRING` &mdash; Recurring Sessions event.\n","example":"CONFERENCE","enum":["SIMPLE_EVENT","CONFERENCE","RECURRING"]},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring session: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","example":3,"enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The session's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months.","example":2},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week on which the recurring weekly session occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","example":"2"},"monthly_days":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31.","example":3},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly session is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring session will occur before it is canceled.","example":3},"end_date_time":{"type":"string","description":"The recurring session's final ending date and time before it is canceled, in UTC format.","format":"date-time","example":"2022-06-03T20:51:00Z"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring session occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","example":3,"enum":[-1,1,2,3,4]},"duration":{"type":"integer","description":"Session duration in minutes.","example":30}},"description":"The information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"access_level":{"type":"string","description":"The type of access level:\n* `PRIVATE_UNRESTRICTED` &mdash; Private and unrestricted.\n* `PRIVATE_RESTRICTED` &mdash; Private and restricted.\n","example":"PRIVATE_RESTRICTED"},"meeting_type":{"type":"string","description":"*This value is required only for single session event: `MEETING`.\n* `WEBINAR` - Webinar. \n  Use session API to update the meeting type.","example":"MEETING","deprecated":true},"categories":{"maxItems":20,"type":"array","description":"The category of the event.\n\n**Example:**\n* Education and Family.\n* Business and Networking.\n* Entertainment and Visual Arts.\n* Food and Drinks.\n","items":{"type":"string","example":"Food and Drinks"}},"tags":{"maxItems":200,"type":"array","description":"The tags for the event.","items":{"type":"string","example":"Event tag1"}},"calendar":{"maxItems":6,"type":"array","description":"The start and end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","items":{"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the event in UTC.","format":"date-time","example":"2022-06-28T20:00:00Z"},"end_time":{"type":"string","description":"The start time of the event in UTC.","format":"date-time","example":"2022-06-30T20:00:00Z"}}}},"hub_id":{"type":"string","description":"The ID of the Event Hub.","example":"23asdfasdf3asdf"},"start_time":{"type":"string","description":"The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is a read only field.","format":"date-time","example":"2022-06-03T20:51:00Z","deprecated":true},"end_time":{"type":"string","description":"The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is a read only field.","format":"date-time","example":"2022-06-03T20:51:00Z","deprecated":true},"contact_name":{"type":"string","description":"The contact name for the event.","example":"user contact name"},"lobby_start_time":{"type":"string","description":"The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"lobby_end_time":{"type":"string","description":"The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-06-03T20:51:00Z"},"blocked_countries":{"maxItems":200,"type":"array","items":{"type":"string","description":"The blocked countries for the event. [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).","example":"US"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event:\n * `VIRTUAL` &mdash; virtual attendees only. \n * `IN-PERSON` &mdash; in-person attendees only. \n * `HYBRID` &mdash; both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001","deprecated":true},"tagline":{"type":"string","description":"This field displays under the event detail page image.","example":"Unlocking Innovation: Join Us for the Day of Insipiration and Insight!"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nEvent updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n **Error Code:** `260210` <br>\n Past and cancelled events not editable. <br>\n**Error Code:** `260210` <br>\n Past and cancelled events not editable. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:write","zoom_events_basic:write:admin","zoom_events:update:event","zoom_events:update:event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:write","zoom_events_basic:write:admin"],"x-granular-scopes":["zoom_events:update:event","zoom_events:update:event:admin"]}}},"/zoom_events/events/{eventId}/event_actions":{"post":{"tags":["Events"],"summary":"Event actions","description":"Updates the event actions that the host performs for an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:event`,`zoom_events:write:event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"EventActions","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","description":"The host actions for the event. \n* `Publish` &mdash; Publish the event.\n* `Duplicate` &mdash; Duplicate existing event.\n* `Cancel` &mdash; Cancel the published  event.","example":"publish","enum":["publish","duplicate","cancel"]},"cancel_message":{"type":"string","description":"The cancellation message. This field is mandatory if the event has any registrants.","example":"This event is canceled due to conflict with other events."},"duplicate_event":{"type":"object","properties":{"name":{"type":"string","description":"The name of event that have duplicate events.","example":"OpenAPI Conference Name"},"start_time":{"type":"string","description":"The start time of the duplicated event in UTC.","format":"date-time","example":"2024-07-28T13:00:00Z"},"timezone":{"type":"string","description":"The timezone of the duplicated event.  \n For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).","example":"America/Indianapolis"}},"description":"This field contains duplicated event configuration. It is only required when the operation is duplicate."}}}}}},"responses":{"201":{"description":"The event operation processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the event operation. \n*`Duplicated`  &mdash; Duplicated the event from source event.\n*`Published` &mdash; Event successfully published.\n*`Cancelled` &mdash; Event successfully cancelled.","example":"Duplicated","enum":["duplicated","published","cancelled"]},"event_id":{"type":"string","description":"The ID of the event will return a new duplicated event ID, if the operation is a duplicate event.","example":"kNqLPC6hSFiZ9NpgjA549w"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1001` <br>\n Invalid event ID. <br>\n**Error Code:** `1002` <br>\n Invalid duplicated event name. <br>\n**Error Code:** `1002` <br>\n Invalid duplicated event start time. <br>\n**Error Code:** `1003` <br>\n Invalid duplicate event timezone. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_basic:write","zoom_events_basic:write:admin","zoom_events:write:event","zoom_events:write:event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_basic:write","zoom_events_basic:write:admin"],"x-granular-scopes":["zoom_events:write:event","zoom_events:write:event:admin"]}}},"/zoom_events/events/{eventId}/exhibitors":{"get":{"tags":["Exhibitors"],"summary":"List exhibitors","description":"Lists all exhibitors associated with an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read:admin`,`zoom_events_exhibitors:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_exhibitors`,`zoom_events:read:list_exhibitors:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getExhibitors","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n A list of exhibitors.","content":{"application/json":{"schema":{"title":"Exhibitor pagination","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"exhibitors":{"maxItems":300,"type":"array","description":"The list of exhibitors for the event.","items":{"title":"List of all exhibitors associated with the event.","type":"object","properties":{"exhibitor_id":{"type":"string","description":"The exhibitors's ID.","example":"kNqLPC6hSFiZ9NpgjA549w"},"name":{"type":"string","description":"The exhibitors's name.","example":"Fletchie Doe"},"is_sponsor":{"type":"boolean","description":"The sponsorer's flag. It will be set to true by default.","example":true},"tier_id":{"type":"string","description":"The sponsor tier ID for a particular event. This field only applies to a sponsor.","example":"4fgRIOXjQGmoH6raAzJf8g"},"description":{"type":"string","description":"The exhibitor's description.","example":""},"associated_sessions":{"maxItems":200,"type":"array","description":"The sessions associated with the exhibitor or sponsor. The value is an array of sessionIds.","items":{"type":"string","example":"[QnjbUW7ORu2sjvjNfjf_zQ, iERy5vUPRW259kk9l0zNbQ]"}},"contact_name":{"type":"string","description":"The contact's full name.","example":"John Doe"},"contact_email":{"type":"string","description":"The contact's email address.","example":"abc.def@email.com"},"website":{"type":"string","description":"The website URL.","example":"https://mywebsite.com/example"},"privacy_policy":{"type":"string","description":"The privacy policy link.","example":"https://mywebsite.com/example"},"linkedin_url":{"type":"string","description":"The link to the LinkedIn profile.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The link to the Twitter profile.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The link to the YouTube profile.","example":"https://youtube.com/example"},"instagram_url":{"type":"string","description":"The link to the Instagram profile.","example":"https://instagram.com/profile"},"facebook_url":{"type":"string","description":"The link to the Facebook page.","example":"https://facebook.com/profile"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:read:admin","zoom_events_exhibitors:read","zoom_events:read:list_exhibitors","zoom_events:read:list_exhibitors:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:read:admin","zoom_events_exhibitors:read"],"x-granular-scopes":["zoom_events:read:list_exhibitors","zoom_events:read:list_exhibitors:admin"]}},"post":{"tags":["Exhibitors"],"summary":"Create an exhibitor","description":"Creates an exhibitor for a multi-session and conference-type event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:exhibitor`,`zoom_events:write:exhibitor:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createExhibitor","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Exhibitor","required":["contact_email","contact_name","is_sponsor","name","tier_id"],"type":"object","properties":{"name":{"type":"string","description":"The exhibitors's name.","example":"Fletchie Doe"},"is_sponsor":{"type":"boolean","description":"The sponsorer's flag. It will be set to true by default.","example":true},"tier_id":{"type":"string","description":"The sponsor tier ID for a particular event. This field only applies to a sponsor.","example":"4fgRIOXjQGmoH6raAzJf8g"},"description":{"type":"string","description":"The exhibitor's description.","example":""},"associated_sessions":{"maxItems":200,"type":"array","description":"The sessions associated with the exhibitor or sponsor. The value is an array of `sessionIds`.","items":{"type":"string","example":"[QnjbUW7ORu2sjvjNfjf_zQ, iERy5vUPRW259kk9l0zNbQ]"}},"contact_name":{"type":"string","description":"The contact's full name.","example":"John Doe"},"contact_email":{"type":"string","description":"The contact's email address.","example":"abc.def@email.com"},"website":{"type":"string","description":"The website's URL.","example":"https://mywebsite.com/example"},"privacy_policy":{"type":"string","description":"The privacy policy link.","example":"https://mywebsite.com/example"},"linkedin_url":{"type":"string","description":"The link to the LinkedIn profile.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The link to the Twitter profile.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The link to the YouTube profile.","example":"https://youtube.com/example"},"instagram_url":{"type":"string","description":"The link to the Instagram profile.","example":"https://instagram.com/profile"},"facebook_url":{"type":"string","description":"The link to the Facebook page.","example":"https://facebook.com/profile"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   Speakers returned.","content":{"application/json":{"schema":{"title":"Exhibitor","type":"object","properties":{"exhibitor_id":{"type":"string","description":"The exhibitors's ID.","example":"kNqLPC6hSFiZ9NpgjA549w"},"name":{"type":"string","description":"The exhibitors's name.","example":"John Doe"},"is_sponsor":{"type":"boolean","description":"The sponsorer's flag. It will be set to true by default.","example":true},"tier_id":{"type":"string","description":"The sponsor tier ID for a particular event. This field only applies to a sponsor.","example":"4fgRIOXjQGmoH6raAzJf8g"},"description":{"type":"string","description":"The exhibitor's description.","example":""},"associated_sessions":{"maxItems":200,"type":"array","description":"The sessions associated with the exhibitor or sponsor. The value is an array of sessionIds.","items":{"type":"string","example":"[QnjbUW7ORu2sjvjNfjf_zQ, iERy5vUPRW259kk9l0zNbQ]"}},"contact_name":{"type":"string","description":"The contact's full name.","example":"John Doe"},"contact_email":{"type":"string","description":"The contact's email address.","example":"abc.def@email.com"},"website":{"type":"string","description":"The website's URL.","example":"https://mywebsite.com/example"},"privacy_policy":{"type":"string","description":"The privacy policy link.","example":"https://mywebsite.com/example"},"linkedin_url":{"type":"string","description":"The link to the LinkedIn profile.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The link to the Twitter profile.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The link to the YouTube profile.","example":"https://youtube.com/example"},"instagram_url":{"type":"string","description":"The link to the Instagram profile.","example":"https://instagram.com/profile"},"facebook_url":{"type":"string","description":"The link to the Facebook page.","example":"https://facebook.com/profile"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n**Error Code:** `1020` <br>\n Exhibitor ID is invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2006` <br>\n Exhibitor not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin","zoom_events:write:exhibitor","zoom_events:write:exhibitor:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin"],"x-granular-scopes":["zoom_events:write:exhibitor","zoom_events:write:exhibitor:admin"]}}},"/zoom_events/events/{eventId}/exhibitors/{exhibitorId}":{"get":{"tags":["Exhibitors"],"summary":"Get an exhibitor","description":"Returns the exhibitor information of a specified event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read`,`zoom_events_exhibitors:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:exhibitor`,`zoom_events:read:exhibitor:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getExhibitorInfo","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"exhibitorId","in":"path","description":"The ID of the exhibitor.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nEvent returned.","content":{"application/json":{"schema":{"title":"Exhibitor information","type":"object","properties":{"exhibitor_id":{"type":"string","description":"The exhibitors's ID.","example":"kNqLPC6hSFiZ9NpgjA549w"},"name":{"type":"string","description":"The exhibitors's name.","example":"Fletchie Doe"},"is_sponsor":{"type":"boolean","description":"A sponsorer's flag. It will be set to true by default.","example":true},"tier_id":{"type":"string","description":"The sponsor tier ID for a particular event. This field only applies to a sponsor.","example":"4fgRIOXjQGmoH6raAzJf8g"},"description":{"type":"string","description":"The exhibitor's description.","example":""},"associated_sessions":{"maxItems":200,"type":"array","description":"The sessions associated with the exhibitor or sponsor. The value is an array of `sessionIds`.","items":{"type":"string","example":"[QnjbUW7ORu2sjvjNfjf_zQ, iERy5vUPRW259kk9l0zNbQ]"}},"contact_name":{"type":"string","description":"The contact's full name.","example":"John Doe"},"contact_email":{"type":"string","description":"The contact's email address.","example":"abc.def@email.com"},"website":{"type":"string","description":"The website's URL.","example":"https://mywebsite.com/example"},"privacy_policy":{"type":"string","description":"The privacy policy link.","example":"https://mywebsite.com/example"},"linkedin_url":{"type":"string","description":"The link to the LinkedIn profile.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The link to the Twitter profile.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The link to the YouTube profile.","example":"https://youtube.com/example"},"instagram_url":{"type":"string","description":"The link to the Instagram profile.","example":"https://instagram.com/profile"},"facebook_url":{"type":"string","description":"The link to the Facebook page.","example":"https://facebook.com/profile"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n**Error Code:** `1020` <br>\n Exhibitor ID is invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2006` <br>\n Exhibitor not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:read","zoom_events_exhibitors:read:admin","zoom_events:read:exhibitor","zoom_events:read:exhibitor:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:read","zoom_events_exhibitors:read:admin"],"x-granular-scopes":["zoom_events:read:exhibitor","zoom_events:read:exhibitor:admin"]}},"delete":{"tags":["Exhibitors"],"summary":"Delete an exhibitor","description":"Deletes an exhibitor.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:exhibitor`,`zoom_events:delete:exhibitor:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteExhibitor","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"exhibitorId","in":"path","description":"The ID of the exhibitor.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nExhibitor deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n**Error Code:** `1020` <br>\n Exhibitor ID is invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2006` <br>\n Exhibitor not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin","zoom_events:delete:exhibitor","zoom_events:delete:exhibitor:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin"],"x-granular-scopes":["zoom_events:delete:exhibitor","zoom_events:delete:exhibitor:admin"]}},"patch":{"tags":["Exhibitors"],"summary":"Update exhibitor for an event","description":"Updates the exhibitor for an event ID. This operation is only allowed for a multi-session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:exhibitor`,`zoom_events:update:exhibitor:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateExhibitor","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"exhibitorId","in":"path","description":"The ID of the exhibitor.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Exhibitor information","type":"object","properties":{"name":{"type":"string","description":"The exhibitors's name.","example":"Exhibitor name"},"is_sponsor":{"type":"boolean","description":"The sponsor's flag. It will be set to true by default.","example":true},"sponsor_tier":{"type":"string","description":"The sponsor tier ID for a particular event. This field only applies to sponsor.","example":"4fgRIOXjQGmoH6raAzJf8g"},"description":{"type":"string","description":"The exhibitor's description.","example":""},"associated_sessions":{"maxItems":200,"type":"array","description":"The sessions associated the exhibitor or sponsorer. The value is an array of `sessionIds`.","items":{"type":"string","example":"[QnjbUW7ORu2sjvjNfjf_zQ,iERy5vUPRW259kk9l0zNbQ]"}},"contact_name":{"type":"string","description":"The full name of the contact.","example":"John Doe"},"contact_email":{"type":"string","description":"The contact email address.","example":"abc.def@email.com"},"website":{"type":"string","description":"The website URL.","example":"https://mywebsite.com/example"},"privacy_policy":{"type":"string","description":"The privacy policy link.","example":"https://mywebsite.com/example"},"linkedin_url":{"type":"string","description":"The link to the LinkedIn profile.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The link to the Twitter profile.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The link to the YouTube profile.","example":"https://youtube.com/example"},"instagram_url":{"type":"string","description":"The link to the Instagram profile.","example":"https://instagram.com/profile"},"facebook_url":{"type":"string","description":"The link to the Facebook page.","example":"https://facebook.com/profile"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated the exhibitor."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n**Error Code:** `1020` <br>\n Exhibitor ID is invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2006` <br>\n Exhibitor not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin","zoom_events:update:exhibitor","zoom_events:update:exhibitor:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin"],"x-granular-scopes":["zoom_events:update:exhibitor","zoom_events:update:exhibitor:admin"]}}},"/zoom_events/events/{eventId}/sponsor_tiers":{"get":{"tags":["Exhibitors"],"summary":"List sponsor tiers","description":"Lists all sponsor tiers associated with an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read:admin`,`zoom_events_exhibitors:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_sponsor_tiers`,`zoom_events:read:list_sponsor_tiers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListSponsorTiers","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n A list of sponsor_tiers.","content":{"application/json":{"schema":{"title":"Sponsor tiers pagination","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"sponsor_tiers":{"maxItems":300,"type":"array","description":"The list of sponsor tiers for the event.","items":{"title":"List of all sponsor tiers associated with the event.","type":"object","properties":{"tier_id":{"type":"string","description":"The sponsor tier ID.","example":"CvY9Azb0QwGid19eI1IlyQ"},"name":{"type":"string","description":"The sponsor tier name after update.","example":"Updated Sponsor Tier name"},"description":{"type":"string","description":"The sponsor tier description.","example":"Platinum Sponsor Tier"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1006` <br>\n Operation is not supported for this event type.  <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3011` <br>\n User is not a host. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_exhibitors:read:admin","zoom_events_exhibitors:read","zoom_events:read:list_sponsor_tiers","zoom_events:read:list_sponsor_tiers:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_exhibitors:read:admin","zoom_events_exhibitors:read"],"x-granular-scopes":["zoom_events:read:list_sponsor_tiers","zoom_events:read:list_sponsor_tiers:admin"]}}},"/zoom_events/files":{"post":{"tags":["Files"],"summary":"Upload events file","description":"Uploads files to Zoom Webinars Plus & Events. Use this API to upload video recordings and supporting assets for Zoom Events Video Management (ZE VOD). When `file_type=recording`, the file is uploaded as a video in a single step and a `video_id` is returned. For other `file_type` values, the API uploads supporting files (e.g., captions, thumbnails, metadata) and returns a `file_id`. These files must be attached to a video in a second step using the [Update Video Metadata API](/docs/api/events/#tag/videos/patch/zoom_events/videos/{videoId}/metadata).\n\n **Note:**  \n* These file upload Open APIs are currently limited to supporting video recordings and their associated metadata files only (supported formats: `.vtt`, `.jpeg/jpg`, `.png`, `.pdf`, `.txt`, `.ppt`, `.doc`, `.csv`, `xls`). They do not support the ZE content library or other file upload use cases on the ZE platform at this time, though support for additional use cases may be added in the future.\n\n* Base URL: `https://fileapi.zoom.us/v2/`.  \n* The caller must support HTTP 30x redirects.\n* The caller must retain the Authorization header when redirected to a different hostname. \n* Supported video formats: `.mp4`, `.webm`.\n* Supported transcription/captioning file formats: `.vtt`.\n* When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write`,`zoom_events_file:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`","operationId":"uploadEventFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The upload file, in binary format. You can only send a maximum of two gigabytes.","format":"binary","example":"wetrqwetqwertsadfasdgsfdgdfgsdfgsdfgdsf..."},"hub_id":{"type":"string","description":"The hub ID. This is needed when uploading `recording` video files for Zoom Events video management feature (ZE VOD)","example":"kUoe5oPTRvGTbcfJmNwsnw"},"file_type":{"type":"string","description":"Specifies the category of file being uploaded. If no value is provided then it defaults to `recording` type. \n* `recording` — Recording video content file used for on-demand video channels content in Zoom Events video management feature (e.g., .mp4, .webm). \n* `video` — Regular video file used in contexts such as speaker biography or event logo etc (e.g., .mp4, .mov, .mkv). \n* `other` - Any other uncategorized file type (catch-all).","example":"recording","enum":["recording","video","other"],"x-enumDescriptions":{"recording":"Recording video content file used for on-demand video channels content in Zoom Events video management feature (e.g., .mp4, .webm).","video":"Regular video file used in contexts such as speaker biography or event logo etc (e.g., .mp4, .mov, .mkv).","other":"Any other uncategorized file type (catch-all)."}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   \n \nFile successfully uploaded.","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"The unique identifier for the uploaded file. This is a temporary ID, valid for 7 days from the time of upload. It is primarily used as a reference in other APIs, such as the Video Metadata API, where a file_id is required to associate files (e.g., thumbnails, transcripts, or resources) with a video.","example":"xBvggqyjQUal6TecwMlYwE"},"video_id":{"type":"string","description":"Video recording ID. If the uploaded file is of type `recording` then this field is returned.","example":"xBvggqyjQUal6TecwMlYwE"}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_file:write","zoom_events_file:write:admin","zoom_events:write:file_upload","zoom_events:write:file_upload:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_file:write","zoom_events_file:write:admin"],"x-granular-scopes":["zoom_events:write:file_upload","zoom_events:write:file_upload:admin"]}},"servers":[{"url":"https://fileapi.zoom.us/v2","description":"File server open api"}]},"/zoom_events/files/multipart":{"post":{"tags":["Files"],"summary":"Upload events multipart files","description":"Uploads a multipart file. \n\n**Note:** \n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Once initiated, the multipart upload must complete within 7 days. \n* In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write:admin`,`zoom_events_file:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`","operationId":"uploadMultipartEventFile","parameters":[{"name":"upload_id","in":"query","description":"When uploading multipart files, use the upload context to identify the multipart upload whose part is being uploaded.","required":true,"schema":{"type":"string","example":"noNpr2pkBEv4_fTxYWDEHBsSs3pl8keRx4fPZmnyNDe"}},{"name":"part_number","in":"query","description":"When uploading multipart files, this field indicates the part number of the part being uploaded . This field is a positive integer between 1 and 100.","required":true,"schema":{"type":"integer","example":10}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The upload file, in binary format. \n\nEach part must be at most 100 MB in size, and at least 5 MB in size, except the last part.","format":"binary","example":"Vm0wd2QyUXlVWGxWV0d4V1YwZDRWMVl3WkRSV01WbDNXa1JTVjAxV2JETlhhMUpUVmpBeFYySkVUbGhoTVVwVVZtcEJlRll5U2tWVWJHaG9UVlZ3VlZadGNFSmxSbGw1VTJ0V1ZXSkhhRzlVVmxaM1ZsWmFkR05GU214U2JHdzFWVEowVjFaWFNraGhSemxWVm14YU0xWnNXbUZrUjA1R1UyMTRVMkpIZHpGV1ZFb3dWakZhV0ZOcmFHaFNlbXhXVm0xNFlVMHhXbk5YYlVacVZtdGFNRlZ0ZUZOVWJVcEdZMFZ3VjJKVVJYZFpWRVpyVTBaT2NscEhjRk5XUjNob1ZtMXdUMVV4U1hoalJscFlZbFZhY2xWcVFURlNNVlY1VFZSU1ZrMXJjRWxhU0hCSFZqRmFSbUl6WkZkaGExcG9WakJhVDJOdFJraGhSazVzWWxob1dGWnRNWGRVTVZGM1RVaG9hbEpzY0ZsWmJGWmhZMnhXY1ZGVVJsTk5XRUpIVmpKNFQxWlhTa2RqUm14aFUwaENTRlpxUm1GU2JVbDZXa1prYUdFeGNHOVdha0poVkRKT2RGSnJhR2hTYXpWeldXeG9iMWRHV25STlNHUnNVakJzTkZVeWRHdFhSMHBJVld4c1dtSkdXbWhaTW5oWFkxWktkRkpzVWxOaVIzY3hWa1phVTFVeFduSk5XRXBxVWxkNGFGVXdhRU5UUmxweFUydGFiRlpzV2xwWGExcDNZa2RGZWxGcmJGaFhTRUpJVmtSS1UxWXhXblZWYldoVFlYcFdlbGRYZUc5aU1XUkhWMjVTVGxkSFVsWlVWbHBIVFRGU1ZtRkhPV2hpUlhCNldUQmFjMWR0U2tkWGJXaGFUVzVvV0ZreFdrZFdWa3B6VkdzMVYwMVZiekZXYlhCTFRrWlJlRmRzYUZSaVJuQlpWbXRXZDFZeGJISlhhM1JVVW14d2VGVnRNVWRWTWtwV1lrUmFXR0V4Y0hKWlZXUkdaVWRPU0U5V1pHaGhNSEJ2Vm10U1MxUXlVa2RUYmtwb1VqSm9WRmxZY0ZkbGJHUllaVWM1YVUxWFVraFdNalZUVkd4a1NGVnNXbFZXYkhCSVZGUkdVMVp0UmtoUFYyaHBVbGhDTmxkVVFtRmpNV1IwVTJ0a1dHSlhhR0ZVVnpWdlYwWnJlRmRyWkZkV2EzQjZWa2R6TVZZd01WWmlla1pYWWxoQ1MxUldaRVpsUm1SWldrVTFWMVpzY0ZWWFZsSkhaREZaZUdKSVNsaGhNMUpWVlcxNGQyVkdWblJOVldSV1RXdHdWMWxyVW1GWFIwVjRZMGhLV2xaWFVrZGFWV1JQVTBVNVYxcEhhR2hOU0VKMlZtMTBVMU14VVhsVmEyUlVZbXR3YjFWcVNtOVdSbXhaWTBaa2JHSkhVbGxhVldNMVlWVXhXRlZyYUZkTmFsWlVWa2Q0VDFOSFJrZFJiRnBwVmtWVmQxWnRjRWRWTVZwMFVtdG9VRlp0YUZSVVZXaERUbFphU0dWSFJtcE5WMUl3VlRKMGExZEhTbGhoUjBaVlZteHdNMWxWV25kU2JIQkhWR3hTVTJFelFqVldSM2hoVkRKR1YxTnVVbEJXUlRWWVZGYzFiMWRHWkZkWGJFcHNVbTFTZWxsVldsTmhWa3AxVVc1b1YxWXphSEpXVkVaelZqRldjMWRzYUdsV1ZuQlFWa1phWVdReVZrZFdXR3hyVWtWS1dGUldXbmRsVm10M1YyNWtXRkl3VmpSWk1HaExWMnhhV0ZWclpHRldWMUpRVldwS1MxSXlSa2hoUlRWWFltdEtNbFp0TVRCVk1VMTRWVmhzVm1FeVVsWlpiWFIzWVVaV2RHVkZkR3BTYkhCNFZUSXdOV0pIU2toVmJHeGhWbGROTVZsV1ZYaFhSbFp5WVVaa1RtRnNXbFZXYTJRMFdWWktjMVJ1VG1oU2JGcFlXV3RhV2sxR1draGtSMFphVm0xU1NWWlhkRzloTVVwMFZXczVWMkZyV2t4Vk1uaHJWakZhZEZKdGNFNVdNVWwzVmxSS01HSXlSa2RUYms1VVlrZG9WbFpzV25kTk1WcHlWMjFHYWxack5YbFhhMXBQWVZaS2NtTkVXbGRoTWs0MFdYcEdWbVZXVG5WVGJGSnBWbFp3V1ZaR1l6RmlNV1JIWWtoR1ZHRXhjSE5WYlRGVFYyeGtjbFpVUmxkTlZuQjZXVEJhVjFkR1duTlRhMmhoVWtWYVlWcFZaRXRUVms1ellVZG9UazFWY0ZaV2JHTjRUa2RSZVZaclpGZGlSMUp2Vlc1d2MySXhVbGRYYm1Sc1lrWnNOVmt3Vm10V01ERkZVbXBHV2xaWGFFeFdNbmhoVjBaV2NscEhSbGROTW1oSlYxUkplRk14U1hsU2EyUm9VbXhLVkZac2FFTlRNVnAwVFZSQ1ZrMVZNVFJXYkdodlYwWmtTR0ZHYkZwaVdHaG9WbXBHYzJNeGNFaFBWbVJUWWxob1lWZFVRbUZoTWtwSVUydG9WbUpIZUdoV2JHUk9UVlpzVjFaWWFGaFNiRnA1V1ZWYWExUnRSbk5YYkZaWFlUSlJNRmxVUms5U01WcDFWR3hvYVZKc2NGbFhWM1J2VVRGT1YxZHJaRlpoTWxKWFZGWmFkMDFHVm5Sa1J6bFdVbXhzTlZsVmFFTldiVXBJWVVWU1ZXSllhSEpXYkZwSFpFWktkR05GTlZkTlZXd3pWbXhTUzAxSFJYaGFSV2hVWWtkb2IxVnFRbUZXYkZwMVkwWmthMkpHYkROV01qVkxZa1pLZEZWdWJGaGhNWEJ5Vm1wS1JtVnNSbkZYYkdSb1RXeEpNbFpHV21GWGJWRjNUVlprV0dKWGVITlpWRVozVjFaa1dHVkhPVkpOVmtwSVZsYzFTMWRIU2taalNFNVdZbFJHVkZwWGVITldiR1J6Vkcxb1YyRXpRWGhXVm1NeFlqRlplRmRZY0doVFJYQllWbXRXWVdWc1duRlNiR1JxVFZkU2VsbFZaSE5XTVZwMVVXeEdWMkV4Y0doWFZtUlNaVlphY2xwR1pGaFNNMmg1VmxkMFYxTXhaRWRWYkdSWVltMVNjMVp0TVRCTk1WbDVUbGQwV0ZKcmJETldiWEJUVjJzeFNHRkZlRmROYm1ob1ZqQmFWMk5zY0VoU2JHUlhUVlZ3VWxac1pIZFRNVTE0VTFoc1UyRXlhRzlWYkZKWFYwWnNkR1JGZEU1aVJuQXdWRlpTUTFack1WWk5WRkpYVm0xb2VsWnNXbXRUUjFaSFYyeHdWMUpXYjNwWFZsWmhWakpPVjFSdVVsQldiVkpVV1d0V2QxZHNXa2hsUjNCUFZqQldOVlV5ZEd0aGJFcFlZVVpvV21KR1NrTlVWbHBoVjBkTmVtRkdhRk5pUm5BMlYxWldZV0V4VW5OWFdHeG9Va1Z3V0ZSV1duZGhSbFkyVW10d2JGSnNTakZXYlhoTFlWWktjMk5HYkZkU2JFcElWWHBCTVdNeFpISmFSbHBvVFd4S1dGWkdXbUZrTURGSFZtNVNhMUo2YkZkVmJYaDNUVVpzVmxkc1RsZFdiSEJaV1ZWV1UxWnJNWFZoUjJoYVpXdGFNMVZzV2xka1IwNUdUbFprVGxaWGQzcFdiWGhUVXpBeFNGTlliRk5oTWxKVldXMXpNVlpXYkhKYVJ6bFhZa1p3ZWxZeU5XdFVhekZYWTBoc1YwMXFSa2haVjNoaFkyMU9SVkZ0UmxOV01VWXpWbTF3UzFNeVRuTlVia3BvVW0xU1ZGUlVTbTlpTVZweVZXdDBVMDFXYkRSV1J6VlhWbTFLUmxOc2FGWmlSa3BZVmpGYVlWSXhiRFpTYld4T1ZqRktTVll5ZEdGaE1XUklVMnRhYWxORk5WZFpiRkpIVmtad1dHVklUbGRpUjFKNlZrY3hiMVl5UlhwUldHaFhWbTFSTUZwRVJscGxWazV6WWtaYWFWSXlhRzlXVjNSWFdWWnNWMk5HV21GU1dGSlZWbTF6TVdWc2JGWmFSemxWWVhwR1Yxa3dXbUZXTWtwSVZHcFNWV0V5VWxOYVZscGhZMnh3UjFwSGJGTk5WWEF5Vm14ak1XUXlUWGxUV0doV1lrZFNXVmx0TVZOak1XeHlWMjVPVDFadGRETldiVEV3VmpBeFJWSnJXbFppV0VKSVZqSjRZVmRIUmtabFJtUk9ZbTFvYjFacVFtRldNazV6WTBWb1UySkhVazlVVnpGdlUyeFplRlZyY0d4U2F6RTBWVEZvYjJGc1NsaFZiV2hXWWtaS1dGWkVSbGRqTWtaR1ZHeFNUbFp1UVhkV1JscFRVVEZhY2sxV1drNVdSa3BZV1d0a2IyUnNXWGRYYlhSVVVqQmFTRmxWV25kaFZtUklZVWM1VjJKWVFraFpla3BPWlZaS2NsZHNWbWxTTVVwVlYxZDRiMkl4YkZkYVJsWlNZbFZhYjFSWGRGZE5NVkpYVjIxMGFHSkZjRWRWTWpGSFZsWmFWMk5IUm1GU1JWcDZWbXBHWVZkWFJrZGhSazVwVW01Qk1WWXhXbGRaVjBWNFZXNVNVMkpyTlZsWmExcGhWMFpzVlZOc1NrNVNiVkpZVmpKME1HRnJNVmRUYWtaWFVucEdkbFpVU2t0U01rNUhZa1prVTJKRmNFMVhWM0JIVkRGWmVGcElTbWhTTTJoVVZGVmFkMkZHV25STlNHaFdUVlZzTkZaWE5VOVhSMHBXVjJ4a1ZtSllhSHBVYkZwelZteGtkRTlXYUdsU01VcExWbFprTkdJeFduSk5WV1JxVWpKb1lWUldXbmRWUm10NFYyeGthazFYVW5sVWJGcHJWR3hhV0dRemNGZGlXR2hVVlhwQmVGTkdTbGxoUjBaVFZqSm9WbGRYZEd0aU1rbDRWbTVHVW1KVldsaFphMXAzVFVad1ZtRkhkRlZoZWtaWVdUQm9jMVl3TVhGU2EyaGFWak5vYUZreU1VOVNWa1owVW14T1YwMVZXWHBXYlRGM1V6Rk5lVlJ1VGxWaWEzQnZWVzB4VTFaR1VsVlRiVGxwVFZad2VWWlhkREJWTURGWFlrUlNWMUo2VmxoV2JURkxVbXhPYzJGR1dtbFNhM0JaVm1wR1lWbFdTWGhpUkZwVFlsZDRUMVpxUmt0VFZtUllaRWRHVjAxV1ducFhhMVp2WVVaS2MxTnNXbGRpVkVaVVZtdGFkMWRIVmtsVWJHUnBVakZLTmxaclkzaGlNVlY0VjJ0YVdHRnNjRmhXYTFaeVpVWnNjVkpzY0d4U2JWSmFXVEJhWVdGV1NYbGhSbkJYWWxSRk1GcEVSbk5XTWs1SFYyeG9hVmRHU25sV2JURXdaREpXYzFkdVVrNVhSVFZZVkZaV2MwNXNiRlpWYkdSWFRVUkdXVlpXYUd0WFJscDBWV3hPWVZac2NHaFpNbmgzVWpGd1NHSkhiRk5YUlVreFZtMTRhMDFHV1hoVVdHeFVWMGRvY0ZWdE1UUmpWbFp6V2taT2FrMVdjREJhVlZZd1lrZEtSMk5FUWxWV1ZrcFlWakJhU21ReVRrWmhSbkJPVW01Q01sWnFTbnBsUms1SVVtdGFiRkp0VWs5WmJURnZZakZhY1ZGdFJsZE5helY2V1RCV2IxVXlTa2hWYXpsVlZucEdkbFV5ZUZwbFJsWnlZMGQ0VTJGNlJUQldWRVp2WWpKR2MxTnNhRlppVjJoWFdXeG9UbVZHV1hkWGJIQnJUVlp3ZVZwRlZURmhWa3AxVVZoa1dGWkZTbGhaVkVacll6RmtXVnBHWkdoaVJYQlpWMWQwYTJJeVVuTlhXR1JZWWxoU1ZWVnFRbUZUUmxsNVpVaGthRlp0VWtsWlZXTTFWakpLVlZKVVFscGxhM0JRV1hwR2QxTldUblJrUms1T1RVVndWbFl4WkRCWlYxRjNUbFZrV0dKSGFFOVdhMVpMVkRGV2RHVklUazlTYkd3MVZHeFZOV0ZIU2taalJteGFWbFp3ZGxacVNrZGphelZYVld4a1UxWnVRalpXYlhoaFVqRmtXRkpyWkZWaVIxSnZWRlJDU2sxc1duUmtSM1JQVW0xNFdGWnNhSE5XUjBWNFkwWnNWMDFIYUVSV01GcGhZekZrZFZwR1RrNVdhMWt3Vm1wS01GUXhXblJUYTFwVVlrWndWbFpzV2tkTk1WWkhVbFJzVVZWVU1Eaz0="}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201 or 204`   \n \nMultipart file part uploaded successfully.","headers":{"x-zm-part-number":{"description":"Uploaded part number.\n\nCollect and bring it back in the final request to complete the multipart upload request.","schema":{"type":"integer","example":1}},"x-zm-etag":{"description":"ETag for the uploaded part, if returned.","schema":{"type":"string","example":"sdfsf"}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_file:write:admin","zoom_events_file:write","zoom_events:write:file_upload","zoom_events:write:file_upload:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_file:write:admin","zoom_events_file:write"],"x-granular-scopes":["zoom_events:write:file_upload","zoom_events:write:file_upload:admin"]}},"servers":[{"url":"https://fileapi.zoom.us/v2","description":"File server open api"}]},"/zoom_events/files/multipart/upload":{"post":{"tags":["Files"],"summary":"Initiate and complete the multipart file upload ","description":"Uploads files to Zoom Events using a multipart API Use this API when the file is large, typically when the size reaches 2 GB. Use this API to upload video recordings and supporting assets for Zoom Events Video Management (ZE VOD). When `file_type=recording`, the file is uploaded as a video in a single step and a `video_id` is returned. For other `file_type` values, the API uploads supporting files (e.g., captions, thumbnails, metadata) and returns a `file_id`. These files must be attached to a video in a second step using the [Update Video Metadata API](/docs/api/events/#tag/videos/patch/zoom_events/videos/{videoId}/metadata).\n\n**Note:** \n\n* These file upload Open APIs are currently limited to supporting video recordings and their associated metadata files only (supported formats: `.vtt`, `.jpeg/jpg`, `.png`, `.pdf`, `.txt`, `.ppt`, `.doc`, `.csv`, `xls`). They do not support the ZE content library or other file upload use cases on the ZE platform at this time, though support for additional use cases may be added in the future.\n\n* The base URL for this API is `https://fileapi.zoom.us/v2/`. \n* The caller must support HTTP 30x redirects. \n* The caller must retain the authorization header when redirected to a different hostname. \n* Once initiated, the multipart upload must complete within 7 days. \n* Supported video formats: `.mp4`, `.webm`.\n* Supported transcription/captioning file formats: `.vtt`.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write:admin`,`zoom_events_file:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`","operationId":"initiateAndCompleteAEventMultipartUpload.","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"required":["file_name","length","method"],"type":"object","properties":{"method":{"type":"string","description":"The method to upload events: \n* `CreateMultipartUpload` — Create a multipart upload.","example":"CreateMultipartUpload","enum":["CreateMultipartUpload"]},"file_name":{"type":"string","description":"The file name.","example":"File name"},"length":{"type":"integer","description":"The file size in bytes.","example":1001},"hub_id":{"type":"string","description":"The hub ID. This is needed when uploading `recording` video files for Zoom Events video management feature (ZE VOD)","example":"kUoe5oPTRvGTbcfJmNwsnw"},"file_type":{"type":"string","description":"Specifies the category of file being uploaded. If no value is provided then it defaults to `recording` type. \n* `recording` — Recording video content file used for on-demand video channels content in Zoom Events video management feature (e.g., .mp4, .webm). \n* `video` — Regular video file used in contexts such as speaker biography or event logo etc (e.g., .mp4, .mov, .mkv). \n* `other` - Any other uncategorized file type (catch-all).","example":"recording","enum":["recording","video","other"],"x-enumDescriptions":{"recording":"Recording video content file used for on-demand video channels content in Zoom Events video management feature (e.g., .mp4, .webm).","video":"Regular video file used in contexts such as speaker biography or event logo etc (e.g., .mp4, .mov, .mkv).","other":"Any other uncategorized file type (catch-all)."}}},"description":"When a new file upload is initiated, it is initiated with this block."},{"required":["method","part_count","upload_id"],"type":"object","properties":{"method":{"type":"string","description":"The method to upload events: \n `CompleteMultipartUpload` — complete a multipart upload.","example":"CompleteMultipartUpload","enum":["CompleteMultipartUpload"]},"upload_id":{"type":"string","description":"The file upload ID.","example":"AHRZTSSh004nHOOtvmuf5.K2FFwRQKbAk4Fq2O4.OUrVMe41OcWZIfw4fX3GsFLbzC2LYmIa6kL5o5TvrnChL9PFvMfxrMMuc5sI6s9i300wSGKjk2qBVBe9sQawqTBRftJKg3MjWwtPdoirDSWRvQ.0vgvvMTK8lE5ltucqnOM-"},"part_count":{"type":"integer","description":"The total number of parts.","example":100}},"description":"After uploading the file parts, call the API with this block to complete the file upload process."}]}}}},"responses":{"200":{"description":"**Status Code:** `200`   \n \nMultipart upload initiated or completed successfully.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"upload_id":{"type":"string","description":"The upload ID. Return this field if you pass the `CreateMultipartUpload` value for the `method` field. \n\n**Note:**\nUse this upload ID to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests. You also include this upload ID in the final request to complete the multipart upload request.","example":"noNpr2pkBEv4_fTxYWDEHBsSs3pl8keRx4fPZmnyNDe.SPdodJp.3UZDaCI2xRVzkRh0xeEV6RuOrXZpJQBPutWCS424c2YnHVxVh8b9.4DNwd4VErRuD98jeJBwRCgz6rC3I4NQg5zXAtCqPFoC0g--"}},"description":"`upload_id` will be returned for file upload initiation."},{"type":"object","properties":{"file_id":{"type":"string","description":"The unique identifier for the uploaded file. This is a temporary ID, valid for 7 days from the time of upload. It is primarily used as a reference in other APIs, such as the Video Metadata API, where a file_id is required to associate files (e.g., thumbnails, transcripts, or resources) with a video. \nReturns this field if you pass the `CompleteMultipartUpload` value for the `method` field.","example":"xBvggqyjQUal6TecwMlYwQ"},"video_id":{"type":"string","description":"Video recording ID. If the uploaded file is of type `recording` then this field is returned.","example":"xBvggqyjQUal6TecwMlYwE"}},"description":"The `file_id` and `video_id` will be returned upon file upload complete API call."}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_file:write:admin","zoom_events_file:write","zoom_events:write:file_upload","zoom_events:write:file_upload:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_file:write:admin","zoom_events_file:write"],"x-granular-scopes":["zoom_events:write:file_upload","zoom_events:write:file_upload:admin"]}},"servers":[{"url":"https://fileapi.zoom.us/v2","description":"File server open api"}]},"/zoom_events/hubs":{"get":{"tags":["Hubs"],"summary":"List hubs","description":"Retrieves a list of event hubs.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read`,`zoom_events_hubs:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hubs`,`zoom_events:read:list_hubs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getHubList","parameters":[{"name":"role_type","in":"query","description":"The user role type:\n* `Host` &mdash; All hosted Hubs.\n* `Attendee` &mdash; All related Hubs.","required":true,"schema":{"type":"string","example":"host","default":"host","enum":["host","attendee"]}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n A list of hubs.","content":{"application/json":{"schema":{"title":"Hubs Pagination Result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"hubs":{"maxItems":300,"type":"array","items":{"title":"Hub","type":"object","properties":{"hub_id":{"type":"string","description":"The ID of the hub.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_level":{"type":"string","description":"The access level of the hub. \n*  `INTERNAL` -  internal organization\n* `PUBLIC` - the public hub ","example":"PUBLIC","enum":["INTERNAL","PUBLIC"]},"name":{"type":"string","description":"The name of the hub.","example":"Example Hub Name"},"description":{"type":"string","description":"The description of the hub.","example":"Test hub"},"public_url":{"type":"string","description":"The public URL of the hub.","example":"https://example.zoom.us/myhub"},"hidden_hub":{"type":"boolean","description":"This hub will be hidden from the Zoom Events details page and from the hub listings view for attendees.","example":true},"hub_active":{"type":"boolean","description":"This hub will be active to create the Zoom Events.","example":true},"auto_list_events":{"type":"boolean","description":"A list of submitted hub events.","example":true},"landing_hub":{"type":"boolean","description":"Whether this Hub is the landing Hub","example":true}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Hub not found. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_hubs:read","zoom_events_hubs:read:admin","zoom_events:read:list_hubs","zoom_events:read:list_hubs:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_hubs:read","zoom_events_hubs:read:admin"],"x-granular-scopes":["zoom_events:read:list_hubs","zoom_events:read:list_hubs:admin"]}}},"/zoom_events/hubs/{hubId}/hosts":{"get":{"tags":["Hubs"],"summary":"List hub Hosts","description":"Retrieves a list of hub hosts.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus/Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read:admin`,`zoom_events_hubs:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hub_hosts`,`zoom_events:read:list_hub_hosts:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"gethubhostList","parameters":[{"name":"hubId","in":"path","description":"The Hub Id.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n A list of hub hosts.","content":{"application/json":{"schema":{"title":"The Hub Host Pagination Result.","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"hosts":{"maxItems":300,"type":"array","items":{"title":"hosts","type":"object","properties":{"host_user_id":{"type":"string","description":"The user ID of the hub host.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"email":{"type":"string","description":"The email address of the hub host.","example":"host@example.com"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_hubs:read:admin","zoom_events_hubs:read","zoom_events:read:list_hub_hosts","zoom_events:read:list_hub_hosts:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_hubs:read:admin","zoom_events_hubs:read"],"x-granular-scopes":["zoom_events:read:list_hub_hosts","zoom_events:read:list_hub_hosts:admin"]}},"post":{"tags":["Hubs"],"summary":"Creates a new hub host","description":"Add a host to the hub.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hub:write`,`zoom_events_hub:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:hub_host`,`zoom_events:write:hub_host:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createHubHost","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"description":"The hub host information.","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the host.","example":"email@example.com"}},"description":"The hub host information."}}}},"responses":{"201":{"description":"The hub host created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"host_user_id":{"type":"string","description":"The hub host ID.","example":"di78aUD6RwmuRQY3WlK6VA"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_hub:write","zoom_events_hub:write:admin","zoom_events:write:hub_host","zoom_events:write:hub_host:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_hub:write","zoom_events_hub:write:admin"],"x-granular-scopes":["zoom_events:write:hub_host","zoom_events:write:hub_host:admin"]}}},"/zoom_events/hubs/{hubId}/hosts/{hostUserId}":{"delete":{"tags":["Hubs"],"summary":"Remove hub host","description":"Delete a host from the hub.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hub:write`,`zoom_events_hub:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:hub_host`,`zoom_events:delete:hub_host:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteHubHost","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"hostUserId","in":"path","description":"The host user ID.","required":true,"schema":{"type":"string","example":"mWqLPC7hSFiZ9NpgjA845m"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n  The hub host deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_hub:write","zoom_events_hub:write:admin","zoom_events:delete:hub_host","zoom_events:delete:hub_host:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_hub:write","zoom_events_hub:write:admin"],"x-granular-scopes":["zoom_events:delete:hub_host","zoom_events:delete:hub_host:admin"]}}},"/zoom_events/hubs/{hubId}/videos":{"get":{"tags":["Hubs"],"summary":"List hub videos","description":"Lists the video/recording resources of a hub.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read`,`zoom_events_hubs:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hub_videos`,`zoom_events:read:list_hub_videos:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListHubVideos","parameters":[{"name":"hubId","in":"path","description":"The ID of the hub.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"folder_id","in":"query","description":"The ID of the folder that contains videos.","required":false,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  Hub video information.","content":{"application/json":{"schema":{"title":"Hub videos pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in this page.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"videos":{"maxItems":300,"type":"array","description":"Hub videos.","items":{"description":"The list of videos for a hub.","allOf":[{"type":"object","properties":{"video_id":{"type":"string","description":"The Video ID.","example":"iso9Dllddp39dagjLj9j"},"name":{"type":"string","description":"The name of the video resource.","example":"My Recording1"},"source_type":{"type":"string","description":"The video source type: \nOptions:\n * `RECORDING` - Recording file. \n * `UPLOAD` - Manually uploaded file. \n * `FOLDER` - This is a folder for organizing videos.","example":"RECORDING","enum":["RECORDING","UPLOAD","FOLDER"]},"source_event_id":{"type":"string","description":"The ID of the Zoom Event, this video belongs to. If this is not associated to any Zoom Event then it is blank.","example":"eabco9Dllddp39dagjLj9j"},"status":{"type":"string","description":"The video status: \nOptions:\n * `processing` - Video is in processing status and not available for viewing yet.\n * `done` - Processing complete and available for viewing. \n * `unknown` - Processing status is unknown.","example":"processing","enum":["processing","done","unknown"]},"play_link":{"type":"string","description":"Video Play Link","example":"https://abc/recording/unehd6TtTLuTN40owCOqqK"},"duration":{"type":"integer","description":"The video duration in minutes","example":30}}}]}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_hubs:read","zoom_events_hubs:read:admin","zoom_events:read:list_hub_videos","zoom_events:read:list_hub_videos:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_hubs:read","zoom_events_hubs:read:admin"],"x-granular-scopes":["zoom_events:read:list_hub_videos","zoom_events:read:list_hub_videos:admin"]}}},"/zoom_events/hubs/{hubId}/attendee_insights/engagement":{"get":{"tags":["Insights"],"summary":"Get attendee engagement data","description":"Retrieves engagement data for a specific attendee in a Zoom Events hub.\n\n**Scoping**\n- Omit `event_id` → hub-scoped (aggregated across all events in the hub)\n- Provide `event_id` → event-scoped (single event within the hub)\n\n**Engagement types**\n- `Certification` — Certification completion status and progress\n\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_insights:read`,`zoom_events_insights:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:attendee_engagement`,`zoom_events:read:attendee_engagement:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getAttendeeEngagement","parameters":[{"name":"hubId","in":"path","description":"The unique identifier of the hub.","required":true,"schema":{"type":"string","example":"ktZNNn8VRGuXTfzSg9Q7fw"}},{"name":"engagement_type","in":"query","description":"Type of engagement data to retrieve.\n `certification`.","required":true,"schema":{"type":"string","example":"certification","enum":["certification"]}},{"name":"email","in":"query","description":"The attendee email address to filter by. You can also pass `ALL` to return certification engagement records for all attendee emails within the specified event. When using `ALL`, the `event_id` query parameter is required.","required":true,"schema":{"type":"string","format":"email","example":"attendee@example.com"}},{"name":"event_id","in":"query","description":"Narrows the results to a specific event within the hub.","required":false,"schema":{"type":"string","example":"JNB2TQDLQLycFjdf9MIicQ"}},{"name":"session_id","in":"query","description":"Narrows the results to a specific session within an event.","required":false,"schema":{"type":"string","example":"asd2TQDLQLycFjdf9MIicQ"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"Engagement data retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":15},"next_page_token":{"type":"string","description":"The next page token paginates through a large set results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"data":{"type":"array","description":"Array of certification engagement objects.","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the attendee.","example":"attendee@example.com"},"event_id":{"type":"string","description":"The event ID.","example":"JNB2TQDLQLycFjdf9MIicQ"},"event_name":{"type":"string","description":"The event name.","example":"Event ABC"},"session_id":{"type":"string","description":"The session ID.","example":"asdfTQDLQLycFjdf9MIicQ"},"session_name":{"type":"string","description":"The session name.","example":"Session A"},"certification_type":{"type":"string","description":"The certification model. `full_credit` requires all criteria to be met; `partial_credit` awards incremental levels.","example":"full_credit","enum":["full_credit","partial_credit"]},"certification_status":{"type":"string","description":"The certification status.","example":"completed","enum":["completed","in_progress","not_started"]},"certification_time":{"type":"string","description":"The timestamp when the certification was earned, in UTC format (`yyyy-MM-dd'T'HH:mm:ss'Z'`). Returns `null` if not yet completed.","format":"date-time","example":"2026-02-27T19:05:00Z"},"current_level":{"type":"integer","description":"The current completion level for partial credit certifications.","example":3},"total_levels":{"type":"integer","description":"The total number of levels required for full certification.","example":3},"credits_earned":{"type":"number","description":"The number of credits or CEUs earned.","format":"float","example":1.5},"minutes_watched":{"type":"integer","description":"The actual number of minutes the attendee watched.","example":45},"minutes_watched_required":{"type":"integer","description":"The required number of minutes to earn certification.","example":40},"polls_answered":{"type":"integer","description":"The actual number of polls answered.","example":3},"polls_answered_required":{"type":"integer","description":"The required number of polls answered for certification.","example":2},"content_downloads":{"type":"integer","description":"The actual number of content downloads.","example":2},"content_downloads_required":{"type":"integer","description":"The required number of content downloads for certification.","example":1},"meeting_seconds":{"type":"integer","description":"The actual meeting attendance duration in seconds.","example":3517}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_insights:read","zoom_events_insights:read:admin","zoom_events:read:attendee_engagement","zoom_events:read:attendee_engagement:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_insights:read","zoom_events_insights:read:admin"],"x-granular-scopes":["zoom_events:read:attendee_engagement","zoom_events:read:attendee_engagement:admin"]}}},"/zoom_events/events/{eventId}/registrants":{"get":{"tags":["Registrants"],"summary":"List registrants","description":"Retrieves event registrants.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_registrants:read`,`zoom_events_registrants:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registrants`,`zoom_events:read:list_registrants:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getRegistrants","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nList of event registrants.","content":{"application/json":{"schema":{"title":"Registrants info PageToken pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of registrants.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"registrants":{"maxItems":300,"type":"array","description":"Registrants","items":{"title":"Registrant information","type":"object","properties":{"email":{"type":"string","description":"The email address of the registrant.","example":"email@zoom.us"},"registration_status":{"type":"string","description":"Registration status.","example":"INVITED","enum":["REGISTERED","INVITED","GIFTED","DIRECT_JOIN","PRE_REGISTERED","PRE_REGISTER_INVITED"]},"tickets":{"maxItems":50,"type":"array","description":"Tickets list.","items":{"title":"Ticket details","type":"object","properties":{"ticket_id":{"type":"string","description":"Ticket ID.","example":"1234567"},"role":{"type":"string","description":"Ticket Role.","example":"INTERPRETER","enum":["ATTENDEE","SPEAKER","ALTERNATIVE_HOST","PANELIST","INTERPRETER","SPONSOR","EXPO_BOOTH_OWNER","MODERATOR","GUEST","ORIGINAL_HOST"]},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication* `email_opt` registration using email OTP verification*  `zoom_account_otp_at_join` pre-registration using email OTP verification","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join"]},"qr_code_url":{"type":"string","description":"The URL generated after scanning the e-badge QR code image. This field is applicable only for hybrid or in-person event types.","example":"https://zoom.us/qr?t=9&ein=AkhZhct94cUqiDfRumcpPf0loI-QAOt5T9yh_vGRn2-BkPDmjfze~AyTxY2Fs9Nw6ADEk-edYyZIyGIzxVAI_v-Mci1S-KeyRhbZOG3-4kWVpYqSxJK-2Uls-j_GSHh9L7Ku_zZta-MDu2NCA1Rg"}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_registrants:read","zoom_events_registrants:read:admin","zoom_events:read:list_registrants","zoom_events:read:list_registrants:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_registrants:read","zoom_events_registrants:read:admin"],"x-granular-scopes":["zoom_events:read:list_registrants","zoom_events:read:list_registrants:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/attendees":{"get":{"tags":["Registrants"],"summary":"List session attendees","description":"Retrieves session attendees.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_registrants:read`,`zoom_events_registrants:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_attendees`,`zoom_events:read:list_session_attendees:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSessionAttendeeList","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of requested session attendees.","content":{"application/json":{"schema":{"title":"List of attendees","type":"object","properties":{"total_records":{"type":"number","description":"The total number of attendees.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"attendees":{"maxItems":300,"type":"array","description":"Attendees","items":{"title":"Attendees","type":"object","properties":{"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication* `email_opt` registration using email OTP verification*  `zoom_account_otp_at_join` pre-registration using email OTP verification","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join"]}},"description":"The session attendee."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_registrants:read","zoom_events_registrants:read:admin","zoom_events:read:list_session_attendees","zoom_events:read:list_session_attendees:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_registrants:read","zoom_events_registrants:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_attendees","zoom_events:read:list_session_attendees:admin"]}}},"/zoom_events/events/{eventId}/reports/chat_transcripts":{"get":{"tags":["Reports"],"summary":"Get chat transcripts report","description":"Retrieves the chat transcripts report for an event.  \nAt present, this API returns data only for users who have enabled the [meeting and webinar cloud archiving feature](https://support.zoom.us/hc/en-us/articles/360061037572-Configuring-archival-settings-for-meetings-and-webinars).  \nThe meeting and webinar cloud archiving feature determines whether users can download in-meeting, private 1:1, and private group chats.  \n Below, chat-type data is returned based on the event type and the archiving feature.  \n  * `If cloud archiving is enabled`:  \n **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat, Private 1: 1 Chat, Private Group Chat, In-meeting and webinar Chat .  \n  **For single session & recurring events** - In-meeting or webinar chat.  \n  * `If cloud archiving is not enabled`  :\n **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat.  \n  **For single session & recurring events** - None. \n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:chat_transcripts`,`zoom_events:read:chat_transcripts:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"ChatTranscriptsReport","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a set of large results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"Chat transcription.","content":{"application/json":{"schema":{"title":"List of Chat Transcripts","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the response.","example":1},"next_page_token":{"type":"string","description":"Use the next page token to paginate through a set of large results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"chat_transcripts":{"maxItems":300,"type":"array","description":"The chat transcripts array.","items":{"title":"Chat Transcripts","type":"object","properties":{"chat_type":{"type":"string","description":"The type of the chat. \n * `Lobby Chat` \n *  `Private Lobby Chat` \n *  `Event Staff Chat` \n * `Exhibitor Chat` \n * `Expo Booth Chat` \n * `Private 1:1 Chat` \n * `Private Group Chat` \n * `In-meeting/webinar Chat`","example":"Lobby Chat","enum":["Lobby Chat","Private Lobby Chat","Event Staff Chat","Exhibitor Chat","Expo Booth Chat","Private 1:1 Chat","Private Group Chat","In-meeting/webinar Chat"]},"chat_name":{"type":"string","description":"The name of the chat.","example":"Lobby Chat - 1"},"sender":{"type":"string","description":"The name of the message sender.","example":"James Brown"},"sender_email":{"type":"string","description":"The email of the message sender.","example":"james.brown@zoomtest.us"},"message_time":{"type":"string","description":"The message sent time in UTC time. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","example":"2023-08-22T02:58:56Z"},"message":{"type":"string","description":"The content of the message.","example":"Hi, How are you doing?"},"reset_time":{"type":"string","description":"The chat reset time in UTC time. A host can reset/clear the chat. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","example":"2023-08-22T02:58:56Z"},"reset_by_whom":{"type":"string","description":"The name of the user who did the chat reset. A host can reset/clear the chat.","example":"Tom Brown"},"chat_channel_id":{"type":"string","description":"Chat channel ID ","example":"asfasdfasdf12312"},"message_id":{"type":"string","description":"Message ID: Unique Identifier of the chat message.","example":"d1231241sfdsdfs"}},"description":"The chat transcripts."}}},"description":"The chat transcripts array."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `5001` <br>\n Chat messages are not available for download now. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:chat_transcripts","zoom_events:read:chat_transcripts:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:chat_transcripts","zoom_events:read:chat_transcripts:admin"]}}},"/zoom_events/events/{eventId}/reports/custom_reports/{customReportId}":{"get":{"tags":["Reports"],"summary":"Get custom report","description":"Retrieves data for the custom report for the given report ID.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:custom_report`,`zoom_events:read:custom_report:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"getCustomEventReport","parameters":[{"name":"eventId","in":"path","description":"The event ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"customReportId","in":"path","description":"The custom report ID. The ID is available to copy from the Zoom Events UI, under the edit custom report definition page.","required":true,"schema":{"type":"string","example":"AbqLPC6hSFiZ9NpgjA549k"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`<br>\n List of requested event registration details.","content":{"application/json":{"schema":{"title":"List of Registrations","type":"object","properties":{"total_records":{"type":"integer","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"registrants":{"maxItems":300,"type":"array","description":"Registrants array.","items":{"title":"Registrants","type":"object","properties":{"display_name":{"type":"string","description":"The registrant display name.","example":"First Last"},"first_name":{"type":"string","description":"The registrant first name.","example":"First"},"last_name":{"type":"string","description":"The registrant last name.","example":"Last"},"email":{"type":"string","description":"The email address of the registrant.","example":"email@zoom.us"},"opt_in_marketing":{"type":"integer","description":"The marketing opt in flag. \n * `1. Opted for marketing`  \n *  `0 - Not opted for marketing` ","example":1,"enum":[1,0]},"registration_date":{"type":"string","description":"The registrantion date in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2025-03-24T22:30:00Z"},"event_attendance":{"type":"string","description":"The registrant's event attendance (Live or lobby) status. \n * `attended - Attended`  \n *  `absent - Not attended `","example":"attended","enum":["attended","absent"]},"country":{"type":"string","description":"The country/region of the attendee.","example":"US"},"lobby_attendance":{"type":"string","description":"The registrant's lobby attendance status. \n * `attended - Attended`  \n *  `absent - Not attended `","example":"attended","enum":["attended","absent"]},"surveys_count":{"type":"integer","description":"The total number of surveys taken.","example":0},"polls_count":{"type":"integer","description":"The total number of polls taken.","example":0},"resource_link_engagement":{"maxItems":200,"type":"array","description":"The call to action (CTA) resource link engagement details.","items":{"title":"CallToActionDetails","type":"object","properties":{"file_id":{"type":"string","description":"The CTA resource ID.","example":"Pn9rBZgJQzi6RXUABmWcqB"},"name":{"type":"string","description":"The CTA resource name.","example":"resource link A"}}}},"sessions":{"maxItems":200,"type":"array","description":"The user's session engagement details.","items":{"title":"SessionEngagement","type":"object","properties":{"session_id":{"type":"string","description":"The session ID.","example":"Pn9rBZgJQzi6RXUABmWcqB"},"session_name":{"type":"string","description":"The session name.","example":"Session one"},"session_attendance":{"type":"string","description":"The session attendance status. \n * attended \n * absent","example":"attended","enum":["absent","attended"]},"duration_in_session":{"type":"number","description":"The number of minutes spent in the session.","example":20},"bookmarked":{"type":"boolean","description":"The session bookmarked status. \n * true \n * false","example":true},"material_download":{"maxItems":200,"type":"array","description":"The session materials downloaded from the event lobby.","items":{"title":"MaterialDownload","type":"object","properties":{"file_id":{"type":"string","description":"The material fileID.","example":"Pn9rBZgJQzi6RXUABmWcqB"},"name":{"type":"string","description":"The material file name.","example":"session-file.pdf"}}}},"in_session_resource_download":{"maxItems":200,"type":"array","description":"The resources downloaded during the session, under resources.","items":{"title":"ResourceDownload","type":"object","properties":{"file_id":{"type":"string","description":"The resource fileID.","example":"Pn9rBZgJQzi6RXUABmWcqB"},"name":{"type":"string","description":"The resource file name.","example":"in-session-file.pdf"}}}},"recording_view":{"type":"boolean","description":"The recording view status. \n * true \n * false","example":false},"recording_view_duration":{"type":"number","description":"The recording view duration in minutes.","example":20},"live_streaming_view":{"type":"boolean","description":"The live stream view status. \n * true \n * false","example":false},"live_streaming_view_duration":{"type":"number","description":"The live streaming view duration in minutes.","example":30}},"description":"The session attendance information."}},"tickets":{"maxItems":50,"type":"array","description":"The ticket details.","items":{"title":"ticket","type":"object","properties":{"ticket_type_name":{"type":"string","description":"The ticket type name.","example":"General Ticket"},"ticket_type_id":{"type":"string","description":"The ticket type ID.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"ticket_id":{"type":"string","description":"The ticket ID.","example":"Fn2rBZgJQzi6VIUABuWcqB"},"registration_source":{"type":"string","description":"The source of registration or the source tracking information.","example":"Pardot"},"registration_method":{"type":"string","description":"The registration method. \n * `self-registration`  self registration with email \n * `self-registration_account` self registration with zoom account \n `pre_registration` Host pre-registration \n * `group_join_link` Registration with group join link \n * `Other` ","example":"self-registration","enum":["self-registration","self-registration_account","pre_registration","group_join_link","other"]},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication* `email_opt` registration using email OTP verification*  `zoom_account_otp_at_join` pre-registration using email OTP verification","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join"]},"questions":{"maxItems":200,"type":"array","description":"The question and answer array.","items":{"title":"TicketQuestionAnswers","type":"object","properties":{"title":{"type":"string","description":"The question title.","example":"First Name"},"answer":{"type":"string","description":"The question answer.","example":"Michael"}},"description":"The ticket registration's questions and answers."}}},"description":"The ticket registrations."}}},"description":"The registrants engagement details."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `260801` <br>\n Custom report template not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests  For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:custom_report","zoom_events:read:custom_report:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:custom_report","zoom_events:read:custom_report:admin"]}}},"/zoom_events/events/{eventId}/reports/event_attendance":{"get":{"tags":["Reports"],"summary":"Get event attendance (Live or Lobby) report","description":"Retrieves the event attendance (live or lobby) report for the event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event_attendance`,`zoom_events:read:event_attendance:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"EventAttendanceReport","parameters":[{"name":"eventId","in":"path","description":"The event's ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"from","in":"query","description":"The from parameter filters data records modified on or after the specified date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-24T22:30:00Z"}},{"name":"to","in":"query","description":"The to parameter filters data records modified on or before the specified date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-24T22:30:00Z"}},{"name":"role_type","in":"query","description":"The role type used to fetch data based on the ticket role.\n* `all` - All attendees and special role tickets. By default, the response contains both special and general tickets.\n* `attendee` - Only attendees will be returned in the response.","required":false,"schema":{"type":"string","example":"all","enum":["all","attendee"]}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`<br>\n List of requested event attendees.","content":{"application/json":{"schema":{"title":"List of Registrations","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"attendees":{"maxItems":300,"type":"array","description":"Attendee array.","items":{"title":"Registrations","type":"object","properties":{"display_name":{"type":"string","description":"The registrant's display name.","example":"First Last"},"first_name":{"type":"string","description":"The registrant's first name.","example":"First"},"last_name":{"type":"string","description":"The registrant's last name.","example":"Last"},"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"opt_in_marketing":{"type":"number","description":"The marketing opt-in flag.\n* `1` - Opted for marketing\n* `0` - Not opted for marketing","example":1,"enum":[1,0]},"marketing_consent_prechecked":{"type":"number","description":"Whether the marketing consent is pre-checked.\n* `1` - Pre-checked\n* `0` - Not pre-checked\n* `-1` - Not available","example":1,"enum":[1,0,-1]},"event_attendance":{"type":"string","description":"The registrant's event attendance (live or lobby) status.\n* `attended` - Attended\n* `absent` - Not attended","example":"attended","enum":["attended","absent"]},"attendance_type":{"maxItems":50,"type":"array","description":"The attendee's attendance type array.","items":{"type":"string","description":"The registrant's attendance type.\n* `hybrid` - Hybrid attendance\n* `virtual` - Virtual attendance\n* `in_person` - In-person attendance","example":"hybrid","enum":["hybrid","virtual","in_person"]}},"lobby_attendance":{"type":"string","description":"The registrant's lobby attendance status.\n* `attended` - Attended\n* `absent` - Not attended","example":"attended","enum":["attended","absent"]},"lobby_chat_sent":{"type":"number","description":"The number of lobby chat messages sent.","example":2},"survey_taken":{"type":"number","description":"The number of surveys taken.","example":0},"total_sessions_joined":{"type":"number","description":"The total number of sessions joined.","example":0},"number_of_tickets":{"type":"number","description":"The total number of tickets.","example":0},"role":{"type":"string","description":"The attendee's role.","example":"General"},"tickets":{"maxItems":50,"type":"array","description":"The attendee's tickets.","items":{"title":"ticket","type":"object","properties":{"ticket_type_name":{"type":"string","description":"The ticket type's name.","example":"General Ticket"},"ticket_type_id":{"type":"string","description":"The ticket type's identifier.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"external_ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"ticket_id":{"type":"string","description":"The ticket's identifier.","example":"Fn2rBZgJQzi6VIUABuWcqB"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket:\n* `zoom_account` - Zoom account holder\n* `zoom_account_otp` - Zoom account holder with OTP\n* `corporate_idp` - Corporate IDP\n* `no_auth` - No authentication\n* `email_opt` - Registration using email OTP verification\n* `zoom_account_otp_at_join` - Pre-registration using email OTP verification\n* `fast_join` - Fast join without upfront authentication\n* `vanity_url` - Join with vanity URL","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join","fast_join","vanity_url"]},"questions":{"maxItems":200,"type":"array","description":"The question and answer array.","items":{"title":"TicketQuestionAnswers","type":"object","properties":{"title":{"type":"string","description":"The question title.","example":"First Name"},"answer":{"type":"string","description":"The question answer.","example":"Michael"}},"description":"The ticket registration's questions and answers."}}},"description":"The ticket's registrations."}},"session_attendance":{"maxItems":200,"type":"array","description":"The user session attendance status array.","items":{"title":"SessionAttendance","type":"object","properties":{"session_id":{"type":"string","description":"The session identifier.","example":"Pn9rBZgJQzi6RXUABmWcqB"},"session_name":{"type":"string","description":"The session name.","example":"Session one"},"session_attendance":{"type":"string","description":"The session attendance status.\n* `attended` - Attended\n* `absent` - Absent","example":"attended","enum":["absent","attended"]},"duration_spent_in_session":{"type":"number","description":"The number of minutes spent in the session.","example":20},"chat_messages_sent":{"type":"number","description":"The number of chat messages sent.","example":20},"material_download":{"type":"boolean","description":"The material download status.\n* `true` - Downloaded\n* `false` - Not downloaded","example":true},"recording_view":{"type":"boolean","description":"The recording view status.\n* `true` - Viewed\n* `false` - Not viewed","example":false},"live_streaming_view":{"type":"boolean","description":"The live stream view status.\n* `true` - Viewed\n* `false` - Not viewed","example":false},"recording_view_duration":{"type":"number","description":"The recording view duration in minutes.","example":20},"live_streaming_view_duration":{"type":"number","description":"The live streaming view duration in minutes.","example":30},"session_join_time":{"type":"string","description":"The participant's join time for the session.","format":"date-time","example":"2022-03-24T22:30:00Z"},"session_exit_time":{"type":"string","description":"The participant's exit time from the session.","format":"date-time","example":"2022-03-24T22:30:00Z"},"session_reserved":{"type":"boolean","description":"Whether the user reserved the session.\n* `true` - Reserved\n* `false` - Not reserved","example":false},"session_bookmarked":{"type":"boolean","description":"Whether the user bookmarked the session.\n* `true` - Bookmarked\n* `false` - Not bookmarked","example":false}},"description":"The session attendance information."}},"profile_created":{"type":"boolean","description":"Whether the attendee profile was created.\n* `true` - Created\n* `false` - Not created","example":false},"personal_chats":{"type":"number","description":"The number of personal chats.","example":0},"connection_made":{"type":"number","description":"The number of networking connections made.","example":20},"last_modified_date":{"type":"string","description":"The last modified date of the attendee report data.","format":"date-time","example":"2025-08-24T22:30:00Z"}},"description":"The ticket registrations."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:event_attendance","zoom_events:read:event_attendance:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:event_attendance","zoom_events:read:event_attendance:admin"]}}},"/zoom_events/events/{eventId}/reports/sessions/{sessionId}/attendance":{"get":{"tags":["Reports"],"summary":"Get session attendance report","description":"Retrieves a session attendance report.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_attendance`,`zoom_events:read:session_attendance:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"SessionAttendanceReport","parameters":[{"name":"eventId","in":"path","description":"The event's ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The session's ID.","required":true,"schema":{"type":"string","example":"mNqLPC6hSFiA9NpgjA549y"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`<br>\n List of requested session attendees.","content":{"application/json":{"schema":{"title":"List of Attendees","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"attendees":{"maxItems":300,"type":"array","description":"Attendee array.","items":{"title":"Attendees","type":"object","properties":{"session_id":{"type":"string","description":"The Session ID.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"},"first_name":{"type":"string","description":"The attendee's first name.","example":"First"},"last_name":{"type":"string","description":"The attendee's last name.","example":"Last"},"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"display_name":{"type":"string","description":"The attendee's display name.","example":"First Last"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication* `email_opt` registration using email OTP verification*  `zoom_account_otp_at_join` pre-registration using email OTP verification","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join"]},"marketing_consent_prechecked":{"type":"number","description":"Whether the marketing consent is pre-checked. \n * `1 - pre-checked`  \n *  `0 - Not pre-checked `\n *  `-1 - Not available `","example":1,"enum":[1,0,-1]},"opt_in_marketing":{"type":"number","description":"The marketing opt-in flag. \n * `1. Opted for marketing`  \n *  `0 - Not opted for marketing` ","example":1,"enum":[1,0]},"check_in_method":{"type":"string","description":"The Check-in Method for the session","enum":["self check-in (virtual)","api","manual","host_manual","ebadge_scanning","virtual"]},"attendance_type":{"type":"string","description":"The event attendance type","enum":["hybrid","virtual","qr_code_scan"]},"session_attendance":{"type":"string","description":"The user attended the session or not","enum":["yes","no"]},"start_time":{"type":"string","description":"The user session joined time","format":"date-time","example":"2024-07-28T13:00:00Z"},"end_time":{"type":"string","description":"The user session joined time","format":"date-time","example":"2024-07-28T13:00:00Z"},"duration_spent_in_session":{"type":"number","description":"The number of minutes spent in the session.","example":20},"chat_messages_sent":{"type":"number","description":"The number of chat messages sent.","example":20},"material_download":{"type":"boolean","description":"The material downloaded status. \n * true \n * false","example":true},"recording_view":{"type":"boolean","description":"The recording view status. \n * true \n * false","example":false},"live_streaming_view":{"type":"boolean","description":"The live stream view status. \n * true \n * false","example":false},"recording_view_duration":{"type":"number","description":"The recording view duration in minutes.","example":20},"live_streaming_view_duration":{"type":"number","description":"The live streaming view duration in minutes.","example":30},"role_name":{"type":"string","description":"The attendee's role.","example":"General"},"tickets":{"maxItems":50,"type":"array","description":"The attendee's tickets.","items":{"title":"ticket","type":"object","properties":{"ticket_type_name":{"type":"string","description":"The ticket type's name.","example":"General Ticket"},"ticket_id":{"type":"string","description":"The ticket's identifier.","example":"Fn2rBZgJQzi6VIUABuWcqB"},"questions":{"maxItems":200,"type":"array","description":"The question and answer array.","items":{"title":"TicketQuestionAnswers","type":"object","properties":{"title":{"type":"string","description":"The question title.","example":"First Name"},"answer":{"type":"string","description":"The question answer.","example":"Michael"}},"description":"The ticket registration's questions and answers."}}},"description":"The ticket's registrations."}}},"description":"The ticket registrations."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:session_attendance","zoom_events:read:session_attendance:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:session_attendance","zoom_events:read:session_attendance:admin"]}}},"/zoom_events/events/{eventId}/reports/survey":{"get":{"tags":["Reports"],"summary":"Get event survey report","description":"Retrieve event and session survey information.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_surveys`,`zoom_events:read:list_session_surveys:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"EventSurveyReportApi","parameters":[{"name":"eventId","in":"path","description":"The event's ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a set of large results. 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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` List of event survey information.","content":{"application/json":{"schema":{"title":"List of Survey records","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the current response.","example":1},"next_page_token":{"type":"string","description":"Use the next page token to paginate through a set of large results. 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.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"surveys":{"maxItems":300,"type":"array","description":"Survey responses","items":{"title":"Surveys","type":"object","properties":{"session_name":{"type":"string","description":"The name of the session - both session ID and session name is not present, these surveys questions belongs to event.","example":"Introduction"},"session_id":{"type":"string","description":"The ID of the session - both session ID and session name is not present, these surveys questions belongs to event.","example":"ZALMy1b8RRiK810bVL-wFg"},"email":{"type":"string","description":"The email address of the person who took the survey. The email will not show  if the survey taken as anonymous user.","example":"ZALMy1b8RRiK810bVL-wFg"},"question_and_answers":{"maxItems":200,"type":"array","description":"Question and answers array.","items":{"title":"question_and_answers","type":"object","properties":{"question":{"type":"string","description":"The question title.","example":"What is your favorite type of ice cream flavor?"},"answer":{"type":"string","description":"The survey answer.","example":"Chocolate"}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400 ` <br>\n Invalid `page_size` or `event_id/next_page_token`. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:list_session_surveys","zoom_events:read:list_session_surveys:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_surveys","zoom_events:read:list_session_surveys:admin"]}}},"/zoom_events/events/{eventId}/reports/ticket_registration":{"get":{"tags":["Reports"],"summary":"Get event registrations report","description":"Retrieves event ticket registrations.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event_registration`,`zoom_events:read:event_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"EventRegistrationsReport","parameters":[{"name":"eventId","in":"path","description":"The event's ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"from","in":"query","description":"The from parameter filters data records modified on or after the specified date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-24T22:30:00Z"}},{"name":"to","in":"query","description":"The to parameter filters data records modified on or before the specified date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-24T22:30:00Z"}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a set of large results. A next page token is returned whenever the set of available results exceeds in the current request. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`<br> List of event ticket registrations.","content":{"application/json":{"schema":{"title":"List of Registrations","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"next_page_token":{"type":"string","description":"Use the next page token to paginate through a set of large results. A next page token is returned whenever the set of available results exceeds in the current request. This token's expiration period is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"registrations":{"maxItems":300,"type":"array","description":"The event registrations.","items":{"title":"Registrations","type":"object","properties":{"display_name":{"type":"string","description":"The registrant's display name.","example":"First Last"},"first_name":{"type":"string","description":"The registrant's first name.","example":"First"},"last_name":{"type":"string","description":"The registrant's last name.","example":"Last"},"email":{"type":"string","description":"The email address of the attendee.","example":"email@zoom.us"},"opt_in_marketing":{"type":"number","description":"Marketing opt in. \n * `1. Opted for marketing`  \n *  `0 - Not opted for marketing` ","example":0,"enum":[1,0]},"marketing_consent_prechecked":{"type":"number","description":"The marketing opt in flag. \n * `1. Opted for marketing`  \n *  `0 - Not opted for marketing` \n `-1 not available` ","example":0,"enum":[1,0,-1]},"register_date":{"type":"string","description":"The registrant date in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ","format":"date-time","example":"2022-03-24T22:30:00Z"},"event_attendance":{"type":"string","description":"The registrant attendance status.\n * `attended - Attended`  \n *  `absent - Not attended `","example":"attended","enum":["attended","absent"]},"registered_session_ids":{"maxItems":100,"type":"array","description":"The session IDs for which the user has registered. ","items":{"type":"string","description":"The Session ID.","example":"UoARddSoTN2gPKIXxVPbCQ"}},"attendance_type":{"maxItems":50,"type":"array","description":"The registrant event attendance type.","items":{"type":"string","description":"The registrant attendance type. \n * hybrid|virtual|in_person ","example":"hybrid","enum":["hybrid","virtual","in_person"]}},"registration_method":{"type":"string","description":"The registration method. \n * `self-registration`  self registration with email \n * `self-registration_account` self registration with zoom account \n `pre_registration` Host pre-registration \n * `group_join_link` Registration with group join link \n * `Other` ","example":"Self-registration","enum":["self-registration","self-registration_account","pre_registration","group_join_link","other"]},"registration_source":{"type":"string","description":"The source of registration or the source tracking information.","example":"Pardot"},"tickets":{"maxItems":50,"type":"array","description":"The user tickets for the event.","items":{"title":"ticket","type":"object","properties":{"ticket_type_name":{"type":"string","description":"The ticket type name.","example":"General Ticket"},"ticket_type_id":{"type":"string","description":"The ticket type identifier.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"external_ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"ticket_id":{"type":"string","description":"The ticket identifier.","example":"Fn2rBZgJQzi6VIUABuWcqB"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` Zoom account holder \n  * `zoom_account_otp` Zoom account holder with OTP \n * `corporate_idp` Corporate IDP \n * `no_auth` No authentication \n * `email_opt` registration using email OTP verification \n *  `zoom_account_otp_at_join` pre-registration using email OTP verification\n * `fast_Join` Fast join without upfront authentication\n *  `vanity_url` join with vanity url","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join","fast_join","vanity_url"]},"questions":{"maxItems":200,"type":"array","description":"The user provided question and answers provided at the time of registration.","items":{"title":"TicketQuestionAnswers","type":"object","properties":{"title":{"type":"string","description":"The question title.","example":"First Name"},"answer":{"type":"string","description":"The question answer.","example":"Michael"}},"description":"The ticket registration questions and answers."}}},"description":"The ticket registrations."}}},"description":"The ticket registrations."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_reports:read","zoom_events_reports:read:admin","zoom_events:read:event_registration","zoom_events:read:event_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_reports:read","zoom_events_reports:read:admin"],"x-granular-scopes":["zoom_events:read:event_registration","zoom_events:read:event_registration:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/reports/registrations":{"get":{"tags":["Reports"],"summary":"Get VOD channel registration report","description":"Retrieves VOD channel registrations and view duration information.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_reports:read`,`zoom_events_vod_reports:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registrations`,`zoom_events:read:vod_registrations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"VodChannelReigistration","parameters":[{"name":"hubId","in":"path","description":"The hub ID of the channel.","required":true,"schema":{"type":"string","example":"9fJX3j676LW7wXyzdsf"}},{"name":"channelId","in":"path","description":"The channel ID.","required":true,"schema":{"type":"string","example":"TAfJX3j676LW7w3dokm"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a set of large results. 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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` List of event survey information.","content":{"application/json":{"schema":{"title":"List of channel registrant records","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in the current response.","example":1},"next_page_token":{"type":"string","description":"Use the next page token to paginate through a set of large results. 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.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"registrations":{"maxItems":300,"type":"array","description":"The VOD channel registrations.","items":{"title":"registrations","type":"object","properties":{"email":{"type":"string","description":"The email address of the registrant.","example":"xyz@example.com"},"first_name":{"type":"string","description":"The registrant's first name.","example":"First"},"last_name":{"type":"string","description":"The registrant's last name.","example":"Last"},"video_watch_duration":{"maxItems":200,"type":"array","items":{"title":"Video watch duration","type":"object","properties":{"video_id":{"type":"string","description":"The registrant watched video ID.","example":"LVRGBTZXI6Kt7zv0g"},"video_name":{"type":"string","description":"The registrant watched video name.","example":"tutorial one"},"duration":{"type":"number","description":"The registrant watched video duration.","example":10}},"description":"The registrant watched video and duration."}},"authentication_method":{"type":"string","description":"The VOD channel authentication method \n * `zoom_account` Zoom account holder   * `no_auth` No authentication* `email_opt` registration using email OTP verification* ","example":"no_auth","enum":["zoom_account","email_opt","no_auth"]},"questions":{"maxItems":200,"type":"array","items":{"title":"Registrant question and answer","type":"object","properties":{"title":{"type":"string","description":"The question title.","example":"First Name"},"answer":{"type":"string","description":"The question answer.","example":"Michael"}},"description":"The ticket registration questions and answers."}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_reports:read","zoom_events_vod_reports:read:admin","zoom_events:read:vod_registrations","zoom_events:read:vod_registrations:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_reports:read","zoom_events_vod_reports:read:admin"],"x-granular-scopes":["zoom_events:read:vod_registrations","zoom_events:read:vod_registrations:admin"]}}},"/zoom_events/events/{eventId}/sessions":{"get":{"tags":["Sessions"],"summary":"List sessions","description":"Retrieves the sessions in an event. Event hosts and special-role ticket users, such as speakers and co-hosts, can access this API. Users will not need to provide any special query parameters. The API internally identifies based on the user role and provides the session information for the event. \n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_sessions`,`zoom_events:read:list_sessions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEventSessionList","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of requested sessions.","content":{"application/json":{"schema":{"title":"List of sessions","type":"object","properties":{"total_records":{"type":"number","description":"The total number of sessions.","example":1},"sessions":{"maxItems":200,"type":"array","description":"The list of sessions for the event.","items":{"title":"Event Session","description":"The information about the event session.","allOf":[{"type":"object","properties":{"timezone":{"type":"string","description":"The timezone of the event.","example":"America/New_York"},"type":{"type":"integer","description":"The type of session:\n * `0`- Meeting\n * `2`- Webinar\n * `4`- No webinar or meeting","format":"int32","example":2,"enum":[0,2,4]},"meeting_id":{"type":"integer","description":"The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) in **long** format(represented as int64 data type in JSON), also known as the meeting number. Applicable, if the session type is of meeting ( i.e type = 0). This id is null for an unpublished event.","format":"int64","example":97763643886},"webinar_id":{"type":"integer","description":"The webinar ID in **long** format(represented as int64 data type in JSON), also known as the webinar number. Applicable, if the session type is of webinar ( i.e type = 2). This id is null for an unpublished event.","format":"int64","example":97871060099}}},{"title":"Event Session","type":"object","properties":{"session_id":{"type":"string","description":"The ID of the session.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"name":{"type":"string","description":"The name of the session.","example":"Session 1"},"description":{"type":"string","description":"This is a description of the session.","example":"Educational Session on ZoomEvents"},"start_time":{"type":"string","description":"The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"end_time":{"type":"string","description":"The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"session_speakers":{"maxItems":200,"minItems":0,"type":"array","description":"The speakers join as attendees in a meeting session and as panelists in a webinar session.","items":{"title":"The session speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The ID of the session speaker.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_to_edit_session":{"type":"boolean","description":"Whether the speaker has access to edit the session information.","example":true},"show_in_session_detail":{"type":"boolean","description":"Whether to show the speaker information under session details.","example":true},"has_alternative_host_permission":{"type":"boolean","description":"Whether the speaker can act as an alternative host for the session.","example":true},"meeting_role":{"type":"integer","description":"The role of the speaker in a meeting:\n * `0` ALTERNATIVE_HOST\n * `1` ATTENDEE\n * `2` PANELIST\n","format":"int32","example":2,"enum":[0,1,2]},"name":{"type":"string","description":"The name of the speaker.","example":"Speaker-1"},"company":{"type":"string","description":"The company name of the speaker.","example":"Zoom"},"title":{"type":"string","description":"The job title of the speaker.","example":"Product Lead"}},"description":"The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session."}},"featured":{"type":"boolean","description":"Whether the session is featured.","example":true},"visible_in_landing_page":{"type":"boolean","description":"Whether the session is visible in landing page.","example":true},"featured_in_lobby":{"type":"boolean","description":"Whether the session is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the session is visible in event lobby.","example":true},"is_simulive":{"type":"boolean","description":"Whether the webinar is `simulive`.","example":true},"record_file_id":{"type":"string","description":"The previously recorded file's ID for `simulive`.","example":"f09340e1-cdc3-4eae-9a74-98f9777ed908"},"chat_channel":{"type":"boolean","description":"Whether session chat in lobby is enabled.\nAttendees need to have Zoom Chat enabled by their Account Admin to view and participate in the conference chat.","example":true},"led_by_sponsor":{"type":"boolean","description":"Whether the session is led by a sponsor.","example":false},"track_labels":{"maxItems":200,"type":"array","description":"The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions.","items":{"type":"string","example":"Technical Track"}},"audience_labels":{"maxItems":200,"type":"array","description":"The list of audience type tags for the session.","items":{"type":"string","example":"Family"}},"product_labels":{"maxItems":200,"type":"array","description":"The list of product type tags for the session.","items":{"type":"string","example":"zoomMeeting"}},"level":{"maxItems":50,"type":"array","description":"The list of level type tags for the session.","items":{"type":"string","example":"Level-1"}},"alternative_host":{"maxItems":50,"type":"array","description":"The list of alternative hosts. Alternative hosts can start the session on the host&rsquo;s behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.","items":{"type":"string","description":"The email address of the alternative host.","example":"abc.cd@email.com"}},"panelist":{"maxItems":50,"type":"array","description":"The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session.\n Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers.","items":{"type":"string","description":"The email address of the panelist.","example":"abc.cd@email.com"}},"interpreter_languages":{"maxItems":200,"type":"array","description":"The languages available for interpretations.","items":{"title":"Interpretation Context","type":"object","properties":{"language_id":{"type":"string","description":"The language ID for translation.","example":"EN"},"language_display_name":{"type":"string","description":"The name of the language.","example":"English"}}}},"sign_interpreter_languages":{"maxItems":200,"type":"array","description":"The available sign interpretation languages.","items":{"title":"Interpretation Context","type":"object","properties":{"language_id":{"type":"string","description":"The language ID for translation.","example":"EN"},"language_display_name":{"type":"string","description":"The name of the language.","example":"English"}}}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for Hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001"},"session_reservation":{"type":"object","properties":{"allow_reservations":{"type":"boolean","description":"Whether the session reservations are enabled. This option is supported for multi-session type events only.","example":true},"max_capacity":{"type":"integer","description":"The maximum number of session reservations allowed.","example":20}},"description":"Information about the session reservation option. This option is supported for multi-session type events only."}},"description":"The information about the event session."}]}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:list_sessions","zoom_events:read:list_sessions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:list_sessions","zoom_events:read:list_sessions:admin"]}},"post":{"tags":["Sessions"],"summary":"Create a session","description":"Creates a session. This operation is not available for a single session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:session`,`zoom_events:write:session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createEventSession","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Session","required":["end_time","name","start_time","timezone","type"],"type":"object","properties":{"name":{"type":"string","description":"The name of the session.","example":"Session 1"},"description":{"type":"string","description":"This is a description of the session. This field does not support the richtext description field in the UI.","example":"Educational Session on ZoomEvents"},"start_time":{"type":"string","description":"The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-05-31T13:00:00Z"},"end_time":{"type":"string","description":"The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.","format":"date-time","example":"2022-05-31T13:00:00Z"},"timezone":{"type":"string","description":"The timezone of the event.  \n For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).","example":"America/New_York"},"type":{"type":"integer","description":"The type of session:\n *`0`- Meeting.\n *`2`- Webinar.\n *`4`- No webinar or meeting.","format":"int32","example":2,"enum":[0,2,4]},"session_speakers":{"maxItems":200,"minItems":0,"type":"array","description":"The speakers joins a session as an attendee in a meeting session and as panelists in a webinar session.","items":{"title":"The session speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The ID of the session speaker.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_to_edit_session":{"type":"boolean","description":"Whether the speaker has access to edit the session information.","example":true},"show_in_session_detail":{"type":"boolean","description":"Whether to show the speaker information under session details.","example":true},"has_alternative_host_permission":{"type":"boolean","description":"Whether the speaker can act as an alternative host for the session.","example":true}},"description":"The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session."}},"featured":{"type":"boolean","description":"Whether the session is featured.","example":true},"visible_in_landing_page":{"type":"boolean","description":"Whether the session is visible in landing page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the session is marked as featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the session is visible in event lobby.","example":true,"default":true},"is_simulive":{"type":"boolean","description":"Whether the webinar is `simulive`.","example":true},"record_file_id":{"type":"string","description":"The previously recorded file's ID for `simulive`.","example":"f09340e1-cdc3-4eae-9a74-98f9777ed908"},"chat_channel":{"type":"boolean","description":"Whether the session chat in the lobby is enabled.\n*Attendees need to have Zoom Chat enabled by their account admin to view and participate in the conference chat.","example":true},"led_by_sponsor":{"type":"boolean","description":"Whether the session is hosted by a sponsor.","example":false},"track_labels":{"maxItems":200,"type":"array","description":"The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions.","items":{"type":"string","example":"Technical Track"}},"audience_labels":{"maxItems":200,"type":"array","description":"The list of audience type tags for the session.","items":{"type":"string","example":"Family"}},"product_labels":{"maxItems":200,"type":"array","description":"The list of product type tags for the session.","items":{"type":"string","example":"zoomMeeting"}},"level":{"maxItems":50,"type":"array","description":"The list of level type tags for the session.","items":{"type":"string","example":"Level-1"}},"alternative_host":{"maxItems":50,"type":"array","description":"The list of alternative hosts. Alternative hosts can start the session on the hosts behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.","items":{"type":"string","description":"The email address of the alternative host.","example":"abc.cd@email.com"}},"panelist":{"maxItems":50,"type":"array","description":"The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session.\n Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers.","items":{"type":"string","description":"The email address of the panelist.","example":"abc.cd@email.com"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `Virtual` &mdash; virtual attendees only. \n * `In-person` &mdash; in-person attendees only. \n * `Hybrid` &mdash; both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001"},"session_reservation":{"type":"object","properties":{"allow_reservations":{"type":"boolean","description":"Whether the session reservations are enabled. This option is supported for multi-session type events only.","example":true},"max_capacity":{"type":"integer","description":"The maximum number of session reservations allowed.","example":20}},"description":"Information about the session reservation option. This option is supported for multi-session type events only."}},"description":"The information about the event session."}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nSession created successfully.","content":{"application/json":{"schema":{"title":"Event Session","description":"The information about the event session.","allOf":[{"type":"object","properties":{"timezone":{"type":"string","description":"The timezone of the event.","example":"America/New_York"},"type":{"type":"integer","description":"The type of session:\nEnum:\n * `0` - Meeting.\n * `2`- Webinar.\n * `4` No webinar or meeting","format":"int32","example":2,"enum":[0,2,4]}}},{"title":"Event Session","type":"object","properties":{"session_id":{"type":"string","description":"The ID of the session.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"name":{"type":"string","description":"The name of the session.","example":"Session 1"},"description":{"type":"string","description":"The description of the session.This is a description of the session. This field does NOT support the Richtext Description field in the UI.","example":"Educational Session on ZoomEvents"},"start_time":{"type":"string","description":"The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"end_time":{"type":"string","description":"The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"session_speakers":{"maxItems":50,"minItems":0,"type":"array","description":"The speakers join as attendees in a meeting session and as panelists in a webinar session.","items":{"title":"The session speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The ID of the session speaker.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_to_edit_session":{"type":"boolean","description":"Whether the speaker has access to edit the session information.","example":true},"show_in_session_detail":{"type":"boolean","description":"Whether to show the speaker information under session details.","example":true},"has_alternative_host_permission":{"type":"boolean","description":"Whether the speaker can act as an alternative host for the session.","example":true},"meeting_role":{"type":"integer","description":"The role of the speaker in a meeting:\nEnum:\n * `0` ALTERNATIVE_HOST\n * `1` ATTENDEE\n * `2` PANELIST\n","format":"int32","example":2,"enum":[0,1,2]},"name":{"type":"string","description":"The name of the speaker.","example":"Speaker-1"},"company":{"type":"string","description":"The company name of the speaker.","example":"Zoom"},"title":{"type":"string","description":"The job title of the speaker.","example":"Product Lead"}},"description":"The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session."}},"featured":{"type":"boolean","description":"Whether the session is featured.","example":true},"visible_in_landing_page":{"type":"boolean","description":"Whether the session is visible in the landing page.","example":true},"featured_in_lobby":{"type":"boolean","description":"Whether the session is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the session is visible in event lobby.","example":true},"is_simulive":{"type":"boolean","description":"Whether the webinar is `simulive`.","example":true},"record_file_id":{"type":"string","description":"The previously recorded file's ID for `simulive`.","example":"f09340e1-cdc3-4eae-9a74-98f9777ed908"},"chat_channel":{"type":"boolean","description":"Whether session chat in lobby is enabled.\nAttendees need to have Zoom Chat enabled by their Account Admin to view and participate in the conference chat.","example":true},"led_by_sponsor":{"type":"boolean","description":"Whether the session is led by a sponsor.","example":false},"track_labels":{"maxItems":200,"type":"array","description":"The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions.","items":{"type":"string","example":"Technical Track"}},"audience_labels":{"maxItems":200,"type":"array","description":"The list of audience type tags for the session.","items":{"type":"string","example":"Family"}},"product_labels":{"maxItems":200,"type":"array","description":"The list of product type tags for the session.","items":{"type":"string","example":"zoomMeeting"}},"level":{"maxItems":50,"type":"array","description":"The list of level type tags for the session.","items":{"type":"string","example":"Level-1"}},"alternative_host":{"maxItems":50,"type":"array","description":"The list of alternative hosts. Alternative hosts can start the session on the host&rsquo;s behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.","items":{"type":"string","description":"The email address of the alternative host.","example":"abc.cd@email.com"}},"panelist":{"maxItems":50,"type":"array","description":"The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session.\n Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers.","items":{"type":"string","description":"The email address of the panelist.","example":"abc.cd@email.com"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for Hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001"},"session_reservation":{"type":"object","properties":{"allow_reservations":{"type":"boolean","description":"Whether the session reservations are enabled. This option is supported for multi-session type events only.","example":true},"max_capacity":{"type":"integer","description":"The maximum number of session reservations allowed.","example":20}},"description":"Information about the session reservation option. This option is supported for multi-session type events only."}},"description":"The information about the event session."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26402` <br>\n One or more session IDs are invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write:admin","zoom_events_sessions:write","zoom_events:write:session","zoom_events:write:session:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write:admin","zoom_events_sessions:write"],"x-granular-scopes":["zoom_events:write:session","zoom_events:write:session:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}":{"get":{"tags":["Sessions"],"summary":"Get the session information","description":"Returns the session information.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session`,`zoom_events:read:session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEventSessionInfo","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Requested session details.","content":{"application/json":{"schema":{"title":"Event Session","description":"The information about the event session.","allOf":[{"type":"object","properties":{"timezone":{"type":"string","description":"The timezone of the event.","example":"America/New_York"},"type":{"type":"integer","description":"The type of session:\n * `0`- Meeting\n * `2`- Webinar.\n * `4`- No webinar or meeting.","format":"int32","example":2,"enum":[0,2,4]},"meeting_id":{"type":"integer","description":"The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) in **long** format (represented as int64 data type in JSON), also known as the meeting number. Applicable, if the session type is of meeting ( i.e type = 0). This ID is null for an unpublished event.","format":"int64","example":97763643886},"webinar_id":{"type":"integer","description":"The webinar ID in **long** format (represented as int64 data type in JSON), also known as the webinar number. \nApplicable, if the session type is of webinar ( i.e type = 2). This ID is null for an unpublished event.","format":"int64","example":97871060099}}},{"title":"Event Session","type":"object","properties":{"session_id":{"type":"string","description":"The ID of the session.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"name":{"type":"string","description":"The name of the session.","example":"Session 1"},"description":{"type":"string","description":"This is a description of the session.","example":"Educational Session on ZoomEvents"},"start_time":{"type":"string","description":"The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"end_time":{"type":"string","description":"The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"session_speakers":{"maxItems":200,"minItems":0,"type":"array","description":"The speakers join as attendees in a meeting session and as panelists in a webinar session.","items":{"title":"The session speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The ID of the session speaker.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_to_edit_session":{"type":"boolean","description":"Whether the speaker has access to edit the session information.","example":true},"show_in_session_detail":{"type":"boolean","description":"Whether to show the speaker information under session details.","example":true},"has_alternative_host_permission":{"type":"boolean","description":"Whether the speaker can act as an alternative host for the session.","example":true},"meeting_role":{"type":"integer","description":"The role of the speaker in a meeting:\n * `0` ALTERNATIVE_HOST\n * `1` ATTENDEE\n * `2` PANELIST\n","format":"int32","example":2,"enum":[0,1,2]},"name":{"type":"string","description":"The name of the speaker.","example":"Speaker-1"},"company":{"type":"string","description":"The company name of the speaker.","example":"Zoom"},"title":{"type":"string","description":"The job title of the speaker.","example":"Product Lead"}},"description":"The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session."}},"featured":{"type":"boolean","description":"Whether the session is featured.","example":true},"visible_in_landing_page":{"type":"boolean","description":"Whether the session is visible in the landing page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the session is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the session is visible in event lobby.","example":true,"default":true},"is_simulive":{"type":"boolean","description":"Whether the webinar is `simulive`.","example":true},"record_file_id":{"type":"string","description":"The previously recorded file's ID for `simulive`.","example":"f09340e1-cdc3-4eae-9a74-98f9777ed908"},"chat_channel":{"type":"boolean","description":"Whether session chat in lobby is enabled.\nAttendees need to have Zoom Chat enabled by their Account Admin to view and participate in the conference chat.","example":true},"led_by_sponsor":{"type":"boolean","description":"Whether the session is led by a sponsor.","example":false},"track_labels":{"maxItems":200,"type":"array","description":"The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions.","items":{"type":"string","example":"Technical Track"}},"audience_labels":{"maxItems":200,"type":"array","description":"The list of audience type tags for the session.","items":{"type":"string","example":"Family"}},"product_labels":{"maxItems":200,"type":"array","description":"The list of product type tags for the session.","items":{"type":"string","example":"zoomMeeting"}},"level":{"maxItems":50,"type":"array","description":"The list of level type tags for the session.","items":{"type":"string","example":"Level-1"}},"alternative_host":{"maxItems":50,"type":"array","description":"The list of alternative hosts. Alternative hosts can start the session on the host&rsquo;s behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.","items":{"type":"string","description":"The email address of the alternative host.","example":"abc.cd@email.com"}},"panelist":{"maxItems":50,"type":"array","description":"The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session.\n Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers.","items":{"type":"string","description":"The email address of the panelist.","example":"abc.cd@email.com"}},"interpreter_languages":{"maxItems":200,"type":"array","description":"The languages available for interpretations.","items":{"title":"Interpretation Context","type":"object","properties":{"language_id":{"type":"string","description":"The language ID for translation.","example":"EN"},"language_display_name":{"type":"string","description":"The name of the language.","example":"English"}}}},"sign_interpreter_languages":{"maxItems":200,"type":"array","description":"The sign interpretation languages that are available.","items":{"title":"Interpretation Context","type":"object","properties":{"language_id":{"type":"string","description":"The language ID for translation.","example":"EN"},"language_display_name":{"type":"string","description":"The name of the language.","example":"English"}}}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for Hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001"},"session_reservation":{"type":"object","properties":{"allow_reservations":{"type":"boolean","description":"Whether the session reservations are enabled. This option is supported for multi-session type events only.","example":true},"max_capacity":{"type":"integer","description":"The maximum number of session reservations allowed.","example":20}},"description":"Information about the session reservation option. This option is supported for multi-session type events only."}},"description":"The information about the event session."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:session","zoom_events:read:session:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:session","zoom_events:read:session:admin"]}},"delete":{"tags":["Sessions"],"summary":"Delete a session","description":"Deletes a session. Not allowed for a single session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:session`,`zoom_events:delete:session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteEventSession","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` Session deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:delete:session","zoom_events:delete:session:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:delete:session","zoom_events:delete:session:admin"]}},"patch":{"tags":["Sessions"],"summary":"Update a session","description":"Updates an existing session in an event. \n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session`,`zoom_events:update:session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateEventSession","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Session","type":"object","properties":{"name":{"type":"string","description":"The name of the session. In case of single session event type, it inherits the event's name.","example":"Session 1"},"description":{"type":"string","description":"This is a description of the session.This field does NOT support the Richtext Description field in the UI. Updating session description is only allowed for multi-session and recurring type event.","example":"Educational Session on ZoomEvents"},"start_time":{"type":"string","description":"The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`. In case of single session event type, It inherits the event's start time.","format":"date-time","example":"2022-05-31T13:00:00Z"},"end_time":{"type":"string","description":"The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`. In case of Single Session Event Type, It inherits the event's end time.","format":"date-time","example":"2022-05-31T13:00:00Z"},"type":{"type":"integer","description":"The type of session:\n * `0`- Meeting.\n * `2`- Webinar.\n * `4`- No webinar or meeting.","format":"int32","example":2,"enum":[0,2,4]},"session_speakers":{"maxItems":200,"minItems":0,"type":"array","description":"The speakers join as attendees in a meeting session and as panelists in a webinar session.","items":{"title":"The session speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The ID of the session speaker.","example":"4uzfv3JwTeyR5QpC3PXwMg"},"access_to_edit_session":{"type":"boolean","description":"Whether the speaker has access to edit the session information.","example":true},"show_in_session_detail":{"type":"boolean","description":"Whether to show the speaker information under the session details.","example":true},"has_alternative_host_permission":{"type":"boolean","description":"Whether the speaker can act as an alternative host for the session.","example":true}},"description":"The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session."}},"featured":{"type":"boolean","description":"Whether the session is featured. This is not applicable for single session event type.","example":true},"visible_in_landing_page":{"type":"boolean","description":"Whether the session is visible in the landing page. Session controls not supported for single session event type.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the session is featured in the event lobby. Session controls not supported for single session event type.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the session is visible in the event lobby. Session controls not supported for single session event type.","example":true,"default":true},"is_simulive":{"type":"boolean","description":"Whether the webinar is `simulive`.","example":false},"record_file_id":{"type":"string","description":"The previously recorded file's ID for `simulive`.","example":"f09340e1-cdc3-4eae-9a74-98f9777ed908"},"chat_channel":{"type":"boolean","description":"Whether session chat in lobby is enabled.\n*Attendees need to have Zoom Chat enabled by their account admin to view and participate in the conference chat. This is not applicable for single session event type.","example":true},"led_by_sponsor":{"type":"boolean","description":"Whether the session is hosted by a sponsor. This is not applicable for single session event type.","example":false},"track_labels":{"maxItems":200,"type":"array","description":"The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions. This is not applicable for single session event type.","items":{"type":"string","example":"Technical Track"}},"audience_labels":{"maxItems":200,"type":"array","description":"The list of audience type tags for the session. This is not applicable for single session event type.","items":{"type":"string","example":"Family"}},"product_labels":{"maxItems":200,"type":"array","description":"The list of product type tags for the session. This is not applicable for single session event type.","items":{"type":"string","example":"zoomMeeting"}},"level":{"maxItems":50,"type":"array","description":"The list of level type tags for the session. This is not applicable for single session event type.","items":{"type":"string","example":"Level-1"}},"alternative_host":{"maxItems":50,"type":"array","description":"The list of alternative hosts. Alternative hosts can start the session on the hosts behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.","items":{"type":"string","description":"The email address of the alternative host.","example":"abc.cd@email.com"}},"panelist":{"maxItems":50,"type":"array","description":"The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session.\n Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers. This is not applicable for single session event type.","items":{"type":"string","description":"The email address of the panelist.","example":"abc.cd@email.com"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event:\n * `Virtual` &mdash; virtual attendees only \n * `In-person` &mdash; in-person attendees only \n * `Hybrid` &mdash; both in-person and virtual attendees.  \n\n  *In case of single session event type, It inherits event's attendance type.","example":"hybrid","enum":["virtual","in-person","hybrid"]},"physical_location":{"type":"string","description":"The physical location of the event. This field is applicable for hybrid and in-person events only.","example":"801 Mt Vernon Pl NW, Washington, DC 20001"},"session_reservation":{"type":"object","properties":{"allow_reservations":{"type":"boolean","description":"Whether the session reservations are enabled. This option is supported for multi-session type events only.","example":true},"max_capacity":{"type":"integer","description":"The maximum number of session reservations allowed.","example":20}},"description":"Information about the session reservation option. This option is supported for multi-session type events only."}},"description":"The information about the event session."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSession updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n**Error Code:** `260209` <br>\n Event is not editable. <br>\n**Error Code:** `260210` <br>\n Past and cancelled events are not editable. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:update:session","zoom_events:update:session:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:update:session","zoom_events:update:session:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/interpreters":{"get":{"tags":["Sessions"],"summary":"List session interpreters","description":"Retrieves interpreters in a session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus /Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_interpreters`,`zoom_events:read:list_session_interpreters:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSessionInterpreterList","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of interpreters.","content":{"application/json":{"schema":{"title":"List of interpreters","type":"object","properties":{"total_records":{"type":"number","description":"The total number of interpreters.","example":1},"interpreters":{"maxItems":300,"type":"array","items":{"title":"Interpreter","type":"object","properties":{"email":{"type":"string","description":"The email address of the interpreter.","example":"abc.def@email.com"},"type":{"type":"integer","description":"The interpreter type:\nEnum:\n * `1` language_interpreter\n * `2` sign_language_interpreter\n","format":"int32","example":1,"enum":[1,2]},"source_language_id":{"allOf":[{"type":"string","description":"The language ID for translation. Valid for language_interpreter type:\nEnum:\n * `US` English \n * `CN` Chinese \n * `JP` Japanese \n * `DE` German \n * `FR` French \n * `RU` Russian \n * `PT` Portuguese \n * `ES` Spanish \n * `KR` Korean","example":"JP","enum":["US","CN","JP","DE","FR","RU","PT","ES","KR"]},{"example":"US"}]},"source_language_display_name":{"type":"string","description":"The name of the source language.","example":"English"},"target_language_id":{"oneOf":[{"allOf":[{"type":"string","description":"The language ID for translation. Valid for language_interpreter type:\nEnum:\n * `US` English \n * `CN` Chinese \n * `JP` Japanese \n * `DE` German \n * `FR` French \n * `RU` Russian \n * `PT` Portuguese \n * `ES` Spanish \n * `KR` Korean","example":"JP","enum":["US","CN","JP","DE","FR","RU","PT","ES","KR"]},{"example":"JP"}]},{"type":"string","description":"The ID for sign_language. Valid for sign_language_interpreter type:\nEnum:\n * `ASE` American Sign Language \n * `CSL` Chinese Sign Language \n * `FSL` French Sign Language \n * `GSG` German Sign Language \n * `JSL` Japanese Sign Language \n * `RSL` Russian Sign Language \n * `BZS` Brazilian Sign Language \n * `SSP` Spanish Sign Language \n * `MFS` Mexican Sign Language \n * `BFI` British Sign Language","example":"ASE","enum":["ASE","CSL","FSL","GSG","JSL","RSL","BZS","SSP","MFS","BFI"]}]},"target_language_display_name":{"allOf":[{"oneOf":[{"type":"string","description":"The name of the target language.","example":"Japanese"},{"type":"string","description":"The name of the sign language.","example":"American Sign Language"}]},{}]}},"description":"Information about the language interpreters."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2003` <br>\n Session not found. <br>\n**Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:list_session_interpreters","zoom_events:read:list_session_interpreters:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_interpreters","zoom_events:read:list_session_interpreters:admin"]}},"put":{"tags":["Sessions"],"summary":"Create or update session interpreters","description":"Creates or updates the list of interpreters for the session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_interpreter`,`zoom_events:update:session_interpreter:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateSessionInterpreters","parameters":[{"name":"eventId","in":"path","description":"The event's ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The session's ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"List of interpreters","type":"object","properties":{"interpreters":{"maxItems":300,"type":"array","items":{"title":"Interpreter","type":"object","properties":{"email":{"type":"string","description":"The email address of the interpreter.","example":"abc.def@example.com"},"type":{"type":"integer","description":"The interpreter type:\nEnum:\n * `1` language_interpreter\n * `2` sign_language_interpreter\n","format":"int32","example":1,"enum":[1,2]},"source_language_id":{"type":"string","description":"The language ID for translation. Valid for language_interpreter type:\nEnum:\n * `US` English \n * `CN` Chinese \n * `JP` Japanese \n * `DE` German \n * `FR` French \n * `RU` Russian \n * `PT` Portuguese \n * `ES` Spanish \n * `KR` Korean","example":"US","enum":["US","CN","JP","DE","FR","RU","PT","ES","KR"]},"target_language_id":{"oneOf":[{"type":"string","description":"The language ID for translation. Valid for language_interpreter type:\nEnum:\n * `US` English \n * `CN` Chinese \n * `JP` Japanese \n * `DE` German \n * `FR` French \n * `RU` Russian \n * `PT` Portuguese \n * `ES` Spanish \n * `KR` Korean","example":"JP","enum":["US","CN","JP","DE","FR","RU","PT","ES","KR"]},{"type":"string","description":"The ID for sign_language. Valid for sign_language_interpreter type:\nEnum:\n * `ASE` American Sign Language \n * `CSL` Chinese Sign Language \n * `FSL` French Sign Language \n * `GSG` German Sign Language \n * `JSL` Japanese Sign Language \n * `RSL` Russian Sign Language \n * `BZS` Brazilian Sign Language \n * `SSP` Spanish Sign Language \n * `MFS` Mexican Sign Language \n * `BFI` British Sign Language","example":"ASE","enum":["ASE","CSL","FSL","GSG","JSL","RSL","BZS","SSP","MFS","BFI"]}]}},"description":"Information about the language interpreters."}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nInterpreters updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:update:session_interpreter","zoom_events:update:session_interpreter:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:update:session_interpreter","zoom_events:update:session_interpreter:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/join_token":{"get":{"tags":["Sessions"],"summary":"Get ticket session join token by Event ID and Session ID","description":"Retrieves the join token to join an event session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_token`,`zoom_events:read:session_token:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSessionJoinToken","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n The join token for the session.","content":{"application/json":{"schema":{"title":"Join Token","type":"object","properties":{"code":{"type":"integer","description":"The join token error code:\nEnum:\n * `0` &mdash; SUCCESS\n * `1120` &mdash; BAD_REQUEST\n * `1130` &mdash; ERROR_TICKET_NOT_FOUND\n * `1140` &mdash; INTERNAL_SERVER_ERROR\n * `1150` &mdash; ERROR_CODE_TICKET_REVOKE\n","format":"int32","example":0,"enum":[0,1120,1130,1140,1150]},"error_message":{"type":"string","description":"The join token error message.","example":"success"},"join_token":{"type":"string","description":"The join token of the session.","example":"OIgzlUv99nloE1vFMFssJVZuhFSstmSNd_Pi4WEBUNy0hWK2L6TtrRWscn"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:session_token","zoom_events:read:session_token:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:session_token","zoom_events:read:session_token:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/livestream":{"get":{"tags":["Sessions"],"summary":"Get session livestream configuration","description":"List the livestream configuration for the given session. RTMP Incoming livestream will only work for webinar sessions (not meetings). Please check [RTMP livesteam](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0077038) for the feature details.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_livestream_config`,`zoom_events:read:session_livestream_config:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSessionLivestreamConfiguration","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n  Session livestream details.","content":{"application/json":{"schema":{"title":"Event Session Livestream","type":"object","properties":{"incoming_enabled":{"type":"boolean","description":"The incoming livestream enabled or not.","example":true},"incoming_config":{"title":"Incoming livestream configuration","type":"object","properties":{"stream_key_id":{"type":"string","description":"The stream key ID.","example":"YwG21kyxkyRO7SOkuwPf7S8B"},"stream_key_name":{"type":"string","description":"The stream key name.","example":"Stream key 2"},"stream_key_description":{"type":"string","description":"The stream key description.","example":"Stream key 2 description"},"stream_key_type":{"type":"string","description":"The type of stream key:\n * `SAVED`- Saved. A saved stream key can be re-used for different sessions scheduled for different times. \n * `GENERATED`- Generated key, specific to a session.","example":"SAVED","enum":["SAVED","GENERATED"]},"stream_key":{"type":"string","description":"The stream key.","example":"ZAEUMvRcI1eq_SRMg3iQBz-U"},"stream_url":{"type":"string","description":"The stream url.","example":"rtmp://10.100.125.159:1956/live"},"stream_backup_url":{"type":"string","description":"The stream backup url.","example":"rtmp://10.100.125.159:1976/live?backup=1"},"effective_time":{"type":"string","description":"The effective time of the stream key when it is valid,  in UTC. The format is `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"},"expiration_time":{"type":"string","description":"The expiration time of the stream key in UTC. After this time, the stream key doesn't work anymore. The format is `yyyy-MM-dd`T`HH:mm:ssZ`","format":"date-time","example":"2022-05-31T13:00:00Z"}},"description":"The incoming livestream configuration."}},"description":"Session livestream configuration."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:session_livestream_config","zoom_events:read:session_livestream_config:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:session_livestream_config","zoom_events:read:session_livestream_config:admin"]}},"patch":{"tags":["Sessions"],"summary":"Update session livestream configuration","description":"Update the livestream configuration for the given session. RTMP Incoming livestream will only work for webinar sessions (not meetings). Please check [RTMP livestream](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0077038) for the feature details.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_livestream_config`,`zoom_events:update:session_livestream_config:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateSessionLivestreamConfiguration","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Session Livestream","required":["incoming_enabled"],"type":"object","properties":{"incoming_enabled":{"type":"boolean","description":"The incoming livestream enabled or not. RTMP Incoming livestream will only work for webinar sessions (not meetings).","example":true},"incoming_config":{"title":"Incoming livestream configuration","type":"object","properties":{"stream_key_type":{"type":"string","description":"The type of stream key:\n * `GENERATED`- Generated key, specific to a session. If a generated key already exist for this sessionId, then it is reused. This is the only type supported as of now and this is a mandatory field when the incoming_enabled field is set to `true`.","example":"GENERATED","enum":["GENERATED"]}},"description":"The incoming livestream configuration."}},"description":"Session livestream configuration."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated the livestream configuration."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26303` <br>\n Incoming livestream is supported only for webinar meeting_type sessions. <br>\n**Error Code:** `26304` <br>\n Incoming livestream configuration is missing. <br>\n**Error Code:** `26305` <br>\n Incoming livestream key type is invalid. This type is not supported for update. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:update:session_livestream_config","zoom_events:update:session_livestream_config:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:update:session_livestream_config","zoom_events:update:session_livestream_config:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/polls":{"get":{"tags":["Sessions"],"summary":"List session polls","description":"List all the polls of a session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_polls`,`zoom_events:read:list_session_polls:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSessionPolls","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n List of polls returned.","content":{"application/json":{"schema":{"title":"List of polls","type":"object","properties":{"total_records":{"type":"number","description":"The total number of polls.","example":1},"polls":{"maxItems":300,"type":"array","items":{"title":"Session Polling Object","required":["anonymous","poll_type","title"],"type":"object","properties":{"id":{"type":"string","description":"Session Poll ID. Required for updating an existing poll.","example":"QalIoKWLTJehBJ8e1xRrbQ"},"status":{"type":"string","description":"Status of the Session Poll:  \n `active` - Poll is active   \n `inactive` - Poll is deactivated","example":"active","enum":["active","inactive"],"x-enum-descriptions":["Poll Active","Poll Inactive"]},"anonymous":{"type":"boolean","description":"Allow session participants to answer poll questions anonymously.","example":false},"poll_type":{"type":"integer","description":"The type of poll. \n* `1` &mdash; Basic Poll. Only single and multiple choice questions are allowed. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account.  \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account.","example":2,"enum":[1,2,3]},"questions":{"maxItems":30,"type":"array","description":"Information about the poll's questions.","items":{"required":["name","type"],"type":"object","properties":{"answer_max_character":{"type":"integer","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.","example":200},"answer_min_character":{"minimum":1,"type":"integer","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.","example":1},"answer_required":{"type":"boolean","description":"Whether participants must answer the question. \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; 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`.","example":false,"default":false},"answers":{"maxItems":20,"minItems":2,"type":"array","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.","items":{"type":"string","example":"Extremely useful"}},"case_sensitive":{"type":"boolean","description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`.","example":false,"default":false},"name":{"maxLength":255,"type":"string","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.","example":"How useful was this meeting?"},"prompts":{"maxItems":200,"type":"array","description":"Information about the prompt questions. The question prompt's title. 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.","items":{"type":"string","example":"How are you?"}},"prompt_right_answers":{"maxItems":200,"type":"array","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.","items":{"type":"string","example":"Good"}},"rating_max_label":{"type":"string","description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","example":"Extremely Likely"},"rating_max_value":{"maximum":10,"type":"integer","description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","example":4},"rating_min_label":{"type":"string","description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","example":"Not likely"},"rating_min_value":{"minimum":0,"type":"integer","description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","example":0},"right_answers":{"maxItems":200,"minItems":1,"type":"array","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.","items":{"type":"string","example":"Good"}},"show_as_dropdown":{"type":"boolean","description":"Whether to display the radio selection as a drop-down box. \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`.","example":false,"default":false},"type":{"type":"string","description":"The poll's question and answer type. \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale.","example":"single","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"]}}}},"title":{"maxLength":64,"type":"string","description":"The poll's title, up to 64 characters.","example":"Learn something new"}},"description":"Information about session polling."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:list_session_polls","zoom_events:read:list_session_polls:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_polls","zoom_events:read:list_session_polls:admin"]}},"put":{"tags":["Sessions"],"summary":"Create or update session polls","description":"Create or update the list of polls for the session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_poll`,`zoom_events:update:session_poll:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateSessionPolls","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"List of polls","type":"object","properties":{"polls":{"maxItems":300,"type":"array","items":{"title":"Session Polling Object","required":["anonymous","poll_type","title"],"type":"object","properties":{"id":{"type":"string","description":"Session Poll ID. Required for updating an existing poll.","example":"QalIoKWLTJehBJ8e1xRrbQ"},"status":{"type":"string","description":"Status of the Session Poll:  \n `active` - Poll is active   \n `inactive` - Poll is deactivated","example":"active","enum":["active","inactive"],"x-enum-descriptions":["Poll Active","Poll Inactive"]},"anonymous":{"type":"boolean","description":"Allow session participants to answer poll questions anonymously.","example":false},"poll_type":{"type":"integer","description":"The type of poll. \n* `1` &mdash; Basic Poll. Only single and multiple choice questions are allowed. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account.  \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account.","example":2,"enum":[1,2,3]},"questions":{"maxItems":30,"type":"array","description":"Information about the poll's questions.","items":{"required":["name","type"],"type":"object","properties":{"answer_max_character":{"type":"integer","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.","example":200},"answer_min_character":{"minimum":1,"type":"integer","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.","example":1},"answer_required":{"type":"boolean","description":"Whether participants must answer the question. \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; 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`.","example":false,"default":false},"answers":{"maxItems":50,"minItems":2,"type":"array","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.","items":{"type":"string","example":"Extremely useful"}},"case_sensitive":{"type":"boolean","description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`.","example":false,"default":false},"name":{"maxLength":255,"type":"string","description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` question, this field is the question text with placeholders for blanks (ex: `This is a <Blank 1> and is another <Blank 2>`. For each value that the user must fill in, ensure that there are the same number of `answers` values.","example":"How useful was this meeting?"},"prompts":{"maxItems":50,"type":"array","description":"Information about the prompt questions. The question prompt's title. 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.","items":{"type":"string","example":"How are you?"}},"prompt_right_answers":{"maxItems":50,"type":"array","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.","items":{"type":"string","example":"Good"}},"rating_max_label":{"type":"string","description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","example":"Extremely Likely"},"rating_max_value":{"maximum":10,"type":"integer","description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","example":4},"rating_min_label":{"type":"string","description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","example":"Not likely"},"rating_min_value":{"minimum":0,"type":"integer","description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","example":0},"right_answers":{"maxItems":50,"minItems":1,"type":"array","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.","items":{"type":"string","example":"Good"}},"show_as_dropdown":{"type":"boolean","description":"Whether to display the radio selection as a drop-down box. \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`.","example":false,"default":false},"type":{"type":"string","description":"The poll's question and answer type. \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale.","example":"single","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"]}}}},"title":{"maxLength":64,"type":"string","description":"The poll's title, up to 64 characters.","example":"Learn something new"}},"description":"Information about session polling."}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nPolls updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:update:session_poll","zoom_events:update:session_poll:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:update:session_poll","zoom_events:update:session_poll:admin"]}}},"/zoom_events/events/{eventId}/sessions/{sessionId}/reservations":{"get":{"tags":["Sessions"],"summary":"List session reservations","description":"Retrieves the list of reservations made by registrants for the session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_reservations`,`zoom_events:read:list_session_reservations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListSessionReservations","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nList of session reservations.","content":{"application/json":{"schema":{"title":"Reservations info PageToken pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of reservations per page.","example":1},"next_page_token":{"type":"string","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"oLVRGBTZXI6Kt7zv0gb8Qy4h8cLNbzK1ig2"},"reservations":{"maxItems":300,"type":"array","description":"Reservations","items":{"title":"The reservation information.","type":"object","properties":{"first_name":{"type":"string","description":"The registrant's first name.","example":"First"},"last_name":{"type":"string","description":"The registrant's last name.","example":"Last"},"email":{"type":"string","description":"The email address of the registrant.","example":"email@zoom.us"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26302` <br>\n The time range is overlapping or you have reached the maximum number of sessions on the same day. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:read","zoom_events_sessions:read:admin","zoom_events:read:list_session_reservations","zoom_events:read:list_session_reservations:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:read","zoom_events_sessions:read:admin"],"x-granular-scopes":["zoom_events:read:list_session_reservations","zoom_events:read:list_session_reservations:admin"]}},"post":{"tags":["Sessions"],"summary":"Add session reservations","description":"Reserve a spot for a user in the given session. As a host, reserve registrants for a particular session. Session reservation needs to be enabled before using this API.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:session_reservations`,`zoom_events:write:session_reservations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"AddSessionReservations","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Session reservations","required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the registrant.","example":"email@zoom.us"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` Reservation added successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26306` <br>\n No reservations available. Maximum capacity reached. <br>\n**Error Code:** `26307` <br>\n Session reservation is disabled. <br>\n**Error Code:** `26308` <br>\n Host session reservation is disabled. <br>\n**Error Code:** `26309` <br>\n User does not have access to this session. <br>\n**Error Code:** `26310` <br>\n Reservations are not required for users with special roles. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:write:session_reservations","zoom_events:write:session_reservations:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:write:session_reservations","zoom_events:write:session_reservations:admin"]}},"delete":{"tags":["Sessions"],"summary":"Delete session reservations","description":"This tool removes a user's reservation spot for a given session. As a host, you can use it to remove reservations of registrants for a particular session.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:session_reservations`,`zoom_events:delete:session_reservations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DeleteSessionReservations","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"sessionId","in":"path","description":"The ID of the session.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Session reservations","required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the registrant.","example":"email@zoom.us"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` Reservation deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26311` <br>\n Session reservation not found. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2003` <br>\n Session not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_sessions:write","zoom_events_sessions:write:admin","zoom_events:delete:session_reservations","zoom_events:delete:session_reservations:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_sessions:write","zoom_events_sessions:write:admin"],"x-granular-scopes":["zoom_events:delete:session_reservations","zoom_events:delete:session_reservations:admin"]}}},"/zoom_events/events/{eventId}/speakers":{"get":{"tags":["Speakers"],"summary":"List speakers","description":"Retrieves a list of speakers for an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:read`,`zoom_events_speakers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_speakers`,`zoom_events:read:list_speakers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSpeakers","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`    List of speakers returned.","content":{"application/json":{"schema":{"title":"List of speakers","type":"object","properties":{"total_records":{"type":"number","description":"The total number of speakers.","example":1},"speakers":{"maxItems":300,"type":"array","items":{"title":"Speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The speaker ID.","example":"3935Ug73Sp6S-7K1BHk7qw"},"name":{"type":"string","description":"The speaker's name.","example":"John Joseph Dev"},"email":{"type":"string","description":"The speaker's email address.","example":"email@example.com"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Product Manager"},"biography":{"type":"string","description":"The speaker's biography.","example":"Provide a brief introduction of the speaker."},"company_name":{"type":"string","description":"The name of the speaker's company.","example":"zoom"},"company_website":{"type":"string","description":"The speaker's company website.","example":"https://www.example.com"},"linkedin_url":{"type":"string","description":"The LinkedIn URL.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The Twitter URL.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The YouTube URL.","example":"https://youtube.com/example"},"featured_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is featured in the event detail page.","example":true},"visible_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is visible in the event detail page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the speaker is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the speaker is visible in the event lobby.","example":true,"default":true}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_speakers:read","zoom_events_speakers:read:admin","zoom_events:read:list_speakers","zoom_events:read:list_speakers:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_speakers:read","zoom_events_speakers:read:admin"],"x-granular-scopes":["zoom_events:read:list_speakers","zoom_events:read:list_speakers:admin"]}},"post":{"tags":["Speakers"],"summary":"Create a speaker","description":"Creates a speaker for an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:speaker`,`zoom_events:write:speaker:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createSpeaker","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Speaker","required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The speaker's name.","example":"John Joseph Dev"},"email":{"type":"string","description":"The speaker's email address.","example":"email@example.com"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Product Manager"},"biography":{"type":"string","description":"The speaker's biography.","example":"Provide a brief introduction of the speaker."},"company_name":{"type":"string","description":"The name of the speaker's comapny.","example":"zoom"},"company_website":{"type":"string","description":"The speaker's company website.","example":"https://www.example.com"},"linkedin_url":{"type":"string","description":"The LinkedIn URL.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The Twitter URL.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The Youtube URL.","example":"https://youtube.com/example"},"featured_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is featured in the event detail page.","example":true},"visible_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is visible in the event detail page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the speaker is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the speaker is visible in the event lobby.","example":true,"default":true}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nSpeakers returned.","content":{"application/json":{"schema":{"title":"Speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The speaker ID.","example":"3935Ug73Sp6S-7K1BHk7qw"},"name":{"type":"string","description":"The speaker's name.","example":"John Joseph Dev"},"email":{"type":"string","description":"The speaker's email address.","example":"email@example.com"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Product Manager"},"biography":{"type":"string","description":"The speaker's biography.","example":"Provide a brief introduction of the speaker."},"company_name":{"type":"string","description":"The name of the speaker's comapny.","example":"zoom"},"company_website":{"type":"string","description":"The speaker's company website.","example":"https://www.example.com"},"linkedin_url":{"type":"string","description":"The LinkedIn URL.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The Twitter URL.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The YouTube URL.","example":"https://youtube.com/example"},"featured_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is featured in the event detail page.","example":true},"visible_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is visible in the event detail page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the speaker is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the speaker is visible in the event lobby.","example":true,"default":true}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1001` <br>\n Content moderation check failed. <br>\n**Error Code:** `1003` <br>\n The email address has already been used by another speaker. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `3002` <br>\n You have exceeded the maximum speaker capacity. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_speakers:write","zoom_events_speakers:write:admin","zoom_events:write:speaker","zoom_events:write:speaker:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_speakers:write","zoom_events_speakers:write:admin"],"x-granular-scopes":["zoom_events:write:speaker","zoom_events:write:speaker:admin"]}}},"/zoom_events/events/{eventId}/speakers/{speakerId}":{"get":{"tags":["Speakers"],"summary":"Get a speaker","description":"Returns information on a specific speaker.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:read`,`zoom_events_speakers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:speaker`,`zoom_events:read:speaker:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSpeaker","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"speakerId","in":"path","description":"The ID of the speaker.","required":true,"schema":{"type":"string","example":"HvjxfFGdRYCL2_ZIbq2Mvg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Speaker returned.","content":{"application/json":{"schema":{"title":"Speaker","type":"object","properties":{"speaker_id":{"type":"string","description":"The speaker ID.","example":"3935Ug73Sp6S-7K1BHk7qw"},"name":{"type":"string","description":"The speaker's name.","example":"John Joseph Dev"},"email":{"type":"string","description":"The speaker's email address.","example":"email@example.com"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Product Manager"},"biography":{"type":"string","description":"The speaker's biography.","example":"Provide a brief introduction of the speaker."},"company_name":{"type":"string","description":"The name of the speaker's comapny.","example":"zoom"},"company_website":{"type":"string","description":"The speaker's company website.","example":"https://www.example.com"},"linkedin_url":{"type":"string","description":"The LinkedIn URL.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The Twitter URL.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The YouTube URL.","example":"https://youtube.com/example"},"featured_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is featured in the event detail page.","example":true},"visible_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is visible in the event detail page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the speaker is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the speaker is visible in the event lobby.","example":true,"default":true}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2005` <br>\n Speaker not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_speakers:read","zoom_events_speakers:read:admin","zoom_events:read:speaker","zoom_events:read:speaker:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_speakers:read","zoom_events_speakers:read:admin"],"x-granular-scopes":["zoom_events:read:speaker","zoom_events:read:speaker:admin"]}},"delete":{"tags":["Speakers"],"summary":"Delete a speaker","description":"Deletes a speaker.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:speaker`,`zoom_events:delete:speaker:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteSpeaker","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"speakerId","in":"path","description":"The ID of the speaker.","required":true,"schema":{"type":"string","example":"HvjxfFGdRYCL2_ZIbq2Mvg"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSpeaker deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `2005` <br>\n Speaker not found. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_speakers:write","zoom_events_speakers:write:admin","zoom_events:delete:speaker","zoom_events:delete:speaker:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_speakers:write","zoom_events_speakers:write:admin"],"x-granular-scopes":["zoom_events:delete:speaker","zoom_events:delete:speaker:admin"]}},"patch":{"tags":["Speakers"],"summary":"Update a speaker","description":"Updates the speaker information.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:speaker`,`zoom_events:update:speaker:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateSpeaker","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"speakerId","in":"path","description":"The ID of the speaker.","required":true,"schema":{"type":"string","example":"HvjxfFGdRYCL2_ZIbq2Mvg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Speaker","type":"object","properties":{"name":{"type":"string","description":"The speaker's name.","example":"John Joseph Dev"},"email":{"type":"string","description":"The speaker's email address.","example":"email@example.com"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Product Manager"},"biography":{"type":"string","description":"The speaker's biography.","example":"Provide a brief introduction of the speaker."},"company_name":{"type":"string","description":"The name of the speaker's company.","example":"zoom"},"company_website":{"type":"string","description":"The speaker's company website.","example":"https://www.example.com"},"linkedin_url":{"type":"string","description":"The LinkedIn URL.","example":"https://linkedin.com/example"},"twitter_url":{"type":"string","description":"The Twitter URL.","example":"https://twitter.com/example"},"youtube_url":{"type":"string","description":"The YouTube URL.","example":"https://youtube.com/example"},"featured_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is featured in the event detail page.","example":true},"visible_in_event_detail_page":{"type":"boolean","description":"Whether the speaker is visible in the event detail page.","example":true,"default":true},"featured_in_lobby":{"type":"boolean","description":"Whether the speaker is featured in the event lobby.","example":false},"visible_in_lobby":{"type":"boolean","description":"Whether the speaker is visible in the event lobby.","example":true,"default":true}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSpeaker updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1001` <br>\n Content moderation check failed. <br>\n**Error Code:** `1003` <br>\n The email address has already been used by another speaker. <br>\n**Error Code:** `1005` <br>\n The same person has been assigned multiple roles. A user is not allowed to hold multiple roles in the same session. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `2005` <br>\n Speaker not found. <br>\n**Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_speakers:write","zoom_events_speakers:write:admin","zoom_events:update:speaker","zoom_events:update:speaker:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_speakers:write","zoom_events_speakers:write:admin"],"x-granular-scopes":["zoom_events:update:speaker","zoom_events:update:speaker:admin"]}}},"/zoom_events/events/{eventId}/questions":{"get":{"tags":["Ticket Types"],"summary":"List registration questions for an event","description":"List registration questions and fields that are to be answered by users while registering for an event. These questions are setup during the event level.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registration_questions`,`zoom_events:read:list_registration_questions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getRegistrationQuestionsForEvent","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nSuccessfully retrieved registration questions.","content":{"application/json":{"schema":{"allOf":[{"title":"Event Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"State whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"Title of the question.","example":"Last Name"},"question_id":{"type":"string","description":"The ID of the question.","example":"Fn2rBZgJQzi6VIU--uWqnA"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"Array of Registrant Custom Questions.","items":{"type":"object","properties":{"options":{"maxItems":50,"type":"array","description":"An array of answer choices. Can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"State whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"Custom question.","example":"How are you?"},"question_id":{"type":"string","description":"The ID of the custom question.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"Event registrant questions."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin","zoom_events:read:list_registration_questions","zoom_events:read:list_registration_questions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin"],"x-granular-scopes":["zoom_events:read:list_registration_questions","zoom_events:read:list_registration_questions:admin"]}},"put":{"tags":["Ticket Types"],"summary":"Update registration questions for an event","description":"Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at event level.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:registraion_question`,`zoom_events:update:registraion_question:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateRegistrationQuestionsForEvent","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"The field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"Whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"Title of the question.","example":"Last Name"},"question_id":{"type":"string","description":"The ID of the question.","example":"Fn2rBZgJQzi6VIU--uWqnA"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"Array of registrant custom questions.","items":{"type":"object","properties":{"options":{"maxItems":30,"type":"array","description":"An array of answer choices. Can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"State whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"Custom question.","example":"How are you?"},"question_id":{"type":"string","description":"The ID of the custom question.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"Event registrant questions."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated registration questions."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin","zoom_events:update:registraion_question","zoom_events:update:registraion_question:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin"],"x-granular-scopes":["zoom_events:update:registraion_question","zoom_events:update:registraion_question:admin"]}}},"/zoom_events/events/{eventId}/ticket_types":{"get":{"tags":["Ticket Types"],"summary":"List ticket types","description":"Lists all ticket types associated with an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_ticket_types`,`zoom_events:read:list_ticket_types:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getEventTicketTypes","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n A list of ticket types.","content":{"application/json":{"schema":{"title":"Ticket type pagination","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records.","example":1},"ticket_types":{"maxItems":50,"type":"array","description":"The list of ticket types for the event.","items":{"title":"Ticket type information","type":"object","properties":{"ticket_type_id":{"type":"string","description":"The ID of the ticket type.","example":"234kjhg23kl4jhlaksjdh3"},"name":{"type":"string","description":"The name of the ticket type.","example":"General Admission Ticket"},"currency":{"type":"string","description":"The currency of the ticket type.","example":"USD"},"free":{"type":"boolean","description":"Whether the ticket is free.","example":true},"price":{"type":"string","description":"The price of the ticket type.","example":"0"},"quantity":{"type":"number","description":"The quantity of the ticket type.","example":50},"start_time":{"type":"string","description":"The start time of ticket sales.","example":"2022-03-24T22:30:00Z"},"end_time":{"type":"string","description":"The end time of ticket sales.","example":"2023-01-01T06:30:00Z"},"description":{"type":"string","description":"The description of the ticket type.","example":"The description of the ticket type."},"sold_quantity":{"type":"number","description":"The total number of tickets sold.","example":35},"sessions":{"maxItems":200,"type":"array","description":"The list of session IDs allowed for this ticket type or *ALL* \n *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"bookmarked_sessions":{"maxItems":200,"type":"array","description":"Pre-bookmark sessions for your attendees. This is list of session IDs to be bookmarked for this ticket type. Its values could be comma seperated session IDs or can have value *ALL* \n.  *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"private_visibility_rules":{"type":"object","properties":{"account_restrict":{"type":"boolean","description":"Whether the ticket type is restricted to certain Zoom accounts.","example":true},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The ticket type is restricted to these specific domains. This array returns a maximum of 50 domains.","items":{"type":"string","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","example":"example1@email.com"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]}},"description":"The private visibility settings"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin","zoom_events:read:list_ticket_types","zoom_events:read:list_ticket_types:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin"],"x-granular-scopes":["zoom_events:read:list_ticket_types","zoom_events:read:list_ticket_types:admin"]}},"post":{"tags":["Ticket Types"],"summary":"Create an event ticket type","description":"Creates a ticket type for the event ID that is not allowed for single session and recurring event types.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket_type`,`zoom_events:write:ticket_type:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createTicketType","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"requestBody":{"description":"The details about the ticket type.\n","content":{"application/json":{"schema":{"title":"Ticket type information","required":["currency","end_time","name","start_time"],"type":"object","properties":{"name":{"type":"string","description":"The name of the ticket type.","example":"General Admission Ticket."},"currency":{"type":"string","description":"The currency of the ticket type.","example":"USD"},"free":{"type":"boolean","description":"Whether the ticket is free.","example":true},"price":{"type":"string","description":"The price of the ticket type.","example":"0"},"quantity":{"type":"number","description":"The quantity of the ticket type.","example":50},"start_time":{"type":"string","description":"The start time of ticket sales.","example":"2022-03-24T22:30:00Z"},"end_time":{"type":"string","description":"The end time of ticket sales.","example":"2023-01-01T06:30:00Z"},"description":{"type":"string","description":"The description of the ticket type.","example":"The description of the ticket type."},"sold_quantity":{"type":"number","description":"The total number of tickets sold.","example":35},"sessions":{"maxItems":200,"type":"array","description":"The list of session IDs allowed for this ticket type or *ALL* \n *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"bookmarked_sessions":{"maxItems":200,"type":"array","description":"The list of sessions that display in the main lobby. The value is an array of session IDs or *ALL* . \n *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"private_visibility_rules":{"type":"object","properties":{"account_restrict":{"type":"boolean","description":"Whether the ticket type is restricted to certain Zoom accounts.","example":true},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The ticket type is restricted to these specific domains. The maximum domains you can pass in the array is 50. ","items":{"type":"string","description":"Each domain can have up to 40 characters","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.","items":{"type":"string","description":"Each email can have up to 60 characters","example":"example1@email.com"}}},"description":"The private visibility settings."},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees","example":"hybrid","enum":["virtual","in-person","hybrid"]}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nThe list of ticket types.","content":{"application/json":{"schema":{"title":"Ticket type information","type":"object","properties":{"ticket_type_id":{"type":"string","description":"The ID of the ticket type for purchase.","example":"pfalaof9s83lsLJD9u2d"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26401` <br>\n The ticket sale dates are invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event ID not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin","zoom_events:write:ticket_type","zoom_events:write:ticket_type:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin"],"x-granular-scopes":["zoom_events:write:ticket_type","zoom_events:write:ticket_type:admin"]}}},"/zoom_events/events/{eventId}/ticket_types/{ticketTypeId}":{"delete":{"tags":["Ticket Types"],"summary":"Delete a ticket type","description":"Deletes a ticket type of an event that is not allowed for a single session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:ticket_type`,`zoom_events:delete:ticket_type:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteEventTicketType","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketTypeId","in":"path","description":"The ID of the ticket type.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully deleted the ticket type."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event ID not found. <br>\n**Error Code:** `26502` <br>\n The ticket type ID is invalid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin","zoom_events:delete:ticket_type","zoom_events:delete:ticket_type:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin"],"x-granular-scopes":["zoom_events:delete:ticket_type","zoom_events:delete:ticket_type:admin"]}},"patch":{"tags":["Ticket Types"],"summary":"Update ticket type for an event","description":"Updates the ticket type for an event ID not allowed for a single session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:ticket_type`,`zoom_events:update:ticket_type:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateTicketType","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketTypeId","in":"path","description":"The ID of the ticket type.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"The ticket type information.","type":"object","properties":{"name":{"type":"string","description":"The name of the ticket type.","example":"General Admission Ticket"},"currency":{"type":"string","description":"The currency of the ticket type.","example":"USD"},"free":{"type":"boolean","description":"Whether the ticket is free.","example":true},"price":{"type":"string","description":"The price of the ticket type.","example":"0"},"quantity":{"type":"number","description":"The quantity of the ticket type.","example":50},"start_time":{"type":"string","description":"The start time of ticket sales.","example":"2022-03-24T22:30:00Z"},"end_time":{"type":"string","description":"The end time of ticket sales.","example":"2023-01-01T06:30:00Z"},"description":{"type":"string","description":"The description of the ticket type.","example":"The description of the ticket type."},"sold_quantity":{"type":"number","description":"The total number of tickets sold.","example":35},"sessions":{"maxItems":200,"type":"array","description":"The list of session IDs allowed for this ticket type or *ALL* \n *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"bookmarked_sessions":{"maxItems":200,"type":"array","description":"The list of sessions that display in the main lobby. The value is an array of session IDs or *ALL* . \n *ALL* refer all the sessions in the event.","items":{"type":"string","example":"ALL"}},"private_visibility_rules":{"title":"The private visibility settings","type":"object","properties":{"account_restrict":{"type":"boolean","description":"Whether the ticket type is restricted to certain Zoom accounts.","example":true},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The ticket type is restricted to these specific domains. The maximum domains we can pass in the array is 50. ","items":{"type":"string","description":"Each domain can have up to 40 characters.","example":"zoom.us"}},"email_restrict_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses receive an email invitation.","items":{"type":"string","description":"Each email can have up to 60 characters.","example":"example1@email.com"}},"attendance_type":{"type":"string","description":"The type of attendee experience for the event. \n * `virtual`  virtual attendees only \n * `in-person` in-person attendees only \n * `hybrid`  both in-person and virtual attendees.","example":"hybrid","enum":["virtual","in-person","hybrid"]}}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated the ticket type."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `26502` <br>\n The ticket type ID is invalid. <br>\n**Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin","zoom_events:update:ticket_type","zoom_events:update:ticket_type:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin"],"x-granular-scopes":["zoom_events:update:ticket_type","zoom_events:update:ticket_type:admin"]}}},"/zoom_events/events/{eventId}/ticket_types/{ticketTypeId}/questions":{"get":{"tags":["Ticket Types"],"summary":"List registration questions for ticket type","description":"List registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registration_questions`,`zoom_events:read:list_registration_questions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getRegistrationQuestionsForTicketType","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketTypeId","in":"path","description":"The ID of the ticket type.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nSuccessfully retrieved registration questions.","content":{"application/json":{"schema":{"allOf":[{"title":"Event Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"State whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"Title of the question.","example":"Last Name"},"question_id":{"type":"string","description":"The ID of the question.","example":"Fn2rBZgJQzi6VIU--uWqnA"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"Array of Registrant Custom Questions.","items":{"type":"object","properties":{"options":{"maxItems":30,"type":"array","description":"An array of answer choices. Can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"State whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"Custom question.","example":"How are you?"},"question_id":{"type":"string","description":"The ID of the custom question.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"Event registrant questions."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin","zoom_events:read:list_registration_questions","zoom_events:read:list_registration_questions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin"],"x-granular-scopes":["zoom_events:read:list_registration_questions","zoom_events:read:list_registration_questions:admin"]}},"put":{"tags":["Ticket Types"],"summary":"Update registration questions for ticket type","description":"Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level. This API is not allowed for single session event type.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:registraion_question`,`zoom_events:update:registraion_question:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateRegistrationQuestionsForTicketType","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketTypeId","in":"path","description":"The ID of the ticket type.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"Whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"The title of the question.","example":"Last Name"},"question_id":{"type":"string","description":"The ID of the question.","example":"Fn2rBZgJQzi6VIU--uWqnA"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"Array of registrant custom questions.","items":{"type":"object","properties":{"options":{"type":"array","description":"An array of answer choices. Can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"State whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"Custom question.","example":"How are you?"},"question_id":{"type":"string","description":"The ID of the custom question.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"Event registrant questions."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated registration questions."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin","zoom_events:update:registraion_question","zoom_events:update:registraion_question:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin"],"x-granular-scopes":["zoom_events:update:registraion_question","zoom_events:update:registraion_question:admin"]}}},"/zoom_events/events/{eventId}/tickets":{"get":{"tags":["Tickets"],"summary":"List tickets","description":"Retrieves the ticket information of an event.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus/ Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_tickets`,`zoom_events:read:list_tickets:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getTickets","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"external_ticket_id","in":"query","description":"The ID of the external ticket.","required":false,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}},{"name":"email","in":"query","description":"The email of registrant.\n","required":false,"schema":{"type":"string","example":"test@example.com"}},{"name":"ticket_type_id","in":"query","description":"The ID of the ticket type.","required":false,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Ticket Information.","content":{"application/json":{"schema":{"title":"Tickets pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of tickets.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"tickets":{"maxItems":300,"type":"array","description":"Tickets","items":{"description":"The person who is registered for the event.","allOf":[{"type":"object","properties":{"ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the ticket ID.","example":"iso9Dllddp39dagjLj9j"},"ticket_type_id":{"type":"string","description":"The ID of the ticket type for purchase.","example":"pfalaof9s83lsLJD9u2d"},"external_ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"event_join_link":{"type":"string","description":"A unique join link created for the ticket.","example":"https://events.zoom.us/ejl/xyz"},"send_notification":{"type":"boolean","description":"Whether to receive email notifications.","example":false},"email":{"type":"string","description":"The email address used for the registration.","example":"email@zoom.us"},"ticket_role_type":{"type":"string","description":"The ticket role type: \n * `normal` The normal ticket \n * `alternative_host` The alternative host ticket \n * `panelist` The panelist ticket \n * `bind_meeting` The bind meeting ticket \n * `speaker` The speaker ticket \n * `interpreter` The interpreter ticket \n * `sponsor` The sponsor ticket \n * `host` The host ticket \n * `moderator` The moderator ticket \n * `expo_booth_owner` The expo booth owner ticket \n * `attendee_without_order` The attendee without order ticket \n * `pre_registration` The pre-registration ticket \n * `company_zoom_room` The company zoom room ticket \n * `moderator_allhost` The moderator all host ticket \n * `hub_host` The hub host ticket \n * `hub_owner` The hub owner ticket &quot;,\n * `subscription` The subscription ticket &quot;","example":"normal","enum":["normal","alternative_host","panelist","bind_meeting","speaker","subscription","sponsor","interpreter","host","moderator","expo_booth_owner","attendee_without_order","pre_registration","company_zoom_room","moderator_allhost","hub_host","hub_owner"]},"registration_source":{"type":"string","description":"The source of registration.","example":"Pardot"},"session_id":{"type":"string","description":"Session ID registered for this ticket.This is applicable only for the tickets created for the recurring session.","example":"iso9Djldop39dagjLj3j"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` — Zoom account holder. \n * `zoom_account_otp` — Zoom account holder with OTP. \n * `corporate_idp` — Corporate IDP. \n * `no_auth` — No authentication. \n * `email_opt` — Registration using email OTP verification. \n * `accelerated_auth` — Authentication through vanity URL. \n * `zoom_account_otp_at_join` — **Deprecated.** Its functionality is now represented by the `security_code_at_join` field. User login with Zoom account and security code at join. Use `zoom_account` with the `security_code_at_join` field instead.","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","email_opt","accelerated_auth","zoom_account_otp_at_join","no_auth"]},"idp_name":{"type":"string","description":"The IDP name configured for the account.","example":"okta"},"security_code_at_join":{"type":"boolean","description":"Whether attendees must enter a security code when joining.","example":false},"qr_code_url":{"type":"string","description":"The URL generated after scanning the e-badge QR code image. This field is applicable only for hybrid or in-person event types.","example":"https://zoom.us/qr?t=9&ein=AkhZhct94cUqiDfRumcpPf0loI-QAOt5T9yh_vGRn2-BkPDmjfze~AyTxY2Fs9Nw6ADEk-edYyZIyGIzxVAI_v-Mci1S-KeyRhbZOG3-4kWVpYqSxJK-2Uls-j_GSHh9L7Ku_zZta-MDu2NCA1Rg"}}},{"type":"object","properties":{"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"comments":{"maxLength":255,"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."}},"description":"Standard question fields."},{"type":"object","properties":{"custom_questions":{"maxItems":100,"type":"array","description":"Information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}},"description":"Information about custom questions."}}}}]}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_tickets:read","zoom_events_tickets:read:admin","zoom_events:read:list_tickets","zoom_events:read:list_tickets:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_tickets:read","zoom_events_tickets:read:admin"],"x-granular-scopes":["zoom_events:read:list_tickets","zoom_events:read:list_tickets:admin"]}},"post":{"tags":["Tickets"],"summary":"Create tickets","description":"Creates tickets for an event. You can add a single ticket or up to 30 tickets in a batch operation. Please note that this request uses the [`pre-registration`](https://support.zoom.us/hc/en-us/articles/13475985512973-Pre-registering-Zoom-Events-guests) flow. \n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket`,`zoom_events:write:ticket:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createTickets","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"validation_level","in":"query","description":"**Standard**: This is the default level. Ensures all required questions are answered and allowing unconfigured questions in the payload, though they won't be processed.\n**Strict**: Ensures all required questions are answered and returns an http bad request error with error code 260503 if an unconfigured questions or answers are submitted.\n**none**: Disables validation entirely. Questions are not checked for mandatory status, and any unconfigured question answers are ignored — the registration proceeds without validation of registration questions.","required":false,"schema":{"type":"string","example":"strict","enum":["standard","strict","none"]}}],"requestBody":{"description":"The information about the created ticket.\n","content":{"application/json":{"schema":{"title":"List of tickets for the event.","type":"object","properties":{"registration_source":{"maxLength":16,"type":"string","description":"The source of registration.","example":"Pardot"},"tickets":{"maxItems":30,"type":"array","description":"List of tickets that needs to be created.","items":{"type":"object","description":"The name of the attendee who is registered for the event.","allOf":[{"required":["email"],"type":"object","properties":{"email":{"maxLength":128,"type":"string","description":"The email address used for the registration.","format":"email","example":"email@example.com"},"ticket_type_id":{"type":"string","description":"The ID of the ticket type for purchase. If the ticket type ID is not provided, it will pick the event default ticket type. If the default ticket type ID is deleted, this field is mandatory.","example":"pfalaof9s83lsLJD9u2d"},"external_ticket_id":{"maxLength":128,"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"send_notification":{"type":"boolean","description":"Whether to receive email notifications.","example":false},"fast_join":{"type":"boolean","description":"Whether to support guest join i.e. Non-Zoom users (Fast join without upfront authentication). If true then the `registration_needed` flag should not be set to true as it is an invalid combination.","example":false},"registration_needed":{"type":"boolean","description":"Whether registrant needs to fill an online registration form.\n If **true** then the registration questions fields such as first_name, last_name, and address are not needed in the request body and are ignored if present. \n Also, if **true** then event_registration_link is returned instead of event_join_link in the response.","example":false},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type.\n * `zoom_account` - Zoom account holder.\n * `zoom_account_otp` - Sign in with a Zoom account or with an email OTP.\n * `email_otp` - Join with an email OTP.\n * `corporate_idp` - Sign in to external single sign-on (SSO). Configure the Zoom account with a valid SSO configuration. Accounts with multiple identity providers (IDPs) are not supported using the API.\n * `accelerated_auth` - Authentication through vanity URL.","example":"zoom_account","enum":["zoom_account","zoom_account_otp","email_otp","corporate_idp","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP name configured for the account. If the authentication type is `corporate_idp` and the Zoom account is configured with more than one IDP provider, this field is required.","example":"okta"},"security_code_at_join":{"type":"boolean","description":"Whether attendees must enter a security code when joining. This field is not required when `authentication_method` is `email_otp`.","example":false},"session_ids":{"maxItems":200,"type":"array","description":"The list of session ID’s users want to register for the event. This is applicable only for recurring events with session level registration enabled.","items":{"type":"string","example":"iso9Djldop39dagjLj3j"}}}},{"type":"object","properties":{"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"comments":{"maxLength":255,"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."}},"description":"The standard question fields."},{"type":"object","properties":{"custom_questions":{"maxItems":100,"type":"array","description":"The information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}},"description":"Information about custom questions."}}}}]}}},"description":"The list of tickets for the event."}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nThe list of tickets.","content":{"application/json":{"schema":{"title":"List of tickets for the event.","type":"object","properties":{"errors":{"maxItems":30,"type":"array","description":"The list of failure. If this list is empty all requests are successful. All failure records contains an entry in the error block.","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address used for the registration.","example":"email@zoom.us"},"error_code":{"type":"string","description":"The error code for the failure reason \n * email_not_found - `invalid or missing email` \n * ticket_type_notfound - `ticket type not found` \n * stock_not_exist - `stock not exist`\n * invalid_sale_time - `invalid sale date for the ticket type ID` \n * invalid_api_registration_questions_answers - `invalid question and answers` \n * ticket_generated_failed - `ticket not generated` \n * fast_join_with_registrationNeeded - `fast join with registration needed not supported` \n * missing_required_questions - `missing required questions` \n * non_configured_questions `request contains non configured questions`","example":"fast_join_with_registrationNeeded","enum":["email_not_found","ticket_type_notfound","stock_not_exist","invalid_sale_time","invalid_api_registration_questions_answers","ticket_generated_failed","fast_join_with_registrationNeeded","tickets_duplicate_custom_questions"]},"message":{"type":"string","description":"The email address used for the registration.","example":"fast_join should not be true when when registration needed flag is true."}}}},"tickets":{"maxItems":30,"type":"array","items":{"required":["email","ticket_type_id"],"type":"object","properties":{"ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the ticket ID.","example":"iso9Dllddp39dagjLj9j"},"external_ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"event_join_link":{"type":"string","description":"A unique join link created for the ticket.","example":"https://events.zoom.us/ejl/xyz"},"event_registration_link":{"type":"string","description":"A unique registration link created for the registrant to register for the event.","example":"https://events.zoom.us/etr/xyz123"},"qr_code_url":{"type":"string","description":"he URL for the 800x800 thumbnail image of the e-badge QR code. This field is applicable only for hybrid or in-person event types.","example":"https://zoom.us/qr?t=5&ein=Ak61AAOitRj1r8MYQ70-u-Bho-KJvIEC7eEfb_lDBksIfKuA6Ax7~A8bIXPJw8mO01a2"},"email":{"type":"string","description":"The email address used for the registration.","example":"email@zoom.us"}},"description":"The name of the attendee who is registered for the event."}}},"description":"The list of tickets created for the event."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `26502` <br>\n The ticket type ID is invalid. <br>\n**Error Code:** `26501` <br>\n Event is not published yet. <br>\n**Error Code:** `26401` <br>\n The ticket sale dates are invalid. <br>\n**Error Code:** `260503` <br>\n Nonconfigured fields - [\"email\", \"phone\", \"Foo,Bar\", \"Foo\"Bar\"]. <br>\n**Error Code:** `260504` <br>\n Missing required fields - [\"email\", \"phone\", \"Foo,Bar\", \"Foo\"Bar\"]. <br>\n**Error Code:** `260505` <br>\n The given ticket type was not found. <br>\n**Error Code:** `260506` <br>\n Capacity is full for the specified ticket_type_id. <br>\n**Error Code:** `260507` <br>\n Unable to identify the external SSO configuration. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `2007` <br>\n Not enough stock or invalid `ticket_type_id`. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_tickets:write","zoom_events_tickets:write:admin","zoom_events:write:ticket","zoom_events:write:ticket:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_tickets:write","zoom_events_tickets:write:admin"],"x-granular-scopes":["zoom_events:write:ticket","zoom_events:write:ticket:admin"]}}},"/zoom_events/events/{eventId}/tickets/{ticketId}":{"get":{"tags":["Tickets"],"summary":"Get a ticket","description":"Retrieves information on a specific ticket.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:ticket`,`zoom_events:read:ticket:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getTicketDetails","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketId","in":"path","description":"The ID of the registered ticket.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Ticket Information.","content":{"application/json":{"schema":{"required":["email","ticket_type_id"],"description":"The registered user's ticket information.","allOf":[{"type":"object","properties":{"ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the ticket ID.","example":"iso9Dllddp39dagjLj9j"},"ticket_type_id":{"type":"string","description":"The ID of the ticket type for purchase.","example":"pfalaof9s83lsLJD9u2d"},"external_ticket_id":{"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"},"event_join_link":{"type":"string","description":"A unique join link created for the ticket.","example":"https://events.zoom.us/ejl/xyz"},"send_notification":{"type":"boolean","description":"Whether to receive email notifications.","example":false},"email":{"type":"string","description":"The email address used for the registration.","example":"email@zoom.us"},"ticket_role_type":{"type":"string","description":"The ticket role type: \n * `normal` The normal ticket \n * `alternative_host` The alternative host ticket \n * `panelist` The panelist ticket \n * `bind_meeting` The bind meeting ticket \n * `speaker` The speaker ticket \n * `interpreter` The interpreter ticket \n * `sponsor` The sponsor ticket \n * `host` The host ticket \n * `moderator` The moderator ticket \n * `expo_booth_owner` The expo booth owner ticket \n * `attendee_without_order` The attendee without order ticket \n * `pre_registration` The pre-registration ticket \n * `company_zoom_room` The company Zoom Room ticket \n * `moderator_allhost` The moderator all host ticket \n * `hub_host` The hub host ticket \n * `hub_owner` The hub owner ticket\n * `subscription` The subscription ticket","example":"normal","enum":["normal","alternative_host","panelist","bind_meeting","speaker","subscription","sponsor","interpreter","host","moderator","expo_booth_owner","attendee_without_order","pre_registration","company_zoom_room","moderator_allhost","hub_host","hub_owner"]},"qr_code_url":{"type":"string","description":"The URL generated after scanning the e-badge QR code image. This field is applicable only for hybrid or in-person event types.","example":"https://zoom.us/qr?t=9&ein=AkhZhct94cUqiDfRumcpPf0loI-QAOt5T9yh_vGRn2-BkPDmjfze~AyTxY2Fs9Nw6ADEk-edYyZIyGIzxVAI_v-Mci1S-KeyRhbZOG3-4kWVpYqSxJK-2Uls-j_GSHh9L7Ku_zZta-MDu2NCA1Rg"},"registration_source":{"type":"string","description":"The source of registration.","example":"Pardot"},"session_id":{"type":"string","description":"Session ID registered for this ticket.This is applicable only for the tickets created for the recurring session.","example":"iso9Djldop39dagjLj3j"},"authentication_method":{"type":"string","description":"The event authentication method for the ticket: \n * `zoom_account` — Zoom account holder. \n * `zoom_account_otp` — Zoom account holder with OTP. \n * `corporate_idp` — Corporate IDP. \n * `no_auth` — No authentication. \n * `email_opt` — Registration using email OTP verification. \n * `accelerated_auth` — Authentication through vanity URL. \n * `zoom_account_otp_at_join` — **Deprecated.** Its functionality is now represented by the `security_code_at_join` field. User login with Zoom account and security code at join. Use `zoom_account` with the `security_code_at_join` field instead.","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","email_opt","accelerated_auth","zoom_account_otp_at_join","no_auth"]},"idp_name":{"type":"string","description":"The IDP name configured for the account.","example":"okta"},"security_code_at_join":{"type":"boolean","description":"Whether attendees must enter a security code when joining.","example":false}}},{"type":"object","properties":{"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"comments":{"maxLength":255,"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."}},"description":"The standard question fields."},{"type":"object","properties":{"custom_questions":{"maxItems":100,"type":"array","description":"Information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}},"description":"Information about custom questions."}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2002` <br>\n Event not found. <br>\n**Error Code:** `26503` <br>\n Ticket not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_tickets:read","zoom_events_tickets:read:admin","zoom_events:read:ticket","zoom_events:read:ticket:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_tickets:read","zoom_events_tickets:read:admin"],"x-granular-scopes":["zoom_events:read:ticket","zoom_events:read:ticket:admin"]}},"delete":{"tags":["Tickets"],"summary":"Delete a ticket","description":"Deletes a ticket.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:ticket`,`zoom_events:delete:ticket:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteTicket","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketId","in":"path","description":"The ID of the registered ticket.","required":true,"schema":{"type":"string","example":"W38C8g0_SfmIzp5toOLoLQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nTicket deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Invalid request. \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `26503` <br>\n Ticket not found. <br>\n**Error Code:** `2002` <br>\n Event ID not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_tickets:write","zoom_events_tickets:write:admin","zoom_events:delete:ticket","zoom_events:delete:ticket:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_tickets:write","zoom_events_tickets:write:admin"],"x-granular-scopes":["zoom_events:delete:ticket","zoom_events:delete:ticket:admin"]}},"patch":{"tags":["Tickets"],"summary":"Update ticket","description":"Updates ticket questions for the given ticket ID and event ID.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket`,`zoom_events:write:ticket:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateticket","parameters":[{"name":"eventId","in":"path","description":"The ID of the event.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"ticketId","in":"path","description":"The ID of the ticket.","required":true,"schema":{"type":"string","example":"kNqDPC6hSFiZ9NpgjA782"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"comments":{"maxLength":255,"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."},"authentication_method":{"type":"string","description":"The event authentication method during registration or during join, depending on the access link type.\n * `zoom_account` - Zoom account holder.\n * `zoom_account_otp` - Sign in with Zoom account or with an email OTP.\n * `email_otp` - Join with an email OTP.\n * `corporate_idp` - Sign in to external single sign-on (SSO). Configure the Zoom account with a valid one SSO configuration. Accounts with multiple identity providers (IDP) are not supported using the API.\n * `accelerated_auth` - Authentication through vanity URL.","example":"corporate_idp","enum":["zoom_account","zoom_account_otp","email_otp","corporate_idp","accelerated_auth"]},"idp_name":{"type":"string","description":"The IDP Name configured for the account. If the authentication type is corporate IDP and Zoom Accounts configured with more than one IDP provider this field is required.","example":"okta"},"security_code_at_join":{"type":"boolean","description":"Whether attendees must enter a security code when joining. This field is not required when `authentication_method` is `email_otp`.","example":false},"custom_questions":{"maxItems":100,"type":"array","description":"Information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}},"description":"Information about custom questions."}},"external_ticket_id":{"maxLength":128,"type":"string","description":"A set of unique alphanumeric characters that references the external ticket ID.","example":"iso9Djldop39dagjLj3j"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated the ticket questions."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1063` <br>\n Ticket ID can not updated. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260200` <br>\n Event access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `26503` <br>\n Ticket not found. <br>\n**Error Code:** `2002` <br>\n Event ID not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_tickets:write","zoom_events_tickets:write:admin","zoom_events:write:ticket","zoom_events:write:ticket:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_tickets:write","zoom_events_tickets:write:admin"],"x-granular-scopes":["zoom_events:write:ticket","zoom_events:write:ticket:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels":{"get":{"tags":["Video On-Demand"],"summary":"List channels","description":"Retrieves the channel information for a hub.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_all_vod_channels`,`zoom_events:read:list_all_vod_channels:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getVODChannels","parameters":[{"name":"hubId","in":"path","description":"The ID of the hub.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   Channel Information.","content":{"application/json":{"schema":{"title":"VOD Channels pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of VOD channels.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"vod_channels":{"maxItems":300,"type":"array","description":"Channels","items":{"description":"The list of VOD channels for a hub.","allOf":[{"type":"object","properties":{"channel_id":{"type":"string","description":"A set of unique alphanumeric characters that references the VOD channel ID.","example":"iso9Dllddp39dagjLj9j"},"name":{"type":"string","description":"The name of the channel.","example":"My Channel"},"status":{"type":"string","description":"The VOD channel status: \nOptions:\n * `PUBLISHED` - Published channel.\n * `DRAFT` - Draft channel.","example":"PUBLISHED"},"is_published_to_hub":{"type":"boolean","description":"This field only applies to `VIDEO_LIST_HUB` type channel. This flag determines whether the content is visible on attendee facing hub profile page.","example":true},"type":{"type":"string","description":"The channel type: \n * `VIDEO_LIST_HUB` - The channel content hosted on the Zoom Events platform.  \n * `MULTI_VIDEO_EMBEDDED` - The embedded video channel. The video channel ( with multiple videos) can be embedded on a third-party website. \n * `SINGLE_VIDEO_EMBEDDED` - The single video embedded channel. A single video can be embedded on a third-party website.","example":"VIDEO_LIST_HUB","enum":["VIDEO_LIST_HUB","MULTI_VIDEO_EMBEDDED","SINGLE_VIDEO_EMBEDDED"]}}}]}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin","zoom_events:read:list_all_vod_channels","zoom_events:read:list_all_vod_channels:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin"],"x-granular-scopes":["zoom_events:read:list_all_vod_channels","zoom_events:read:list_all_vod_channels:admin"]}},"post":{"tags":["Video On-Demand"],"summary":"Create VOD channel","description":"Creates a channel for managing hub videos. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG).\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_channel`,`zoom_events:write:vod_channel:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createVodChannel","parameters":[{"name":"hubId","in":"path","description":"The ID of the hub.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"VOD Channel","required":["name","type"],"type":"object","properties":{"name":{"maxLength":75,"type":"string","description":"The name of the channel.","example":"FoodieFlicks"},"description":{"type":"string","description":"Channel description.","example":"A cinematic journey through the world of cuisine!."},"type":{"type":"string","description":"The channel type: \n * `VIDEO_LIST_HUB` - The channel content hosted on the Zoom Events platform.  \n * `MULTI_VIDEO_EMBEDDED` - The embedded video channel. The video channel ( with multiple videos) can be embedded on a third-party website. \n * `SINGLE_VIDEO_EMBEDDED` - The single video embedded channel. A single video can be embedded on a third-party website.","example":"VIDEO_LIST_HUB","enum":["VIDEO_LIST_HUB","MULTI_VIDEO_EMBEDDED","SINGLE_VIDEO_EMBEDDED"]}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \n VOD channel returned.","content":{"application/json":{"schema":{"title":"VOD Channel","type":"object","properties":{"channel_id":{"type":"string","description":"The VOD channel ID.","example":"iso9Dllddp39dagjLj9j"},"name":{"type":"string","description":"The name of the channel.","example":"FoodieFlicks"},"description":{"type":"string","description":"Channel description.","example":"A cinematic journey through th world of cuisine!."},"type":{"type":"string","description":"The channel type: \n * `VIDEO_LIST_HUB` - The channel content hosted on the Zoom Events platform.  \n * `MULTI_VIDEO_EMBEDDED` - The embedded video channel. The video channel (with multiple videos) can be embedded on a third-party website. \n * `SINGLE_VIDEO_EMBEDDED` - The single video embedded channel. A single video can be embedded on a third-party website.","example":"VIDEO_LIST_HUB","enum":["VIDEO_LIST_HUB","MULTI_VIDEO_EMBEDDED","SINGLE_VIDEO_EMBEDDED"]},"status":{"type":"string","description":"The VOD channel status. Embed type channels are published by default: \n * `PUBLISHED` - Published channel.\n * `DRAFT` - Draft channel.","example":"PUBLISHED","enum":["PUBLISHED","DRAFT"]},"is_published_to_hub":{"type":"boolean","description":"This field only applies to `VIDEO_LIST_HUB` type channel. This flag determines whether the content is visible on attendee facing hub profile page.","example":true}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Bad request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261104` <br>\n Video channel creation denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:write:vod_channel","zoom_events:write:vod_channel:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:write:vod_channel","zoom_events:write:vod_channel:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}":{"get":{"tags":["Video On-Demand"],"summary":"Get VOD channel details","description":"Returns VOD channel details.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_channel`,`zoom_events:read:vod_channel:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getVODChannelDetail","parameters":[{"name":"hubId","in":"path","description":"The ID of the hub.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"channelId","in":"path","description":"The VOD channel ID.","required":true,"schema":{"type":"string","example":"iso9Dllddp39dagjLj9j"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n VOD channel details retrieved successfully.","content":{"application/json":{"schema":{"title":"VOD Channel","type":"object","properties":{"channel_id":{"type":"string","description":"The VOD channel ID.","example":"iso9Dllddp39dagjLj9j"},"name":{"type":"string","description":"The name of the channel.","example":"FoodieFlicks"},"description":{"type":"string","description":"The description of the channel.","example":"A cinematic journey through the world of cuisine!."},"status":{"type":"string","description":"The VOD channel status. Embed type channels are published by default: \n * `PUBLISHED` - Published channel.\n * `DRAFT` - Draft channel.","example":"PUBLISHED","enum":["PUBLISHED","DRAFT"]},"is_published_to_hub":{"type":"boolean","description":"This field only applies to `VIDEO_LIST_HUB` type channels. This flag determines whether the content is visible on the attendee-facing hub profile page.","example":true},"type":{"type":"string","description":"The channel type: \n * `VIDEO_LIST_HUB` - The channel content hosted on the Zoom Events platform.  \n * `MULTI_VIDEO_EMBEDDED` - The embedded video channel. The video channel (with multiple videos) can be embedded on a third-party website. \n * `SINGLE_VIDEO_EMBEDDED` - The single video embedded channel. A single video can be embedded on a third-party website.","example":"VIDEO_LIST_HUB","enum":["VIDEO_LIST_HUB","MULTI_VIDEO_EMBEDDED","SINGLE_VIDEO_EMBEDDED"]},"embed_script":{"type":"string","description":"This field only applies to `SINGLE_VIDEO_EMBEDDED` and `MULTI_VIDEO_EMBEDDED` type channels. The channel content needs to be added and the script needs to be generated from the Zoom Events UI first. This script can be used to embed the VOD channel content in a third-party website. Please review the [documentation](https://developers.zoom.us/docs/zoom-events/vod-guide) for details on embeddable VOD channels.","example":"<script src=\"https: //gozestatic.zoom.us/zoomevents-vod-sdk/0.0.8/vod_embed_sdk/zoomVodEmbed.js\"></script><div class=\"zoom-embed\" style=\"width:100%;height:100%;\" data-channel-id=\"RAvxS3RWSVOjgchfA1porQ\" data-video-id=\"CsjUfFg5Tx6Lj08sjpu2yA\" data-embed-option=\"inline\" data-embed-display=\"\" data-domain=\"https: //goevents.zoom.us\"><img src=\"https://onzoomcontent3.zoom.us/img/default_session_image.jpg\" style=\"width:100%;\"></div>"},"channel_link":{"type":"string","description":"This field only applies to `VIDEO_LIST_HUB` type channels and the channel needs to be in `PUBLISHED` status. Attendees will access the channel details page via this [link](https://developers.zoom.us/docs/api/events/#tag/hubs/GET/zoom_events/hubs/{hubId}/videos).","example":"https://events.zoom.us/ej/AqXm3Kdn61-zHknD9faMn5TFBVAXx4zwQOeMbJkkI63GDBVz6znZ~A1dLQvAML0MYNyUw-UnzDCKI_Sw"},"settings":{"type":"object","properties":{"authentication_method":{"type":"string","description":"The authentication method to restrict content access to qualified users. This field only applies to `VIDEO_LIST_HUB` type channels. * `zoom_account` - Zoom account holder.  * `email_otp` - Sign in with an email OTP. \n * `bypass_auth` - Bypass authentication.","example":"bypass_auth","enum":["zoom_account","email_otp","bypass_auth"]},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The VOD channel registration is restricted to these specific domains. Enabling the allow list makes this channel private. Users must pass authentication to access the channel. Not applicable when the authentication method is `bypass_auth`.","items":{"type":"string","description":"Each domain can have up to 40 characters.","example":"zoom.us"}},"allow_email_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The VOD channel registration is restricted to users by email addresses. Enabling the allow list makes this channel private. Users must pass authentication to access the channel. Not applicable when the authentication method is `bypass_auth`.","items":{"type":"string","description":"Each email can have up to 60 characters.","example":"example1@email.com"}}},"description":"The channel settings"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Channel Not Found. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin","zoom_events:read:vod_channel","zoom_events:read:vod_channel:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin"],"x-granular-scopes":["zoom_events:read:vod_channel","zoom_events:read:vod_channel:admin"]}},"delete":{"tags":["Video On-Demand"],"summary":"Delete VOD Channel","description":"Deletes a video channel. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG).\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:vod_channel`,`zoom_events:delete:vod_channel:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DeleteVODChannel","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` Channel deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:delete:vod_channel","zoom_events:delete:vod_channel:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:delete:vod_channel","zoom_events:delete:vod_channel:admin"]}},"patch":{"tags":["Video On-Demand"],"summary":"Update VOD channel","description":"Updates a hub video channel. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG).\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_channel`,`zoom_events:update:vod_channel:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateVideoChannel","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"VOD Channel","type":"object","properties":{"name":{"maxLength":75,"type":"string","description":"The name of the channel.","example":"FoodieFlicks"},"description":{"type":"string","description":"Channel description.","example":"A cinematic journey through the world of cuisine!."},"settings":{"type":"object","properties":{"authentication_method":{"type":"string","description":"The authentication method to restrict content access to qualified users. This field only applies to `VIDEO_LIST_HUB` type channel. * `zoom_account` - Zoom account holder. * `email_otp` - Sign in with an email OTP. * `bypass_auth` - Bypass authentication.","example":"bypass_auth","enum":["zoom_account","email_otp","bypass_auth"]},"allow_domain_list":{"maxItems":20000,"type":"array","description":"The VOD channel registration is restricted to these specific domains. Enabling allow list makes this channel private. Users must pass authentication to access the channel. Not applicable when the authentication method is 'bypass_auth'.","items":{"type":"string","description":"Each domain can have up to 40 characters.","example":"zoom.us"}},"allow_email_list":{"maxItems":50000,"uniqueItems":true,"type":"array","description":"The VOD channel registration restricted to users by email addresses. Enabling allow list makes this channel private. Users must pass authentication to access the channel. Not applicable when the authentication method is 'bypass_auth'.","items":{"type":"string","description":"Each email can have up to 60 characters.","example":"example1@email.com"}}},"description":"The channel settings."}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \n Channel updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Request. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:update:vod_channel","zoom_events:update:vod_channel:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:update:vod_channel","zoom_events:update:vod_channel:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/actions":{"post":{"tags":["Video On-Demand"],"summary":" VOD channel actions","description":"Returns VOD channel action result.\n\n**Prerequisites**:\n* A Pro or higher account plan.\n* A Zoom Webinars Plus or Events license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_channel`,`zoom_events:update:vod_channel:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"vodChannelActions","parameters":[{"name":"hubId","in":"path","description":"The Hub ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}},{"name":"channelId","in":"path","description":"The VOD channel ID.","required":true,"schema":{"type":"string","example":"iso9Dllddp39dagjLj9j"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","description":"The host actions for the VOD channel. \n* `Publish` &mdash; Publish the VOD Channel.","example":"publish","enum":["publish"]}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n VOD Channel status returned.","content":{"application/json":{"schema":{"title":"VOD Channel","type":"object","properties":{"status":{"type":"string","description":"The status of the channel operation.","example":"published","enum":["published"]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD Channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:update:vod_channel","zoom_events:update:vod_channel:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:update:vod_channel","zoom_events:update:vod_channel:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/videos":{"get":{"tags":["Video On-Demand"],"summary":"List VOD channel videos","description":"Lists VOD channel videos.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_vod_channel_videos`,`zoom_events:read:list_vod_channel_videos:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListVODChannelVideos","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  Channel Video Information.","content":{"application/json":{"schema":{"title":"Channel videos pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of records in this page.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"videos":{"maxItems":300,"type":"array","description":"Channel Videos","items":{"description":"The list of videos for a channel.","allOf":[{"type":"object","properties":{"video_id":{"type":"string","description":"The Video ID.","example":"iso9Dllddp39dagjLj9j"},"name":{"type":"string","description":"The name of the video resource.","example":"My Recording1"},"status":{"type":"string","description":"The video status: \nOptions:\n * `processing` - Video is in processing status and not available for viewing yet.\n * `done` - Processing complete and available for viewing. \n * `unknown` - Processing status is unknown.","example":"processing","enum":["processing","done","unknown"]},"play_link":{"type":"string","description":"Video Play Link.","example":"https://abc/recording/unehd6TtTLuTN40owCOqqK"},"duration":{"type":"integer","description":"The video duration in minutes.","example":30}}}]}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin","zoom_events:read:list_vod_channel_videos","zoom_events:read:list_vod_channel_videos:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin"],"x-granular-scopes":["zoom_events:read:list_vod_channel_videos","zoom_events:read:list_vod_channel_videos:admin"]}},"post":{"tags":["Video On-Demand"],"summary":"Add VOD channel videos","description":"Adds videos to the VOD channel.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus / Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_channel_videos`,`zoom_events:write:vod_channel_videos:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"AddVODChannelVideos","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"VOD Channel Videos","required":["name","type"],"type":"object","properties":{"video_ids":{"maxItems":30,"type":"array","items":{"type":"string","description":"The video ID. Please check [List hub videos API](https://developers.zoom.us/docs/zoom-events/api/#operation/getHubList) for the ID.","example":"iso9Dllddp39dagjLj9j"}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` Videos added successfully.","content":{"application/json":{"schema":{"title":"Add videos result","type":"object","properties":{"errors":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"video_id":{"type":"string","description":"The ID of the video that failed.","example":"asdsf232354sta23423234"},"message":{"type":"string","description":"Error message.","example":"Not able to add this video."}},"description":"The list of added video failures."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:write:vod_channel_videos","zoom_events:write:vod_channel_videos:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:write:vod_channel_videos","zoom_events:write:vod_channel_videos:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/videos/{videoId}":{"delete":{"tags":["Video On-Demand"],"summary":"Delete VOD channel video","description":"Removes video from the VOD channel.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:vod_channel_videos`,`zoom_events:delete:vod_channel_videos:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DeleteVODChannelVideo","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}},{"name":"videoId","in":"path","description":"The video ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  Videos deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD Channel not found. <br>\n**Error Code:** `261102` <br>\n Video not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin","zoom_events:delete:vod_channel_videos","zoom_events:delete:vod_channel_videos:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin"],"x-granular-scopes":["zoom_events:delete:vod_channel_videos","zoom_events:delete:vod_channel_videos:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/registration_questions":{"get":{"tags":["Video On-Demand Registrations"],"summary":"Get VOD Registration Questions","description":"List registration questions and fields that are to be answered by users while registering for a vod channel. These questions are configured for the VOD channel after or before publishing the channel.\n\n**Prerequisites**\n* A Pro or higher account plan\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:read`,`zoom_events_vod_registration:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registration_questions`,`zoom_events:read:vod_registration_questions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getRegistrationQuestionsForVODChannel","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nSuccessfully retrieved registration questions.","content":{"application/json":{"schema":{"allOf":[{"title":"VOD Channel Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"The field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"Whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"The title of the question.","example":"Last Name"},"question_id":{"type":"string","description":"The ID of the question.","example":"Fn2rBZgJQzi6VIU--uWqnA"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"An array of registrant custom questions.","items":{"type":"object","properties":{"answers":{"maxItems":50,"type":"array","description":"An array of answer choices. It can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"Whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"The custom question.","example":"How are you?"},"question_id":{"type":"string","description":"The ID of the custom question.","example":"Fn2rBZgJQzi6VIU--uWqnA"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"minimum":1,"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"maximum":2000,"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"VOD channel registrant questions."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD Channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_registration:read","zoom_events_vod_registration:read:admin","zoom_events:read:vod_registration_questions","zoom_events:read:vod_registration_questions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_registration:read","zoom_events_vod_registration:read:admin"],"x-granular-scopes":["zoom_events:read:vod_registration_questions","zoom_events:read:vod_registration_questions:admin"]}},"put":{"tags":["Video On-Demand Registrations"],"summary":"update VOD channel registration questions","description":"Updates registration questions and fields that are to be answered by users while registering for a VOD channel. These questions are setup at VOD channel level.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:write`,`zoom_events_vod_registration:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_registration_questions`,`zoom_events:update:vod_registration_questions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateRegistrationQuestionsForVODchannel","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Event Registrant Questions","type":"object","properties":{"questions":{"maxItems":30,"type":"array","description":"Array of registration fields whose values should be provided by registrants during registration.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"The field name.","example":"last_name","enum":["first_name","last_name","address","city","state","zip","country","phone","industry","job_title","organization","organization_size"],"x-enum-descriptions":["First Name","Last Name","Address","City","State/Province","Zip/Postal Code","Country/Region","Phone","Industry","Job Title","Organization","Organization Size"]},"required":{"type":"boolean","description":"Whether the selected fields are required or optional.","example":true},"title":{"type":"string","description":"Title of the question.","example":"Last Name"}}}},"custom_questions":{"maxItems":100,"type":"array","description":"Array of registrant custom questions.","items":{"type":"object","properties":{"answers":{"maxItems":30,"type":"array","description":"An array of answer choices. Can't be used for short or long answer type.","items":{"type":"string","example":"Good"}},"required":{"type":"boolean","description":"State whether or not the custom question is required to be answered by a registrant.","example":true},"title":{"type":"string","description":"Custom question.","example":"How are you?"},"type":{"type":"string","description":"The question-answer type.","example":"short_answer","enum":["short_answer","long_answer","single_radio","single_dropdown","multiple_choice"],"x-enum-descriptions":["Short Answer","Long Answer","Single Radio Answer","Single Dropdown Answer","Multiple Answer"]},"min_length":{"minimum":1,"type":"integer","description":"The minimum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nIf this custom question is required then the min_length should be atleast 1.","example":500},"max_length":{"maximum":2000,"type":"integer","description":"The maximum length of the custom question answer. This is applicable for short_answer/long_answer question types. \nThe max_length should be greater than or equal min_length. The allowed max_length for short_answer is 500 and for long_answer is 2000.","example":2000}}}}},"description":"VOD channel registrant questions."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nSuccessfully updated registration questions."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `261101` <br>\n VOD channel not found. <br>\n**Error Code:** `2001` <br>\n Hub not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_registration:write","zoom_events_vod_registration:write:admin","zoom_events:update:vod_registration_questions","zoom_events:update:vod_registration_questions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_registration:write","zoom_events_vod_registration:write:admin"],"x-granular-scopes":["zoom_events:update:vod_registration_questions","zoom_events:update:vod_registration_questions:admin"]}}},"/zoom_events/hubs/{hubId}/vod_channels/{channelId}/registrations":{"get":{"tags":["Video On-Demand Registrations"],"summary":"List VOD Registration","description":"Retrieves the VOD registration information of a channel.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:read`,`zoom_events_vod_registration:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registrations`,`zoom_events:read:vod_registrations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListVODRegistration","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}},{"name":"email","in":"query","description":"The email of registrant.\n","required":false,"schema":{"type":"string","example":"test@example.com"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned in a single API call. Max 300.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n Registration Information.","content":{"application/json":{"schema":{"title":"VOD Registration pagination result","type":"object","properties":{"total_records":{"type":"number","description":"The total number of registrations.","example":1},"next_page_token":{"type":"string","description":"The next page token.","example":"yqT59YnBSHqvDdNnkeHQsA"},"registrations":{"maxItems":300,"type":"array","description":"Registrations","items":{"description":"The person who is registered for the event.","allOf":[{"type":"object","properties":{"registration_id":{"type":"string","description":"The unique registration ID.","example":"iso9Dllddp39dagjLj9j"},"email":{"type":"string","description":"The email address of the registrant","example":"email@zoom.us"},"join_link":{"type":"string","description":"The unique join link for the vod registratnt.","example":"https://events.zoom.us/ejl/xyz"},"authentication_method":{"type":"string","description":"The event authentication method for the registration: \n * `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication* `email_opt` registration using email OTP verification*  `zoom_account_otp_at_join` pre-registration using email OTP verification","example":"no_auth","enum":["zoom_account","zoom_account_otp","corporate_idp","no_auth","email_opt","zoom_account_otp_at_join"]}}},{"type":"object","properties":{"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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":{"maxLength":2,"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"comments":{"maxLength":255,"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."}},"description":"Standard question fields."},{"type":"object","properties":{"custom_questions":{"maxItems":100,"type":"array","description":"Information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}},"description":"Information about custom questions."}}}}]}}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD Channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_registration:read","zoom_events_vod_registration:read:admin","zoom_events:read:vod_registrations","zoom_events:read:vod_registrations:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_registration:read","zoom_events_vod_registration:read:admin"],"x-granular-scopes":["zoom_events:read:vod_registrations","zoom_events:read:vod_registrations:admin"]}},"post":{"tags":["Video On-Demand Registrations"],"summary":"VOD channel registration","description":"Creates registrations for a VOD channel. You can add a single registrant or up to 30 registrants in a batch operation.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:write`,`zoom_events_vod_registration:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_registration`,`zoom_events:write:vod_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"VODTicketRegistration","parameters":[{"name":"hubId","in":"path","description":"The hub ID.","required":true,"schema":{"type":"string","example":"4uzfv3JwTeyR5QpC3PXwMg"}},{"name":"channelId","in":"path","description":"The video channel ID.","required":true,"schema":{"type":"string","example":"csduzfv3JwTeyR5QpC3PXw52"}}],"requestBody":{"description":"The information about the VOD ticket request.\n","content":{"application/json":{"schema":{"type":"object","properties":{"registrations":{"maxItems":30,"required":["email"],"type":"array","description":"The registrant information.","items":{"required":["email"],"type":"object","properties":{"email":{"maxLength":128,"type":"string","description":"The email address used for the registration.","format":"email","example":"email@zoom.us"},"first_name":{"maxLength":64,"type":"string","description":"The registrant's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The registrant's last name.","example":"Chill"},"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"},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"organization":{"type":"string","description":"The registrant's organization.","example":"ABC Ltd."},"organization_size":{"type":"string","description":"The registrant's number of employees.","example":"150"},"custom_questions":{"maxItems":100,"type":"array","description":"The information about custom questions.","items":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"answer":{"type":"string","description":"The custom question's response value.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}}}}}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n \nThe list of tickets.","content":{"application/json":{"schema":{"type":"object","properties":{"registrations":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"registration_id":{"type":"string","description":"The unique registration ID.","example":"iso9Dllddp39dagjLj9j"},"email":{"type":"string","description":"The email address of the registrant","example":"email@zoom.us"},"join_link":{"type":"string","description":"The unique join link for the vod registratnt.","example":"https://events.zoom.us/ejl/xyz"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `260101` <br>\n Hub access denied. <br>\n**Error Code:** `261103` <br>\n Video channel access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Channel not found. \n\n **Error Code:** `2001` <br>\n Hub not found. <br>\n**Error Code:** `261101` <br>\n VOD Channel not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_vod_registration:write","zoom_events_vod_registration:write:admin","zoom_events:write:vod_registration","zoom_events:write:vod_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_vod_registration:write","zoom_events_vod_registration:write:admin"],"x-granular-scopes":["zoom_events:write:vod_registration","zoom_events:write:vod_registration:admin"]}}},"/zoom_events/videos/{videoId}/metadata":{"get":{"tags":["Videos"],"summary":"Get metadata for a specific video","description":"Retrieves metadata for a specific video, including title, description, duration, creation time, last updated time, and associated tags.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_videos:read`,`zoom_events_videos:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:video_metadata`,`zoom_events:read:video_metadata:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getVideoMetadata","parameters":[{"name":"videoId","in":"path","description":"The video ID.","required":true,"schema":{"type":"string","example":"kNqLPC6hSFiZ9NpgjA549w"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\n OK\n\nVideo metadata retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The name or title of the video.","example":"Keynote Session"},"description":{"maxLength":5000,"type":"string","description":"A detailed description or summary of the video content.","example":"Opening keynote for AI Summit 2025"},"duration":{"type":"integer","description":"The length of the video in seconds.","format":"int64","example":3600},"video_status":{"type":"string","description":"The processing status of the video.\n\n* `PROCESSING` - The video is currently being processed.\n* `COMPLETED` - The video has been processed successfully.\n* `OTHER` - The video status is unavailable, or not exposed.","example":"COMPLETED","enum":["PROCESSING","COMPLETED","OTHER"]},"video_created_at":{"type":"string","description":"The timestamp when the video was created.","format":"date-time","example":"2025-12-15T10:20:30Z"},"updated_at":{"type":"string","description":"The timestamp when the video metadata was last updated.","format":"date-time","example":"2025-12-29T14:45:00Z"},"tags":{"maxItems":30,"type":"array","description":"A list of tags or keywords associated with the video.","example":["AI","Keynote","Conference"],"items":{"maxLength":40,"type":"string"}},"categories":{"type":"array","description":"A list of hierarchical categories that classify the video. Each category can include multiple subcategories.","example":[{"name":"Technology","sub_categories":["AI","Machine Learning","Computer Vision"]},{"name":"Innovation","sub_categories":["Startups","Research"]}],"items":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the main category.","example":"Technology"},"sub_categories":{"type":"array","description":"A list of subcategories related to this main category, used for more granular classification and filtering.","example":["AI","Machine Learning","Deep Learning"],"items":{"type":"string"}}}}},"external_media_id":{"type":"string","description":"This field links the Migrated Media ID from an external system.","example":"legacy_vid_789"},"external_source_name":{"type":"string","description":"The name of the external source system from which this data was migrated.","example":"LegacyCMS"},"thumbnails":{"maxItems":5,"type":"array","description":"A list of thumbnail images associated with this video.","example":[{"file_id":"thumb123","file_url":"https://files.zoom.us/thumbnails/thumb123.jpg","is_default":true},{"file_id":"thumb124","file_url":"https://files.zoom.us/thumbnails/thumb124.jpg","is_default":false}],"items":{"type":"object","properties":{"file_id":{"type":"string","description":"The file reference ID for the thumbnail image.","example":"sdfasdfsadfasdg2werwrtt2"},"file_url":{"type":"string","description":"A public or pre-signed URL to download or view the thumbnail.","format":"uri","example":"https://files.zoom.us/thumbnails/thumb123.jpg"},"is_default":{"type":"boolean","description":"Indicates whether this thumbnail is set as the default.","example":true}}}},"speakers":{"type":"array","description":"A list of speakers associated with this video.","items":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The speaker's full name.","example":"John Doe"},"email":{"type":"string","description":"The speaker's email address.","format":"email","example":"abc.xyz@zoomdev.us"},"job_title":{"type":"string","description":"The speaker's job title.","example":"Chief Scientist, Zoom AI"},"biography":{"type":"string","description":"The speaker's biography.","example":"Dr. Jane Doe leads AI research at Zoom."},"company_name":{"type":"string","description":"The speaker's company name.","example":"Zoom Video Communications"},"company_website":{"type":"string","description":"The speaker's company website.","format":"uri","example":"https://zoom.us"}}}},"scheduling":{"type":"object","properties":{"start_time":{"type":"string","description":"The start time (UTC) when the video becomes available. When `start_time` is provided, the video becomes available only after this time. If `end_time` is not provided, the video remains available indefinitely after this time.","format":"date-time","example":"2026-02-20T08:00:00Z"},"end_time":{"type":"string","description":"The end time (UTC) when the video stops being available. When `end_time` is provided, the video becomes unavailable after this time. If `start_time` is not provided, the video is available immediately until this time.","format":"date-time","example":"2026-02-28T08:00:00Z"}},"additionalProperties":false,"description":"This field defines when the video becomes available and/or unavailable based on optional start and end times. Both timestamps are in UTC (ISO 8601).","example":{"start_time":"2026-02-20T08:00:00Z","end_time":"2026-02-28T08:00:00Z"}},"transcripts":{"type":"array","description":"A list of transcript files for this video.","example":[{"file_url":"https://files.zoom.us/transcripts/transcript_en.vtt","language":"en-US","is_default":true},{"file_url":"https://files.zoom.us/transcripts/transcript_fr.vtt","language":"fr-FR","is_default":false}],"items":{"type":"object","properties":{"file_url":{"type":"string","description":"A public or pre-signed URL to download the transcript file.","format":"uri","example":"https://files.zoom.us/transcripts/transcript_en.vtt"},"language":{"type":"string","description":"The language code (ISO 639-1 or BCP47).","example":"en-US"},"is_default":{"type":"boolean","description":"Whether this transcript file is the default caption file. The default transcript is displayed first by the player. When the first transcript file is uploaded, it automatically becomes the default regardless of whether this field is explicitly set.","example":true}}}},"resources":{"type":"array","description":"Supporting resource documents associated with the video (e.g., PDFs, DOCX, TXT).","example":[{"file_id":"xBvggqyjQUal6TecwMlYwE_001","file_url":"https://files.zoom.us/resources/res_pdf_001.pdf","file_name":"AI_Conference_Notes.pdf"},{"file_id":"xBvggqyjQUal6TecwMlYwE_002","file_url":"https://files.zoom.us/resources/res_doc_002.docx","file_name":"Speaker_Bio.docx"}],"items":{"type":"object","properties":{"file_id":{"type":"string","description":"The unique file reference ID from the file upload API.","example":"xBvggqyjQUal6TecwMlYwE_001"},"file_url":{"type":"string","description":"The downloadable URL for the resource file.","format":"uri","example":"https://files.zoom.us/resources/res_pdf_001.pdf"},"file_name":{"type":"string","description":"The display name of the file.","example":"Speaker_Bio.docx"}},"description":"Represents an attached resource document for a video."}},"custom_fields":{"type":"object","additionalProperties":true,"description":"A flexible key-value structure for additional custom metadata fields. This object supports arbitrary nesting for dynamic JSON structures, with a recommended maximum depth of 5 levels.","example":{"session_info":{"target_audience":["Students","Industry Representatives"],"sponsor":{"name":"ZoomTech","tier":"Gold"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `261107` <br>\n Video access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `261108` <br>\n Video/recording not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_videos:read","zoom_events_videos:read:admin","zoom_events:read:video_metadata","zoom_events:read:video_metadata:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_videos:read","zoom_events_videos:read:admin"],"x-granular-scopes":["zoom_events:read:video_metadata","zoom_events:read:video_metadata:admin"]}},"patch":{"tags":["Videos"],"summary":"Update metadata for a specific video","description":"Updates video metadata.\n\n**Prerequisites**\n\n* A Pro or higher account plan\n\n* A Zoom Webinars Plus or Events license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_videos:write`,`zoom_events_videos:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:video_metadata`,`zoom_events:update:video_metadata:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateVideoMetadata","parameters":[{"name":"videoId","in":"path","description":"The video ID.","required":true,"schema":{"type":"string","example":"34uzfv3JwTeyR5QpC3PXwMg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"maxLength":256,"type":"string","description":"The name or title of the video.","example":"Updated Keynote Title"},"description":{"maxLength":5000,"type":"string","description":"Detailed description or summary of the video content.","example":"Updated description text."},"tags":{"maxItems":30,"type":"array","description":"List of tags or keywords associated with the video.","example":["Conference","AI"],"items":{"maxLength":40,"type":"string"}},"categories":{"maxItems":20,"type":"array","description":"List of hierarchical categories that classify the video. Each category can include multiple subcategories.","example":[{"name":"Technology","sub_categories":["AI","Machine Learning","Computer Vision"]},{"name":"Innovation","sub_categories":["Startups","Research"]}],"items":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the main category.","example":"Technology"},"sub_categories":{"maxItems":20,"type":"array","description":"List of subcategories related to this main category. Used for more granular classification and filtering.","example":["AI","Machine Learning","Deep Learning"],"items":{"type":"string"}}}}},"external_media_id":{"maxLength":256,"type":"string","description":"Used to link the Migrated Media ID from an external system.","example":"legacy_vid_789"},"external_source_name":{"maxLength":256,"type":"string","description":"Used to track the source of this data in case of migration.","example":"LegacyCMS"},"thumbnails":{"maxItems":5,"type":"array","description":"Thumbnail metadata updates. Each entry references an uploaded file by file_id.","example":[{"file_id":"xBvggqyjQUal6TecwMlYwE123","is_default":true},{"file_id":"xBvggqyjQUal6TecwMlYwE456","is_default":false}],"items":{"required":["file_id"],"type":"object","properties":{"file_id":{"type":"string","description":"Unique file reference ID from the file upload API or from the get video metadata API.","example":"xBvggqyjQUal6TecwMlYwE123"},"is_default":{"type":"boolean","description":"Whether this thumbnail should be set as the default.","example":true}}}},"transcripts":{"type":"array","description":"Transcript file updates. Each entry references a file and includes a language code. The `video_status` must be `COMPLETED`, meaning the video has been processed successfully, before updating transcripts.","example":[{"file_id":"xBvggqyjQUal6TecwMlYwE8","language":"en-US","is_default":true},{"file_id":"xBvggqyjQUal6TecwMlYwE7","language":"fr-FR","is_default":false}],"items":{"required":["file_id","language"],"type":"object","properties":{"file_id":{"type":"string","description":"Unique file reference ID from the file upload API.","example":"xBvggqyjQUal6TecwMlYwE8"},"language":{"type":"string","description":"Language code (ISO 639-1 or BCP47)","example":"en-US"},"is_default":{"type":"boolean","description":"Indicates whether this transcript file is the default caption file. The default transcript is displayed first by the player. When the first transcript file is uploaded, it automatically becomes the default regardless of whether this field is explicitly set.","example":true}}}},"speakers":{"maxItems":10,"type":"array","description":"List of speakers associated with this video.","items":{"required":["name"],"type":"object","properties":{"name":{"maxLength":128,"type":"string","description":"The speaker's full name.","example":"John Doe"},"email":{"type":"string","description":"The speaker's email address.","format":"email","example":"abc.xyz@zoomdev.us"},"job_title":{"maxLength":128,"type":"string","description":"The speaker's job title.","example":"Chief Scientist, Zoom AI"},"biography":{"maxLength":2000,"type":"string","description":"The speaker's biography.","example":"Dr. Jane Doe leads AI research at Zoom."},"company_name":{"maxLength":128,"type":"string","description":"The speaker's company name.","example":"Zoom Video Communications"},"company_website":{"type":"string","description":"The speaker's company website URL.","format":"uri","example":"https://zoom.us"}}}},"scheduling":{"type":"object","properties":{"start_time":{"type":"string","description":"The start time (UTC) when the video becomes available. When 'start_time' is provided, the video becomes available only after this time. If 'end_time' is not provided, the video remains available indefinitely after this time.","format":"date-time","example":"2026-02-20T08:00:00Z"},"end_time":{"type":"string","description":"The end time (UTC) when the video stops being available. When 'end_time' is provided, the video becomes unavailable after this time. If 'start_time' is not provided, the video is available immediately until this time.","format":"date-time","example":"2026-02-28T08:00:00Z"}},"additionalProperties":false,"description":"Defines when the video becomes available and/or unavailable based on optional start and end times. Both timestamps are in UTC (ISO 8601).","example":{"start_time":"2026-02-20T08:00:00Z","end_time":"2026-02-28T08:00:00Z"}},"resources":{"maxItems":10,"type":"array","description":"Supporting resources (e.g., PDFs, DOCX). Each entry references an uploaded file.","example":[{"file_id":"rxBvggqyjQUal6TecwMlYwE001"},{"file_id":"xBvggqyjQUal6TecwMlYwE002"}],"items":{"required":["file_id"],"type":"object","properties":{"file_id":{"type":"string","description":"Unique file reference ID from the file upload API or from the get video metadata API.","example":"rxBvggqyjQUal6TecwMlYwE001"}}}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Flexible key-value structure for additional custom metadata fields. This object supports arbitrary nesting for dynamic JSON structures, with a maximum depth of 5 levels.","example":{"session_info":{"target_audience":["Students","Industry Representatives"],"sponsor":{"name":"ZoomTech","tier":"Gold"}}}}},"additionalProperties":false,"description":"Metadata fields to update for the given video."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \n Video metadata updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `261107` <br>\n Video access denied. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `261108` <br>\n Video/recording not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_events_videos:write","zoom_events_videos:write:admin","zoom_events:update:video_metadata","zoom_events:update:video_metadata:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_events_videos:write","zoom_events_videos:write:admin"],"x-granular-scopes":["zoom_events:update:video_metadata","zoom_events:update:video_metadata:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"zoom_events_attendee_actions:read":"zoom_events_attendee_actions:read","zoom_events_attendee_actions:read:admin":"zoom_events_attendee_actions:read:admin","zoom_events:read:list_attendee_actions":"zoom_events:read:list_attendee_actions","zoom_events:read:list_attendee_actions:admin":"zoom_events:read:list_attendee_actions:admin","zoom_events_attendee_actions:write":"zoom_events_attendee_actions:write","zoom_events_attendee_actions:write:admin":"zoom_events_attendee_actions:write:admin","zoom_events:update:batch_attendee_actions":"zoom_events:update:batch_attendee_actions","zoom_events:update:batch_attendee_actions:admin":"zoom_events:update:batch_attendee_actions:admin","zoom_events:update:batch_session_attendee_actions":"zoom_events:update:batch_session_attendee_actions","zoom_events:update:batch_session_attendee_actions:admin":"zoom_events:update:batch_session_attendee_actions:admin","zoom_events:read:list_session_attendee_actions":"zoom_events:read:list_session_attendee_actions","zoom_events:read:list_session_attendee_actions:admin":"zoom_events:read:list_session_attendee_actions:admin","zoom_events_coeditor:write":"zoom_events_coeditor:write","zoom_events_coeditor:write:admin":"zoom_events_coeditor:write:admin","zoom_events:write:coeditor":"zoom_events:write:coeditor","zoom_events:write:coeditor:admin":"zoom_events:write:coeditor:admin","zoom_events_coeditors:read":"zoom_events_coeditors:read","zoom_events_coeditors:read:admin":"zoom_events_coeditors:read:admin","zoom_events:read:list_coeditors":"zoom_events:read:list_coeditors","zoom_events:read:list_coeditors:admin":"zoom_events:read:list_coeditors:admin","zoom_events_email:read":"zoom_events_email:read","zoom_events_email:read:admin":"zoom_events_email:read:admin","zoom_events:read:list_email_types":"zoom_events:read:list_email_types","zoom_events:read:list_email_types:admin":"zoom_events:read:list_email_types:admin","zoom_events:read:list_emails_status":"zoom_events:read:list_emails_status","zoom_events:read:list_emails_status:admin":"zoom_events:read:list_emails_status:admin","zoom_events_access_links:write":"zoom_events_access_links:write","zoom_events_access_links:write:admin":"zoom_events_access_links:write:admin","zoom_events:write:access_links":"zoom_events:write:access_links","zoom_events:write:access_links:admin":"zoom_events:write:access_links:admin","zoom_events_access_links:read:admin":"zoom_events_access_links:read:admin","zoom_events_access_links:read":"zoom_events_access_links:read","zoom_events:read:list_access_links":"zoom_events:read:list_access_links","zoom_events:read:list_access_links:admin":"zoom_events:read:list_access_links:admin","zoom_events:update:access_links":"zoom_events:update:access_links","zoom_events:update:access_links:admin":"zoom_events:update:access_links:admin","zoom_events:delete:access_links":"zoom_events:delete:access_links","zoom_events:delete:access_links:admin":"zoom_events:delete:access_links:admin","zoom_events:read:access_links":"zoom_events:read:access_links","zoom_events:read:access_links:admin":"zoom_events:read:access_links:admin","zoom_events_basic:write":"zoom_events_basic:write","zoom_events_basic:write:admin":"zoom_events_basic:write:admin","zoom_events:write:event":"zoom_events:write:event","zoom_events:write:event:admin":"zoom_events:write:event:admin","zoom_events_basic:read":"zoom_events_basic:read","zoom_events_basic:read:admin":"zoom_events_basic:read:admin","zoom_events:read:list_events":"zoom_events:read:list_events","zoom_events:read:list_events:admin":"zoom_events:read:list_events:admin","zoom_events:update:event":"zoom_events:update:event","zoom_events:update:event:admin":"zoom_events:update:event:admin","zoom_events:read:event":"zoom_events:read:event","zoom_events:read:event:admin":"zoom_events:read:event:admin","zoom_events:delete:event":"zoom_events:delete:event","zoom_events:delete:event:admin":"zoom_events:delete:event:admin","zoom_events_exhibitors:write":"zoom_events_exhibitors:write","zoom_events_exhibitors:write:admin":"zoom_events_exhibitors:write:admin","zoom_events:write:exhibitor":"zoom_events:write:exhibitor","zoom_events:write:exhibitor:admin":"zoom_events:write:exhibitor:admin","zoom_events_exhibitors:read:admin":"zoom_events_exhibitors:read:admin","zoom_events_exhibitors:read":"zoom_events_exhibitors:read","zoom_events:read:list_exhibitors":"zoom_events:read:list_exhibitors","zoom_events:read:list_exhibitors:admin":"zoom_events:read:list_exhibitors:admin","zoom_events:update:exhibitor":"zoom_events:update:exhibitor","zoom_events:update:exhibitor:admin":"zoom_events:update:exhibitor:admin","zoom_events:delete:exhibitor":"zoom_events:delete:exhibitor","zoom_events:delete:exhibitor:admin":"zoom_events:delete:exhibitor:admin","zoom_events:read:exhibitor":"zoom_events:read:exhibitor","zoom_events:read:exhibitor:admin":"zoom_events:read:exhibitor:admin","zoom_events:read:list_sponsor_tiers":"zoom_events:read:list_sponsor_tiers","zoom_events:read:list_sponsor_tiers:admin":"zoom_events:read:list_sponsor_tiers:admin","zoom_events_file:write":"zoom_events_file:write","zoom_events_file:write:admin":"zoom_events_file:write:admin","zoom_events:write:file_upload":"zoom_events:write:file_upload","zoom_events:write:file_upload:admin":"zoom_events:write:file_upload:admin","zoom_events_hubs:read":"zoom_events_hubs:read","zoom_events_hubs:read:admin":"zoom_events_hubs:read:admin","zoom_events:read:list_hubs":"zoom_events:read:list_hubs","zoom_events:read:list_hubs:admin":"zoom_events:read:list_hubs:admin","zoom_events:read:list_hub_hosts":"zoom_events:read:list_hub_hosts","zoom_events:read:list_hub_hosts:admin":"zoom_events:read:list_hub_hosts:admin","zoom_events_hub:write":"zoom_events_hub:write","zoom_events_hub:write:admin":"zoom_events_hub:write:admin","zoom_events:write:hub_host":"zoom_events:write:hub_host","zoom_events:write:hub_host:admin":"zoom_events:write:hub_host:admin","zoom_events:delete:hub_host":"zoom_events:delete:hub_host","zoom_events:delete:hub_host:admin":"zoom_events:delete:hub_host:admin","zoom_events:read:list_hub_videos":"zoom_events:read:list_hub_videos","zoom_events:read:list_hub_videos:admin":"zoom_events:read:list_hub_videos:admin","zoom_events_insights:read":"zoom_events_insights:read","zoom_events_insights:read:admin":"zoom_events_insights:read:admin","zoom_events:read:attendee_engagement":"zoom_events:read:attendee_engagement","zoom_events:read:attendee_engagement:admin":"zoom_events:read:attendee_engagement:admin","zoom_events_registrants:read":"zoom_events_registrants:read","zoom_events_registrants:read:admin":"zoom_events_registrants:read:admin","zoom_events:read:list_registrants":"zoom_events:read:list_registrants","zoom_events:read:list_registrants:admin":"zoom_events:read:list_registrants:admin","zoom_events:read:list_session_attendees":"zoom_events:read:list_session_attendees","zoom_events:read:list_session_attendees:admin":"zoom_events:read:list_session_attendees:admin","zoom_events_reports:read":"zoom_events_reports:read","zoom_events_reports:read:admin":"zoom_events_reports:read:admin","zoom_events:read:chat_transcripts":"zoom_events:read:chat_transcripts","zoom_events:read:chat_transcripts:admin":"zoom_events:read:chat_transcripts:admin","zoom_events:read:custom_report":"zoom_events:read:custom_report","zoom_events:read:custom_report:admin":"zoom_events:read:custom_report:admin","zoom_events:read:event_attendance":"zoom_events:read:event_attendance","zoom_events:read:event_attendance:admin":"zoom_events:read:event_attendance:admin","zoom_events:read:session_attendance":"zoom_events:read:session_attendance","zoom_events:read:session_attendance:admin":"zoom_events:read:session_attendance:admin","zoom_events:read:list_session_surveys":"zoom_events:read:list_session_surveys","zoom_events:read:list_session_surveys:admin":"zoom_events:read:list_session_surveys:admin","zoom_events:read:event_registration":"zoom_events:read:event_registration","zoom_events:read:event_registration:admin":"zoom_events:read:event_registration:admin","zoom_events_vod_reports:read":"zoom_events_vod_reports:read","zoom_events_vod_reports:read:admin":"zoom_events_vod_reports:read:admin","zoom_events:read:vod_registrations":"zoom_events:read:vod_registrations","zoom_events:read:vod_registrations:admin":"zoom_events:read:vod_registrations:admin","zoom_events_sessions:write:admin":"zoom_events_sessions:write:admin","zoom_events_sessions:write":"zoom_events_sessions:write","zoom_events:write:session":"zoom_events:write:session","zoom_events:write:session:admin":"zoom_events:write:session:admin","zoom_events_sessions:read":"zoom_events_sessions:read","zoom_events_sessions:read:admin":"zoom_events_sessions:read:admin","zoom_events:read:list_sessions":"zoom_events:read:list_sessions","zoom_events:read:list_sessions:admin":"zoom_events:read:list_sessions:admin","zoom_events:update:session":"zoom_events:update:session","zoom_events:update:session:admin":"zoom_events:update:session:admin","zoom_events:delete:session":"zoom_events:delete:session","zoom_events:delete:session:admin":"zoom_events:delete:session:admin","zoom_events:read:session":"zoom_events:read:session","zoom_events:read:session:admin":"zoom_events:read:session:admin","zoom_events:update:session_interpreter":"zoom_events:update:session_interpreter","zoom_events:update:session_interpreter:admin":"zoom_events:update:session_interpreter:admin","zoom_events:read:list_session_interpreters":"zoom_events:read:list_session_interpreters","zoom_events:read:list_session_interpreters:admin":"zoom_events:read:list_session_interpreters:admin","zoom_events:read:session_token":"zoom_events:read:session_token","zoom_events:read:session_token:admin":"zoom_events:read:session_token:admin","zoom_events:update:session_livestream_config":"zoom_events:update:session_livestream_config","zoom_events:update:session_livestream_config:admin":"zoom_events:update:session_livestream_config:admin","zoom_events:read:session_livestream_config":"zoom_events:read:session_livestream_config","zoom_events:read:session_livestream_config:admin":"zoom_events:read:session_livestream_config:admin","zoom_events:update:session_poll":"zoom_events:update:session_poll","zoom_events:update:session_poll:admin":"zoom_events:update:session_poll:admin","zoom_events:read:list_session_polls":"zoom_events:read:list_session_polls","zoom_events:read:list_session_polls:admin":"zoom_events:read:list_session_polls:admin","zoom_events:read:list_session_reservations":"zoom_events:read:list_session_reservations","zoom_events:read:list_session_reservations:admin":"zoom_events:read:list_session_reservations:admin","zoom_events:delete:session_reservations":"zoom_events:delete:session_reservations","zoom_events:delete:session_reservations:admin":"zoom_events:delete:session_reservations:admin","zoom_events:write:session_reservations":"zoom_events:write:session_reservations","zoom_events:write:session_reservations:admin":"zoom_events:write:session_reservations:admin","zoom_events_speakers:write":"zoom_events_speakers:write","zoom_events_speakers:write:admin":"zoom_events_speakers:write:admin","zoom_events:write:speaker":"zoom_events:write:speaker","zoom_events:write:speaker:admin":"zoom_events:write:speaker:admin","zoom_events_speakers:read":"zoom_events_speakers:read","zoom_events_speakers:read:admin":"zoom_events_speakers:read:admin","zoom_events:read:list_speakers":"zoom_events:read:list_speakers","zoom_events:read:list_speakers:admin":"zoom_events:read:list_speakers:admin","zoom_events:update:speaker":"zoom_events:update:speaker","zoom_events:update:speaker:admin":"zoom_events:update:speaker:admin","zoom_events:delete:speaker":"zoom_events:delete:speaker","zoom_events:delete:speaker:admin":"zoom_events:delete:speaker:admin","zoom_events:read:speaker":"zoom_events:read:speaker","zoom_events:read:speaker:admin":"zoom_events:read:speaker:admin","zoom_events_ticket_types:read":"zoom_events_ticket_types:read","zoom_events_ticket_types:read:admin":"zoom_events_ticket_types:read:admin","zoom_events:read:list_registration_questions":"zoom_events:read:list_registration_questions","zoom_events:read:list_registration_questions:admin":"zoom_events:read:list_registration_questions:admin","zoom_events_ticket_types:write":"zoom_events_ticket_types:write","zoom_events_ticket_types:write:admin":"zoom_events_ticket_types:write:admin","zoom_events:update:registraion_question":"zoom_events:update:registraion_question","zoom_events:update:registraion_question:admin":"zoom_events:update:registraion_question:admin","zoom_events:read:list_ticket_types":"zoom_events:read:list_ticket_types","zoom_events:read:list_ticket_types:admin":"zoom_events:read:list_ticket_types:admin","zoom_events:write:ticket_type":"zoom_events:write:ticket_type","zoom_events:write:ticket_type:admin":"zoom_events:write:ticket_type:admin","zoom_events:delete:ticket_type":"zoom_events:delete:ticket_type","zoom_events:delete:ticket_type:admin":"zoom_events:delete:ticket_type:admin","zoom_events:update:ticket_type":"zoom_events:update:ticket_type","zoom_events:update:ticket_type:admin":"zoom_events:update:ticket_type:admin","zoom_events_tickets:read":"zoom_events_tickets:read","zoom_events_tickets:read:admin":"zoom_events_tickets:read:admin","zoom_events:read:list_tickets":"zoom_events:read:list_tickets","zoom_events:read:list_tickets:admin":"zoom_events:read:list_tickets:admin","zoom_events_tickets:write":"zoom_events_tickets:write","zoom_events_tickets:write:admin":"zoom_events_tickets:write:admin","zoom_events:write:ticket":"zoom_events:write:ticket","zoom_events:write:ticket:admin":"zoom_events:write:ticket:admin","zoom_events:read:ticket":"zoom_events:read:ticket","zoom_events:read:ticket:admin":"zoom_events:read:ticket:admin","zoom_events:delete:ticket":"zoom_events:delete:ticket","zoom_events:delete:ticket:admin":"zoom_events:delete:ticket:admin","zoom_events_vod_channels:read":"zoom_events_vod_channels:read","zoom_events_vod_channels:read:admin":"zoom_events_vod_channels:read:admin","zoom_events:read:list_all_vod_channels":"zoom_events:read:list_all_vod_channels","zoom_events:read:list_all_vod_channels:admin":"zoom_events:read:list_all_vod_channels:admin","zoom_events_vod_channels:write":"zoom_events_vod_channels:write","zoom_events_vod_channels:write:admin":"zoom_events_vod_channels:write:admin","zoom_events:write:vod_channel":"zoom_events:write:vod_channel","zoom_events:write:vod_channel:admin":"zoom_events:write:vod_channel:admin","zoom_events:read:vod_channel":"zoom_events:read:vod_channel","zoom_events:read:vod_channel:admin":"zoom_events:read:vod_channel:admin","zoom_events:delete:vod_channel":"zoom_events:delete:vod_channel","zoom_events:delete:vod_channel:admin":"zoom_events:delete:vod_channel:admin","zoom_events:update:vod_channel":"zoom_events:update:vod_channel","zoom_events:update:vod_channel:admin":"zoom_events:update:vod_channel:admin","zoom_events:read:list_vod_channel_videos":"zoom_events:read:list_vod_channel_videos","zoom_events:read:list_vod_channel_videos:admin":"zoom_events:read:list_vod_channel_videos:admin","zoom_events:write:vod_channel_videos":"zoom_events:write:vod_channel_videos","zoom_events:write:vod_channel_videos:admin":"zoom_events:write:vod_channel_videos:admin","zoom_events:delete:vod_channel_videos":"zoom_events:delete:vod_channel_videos","zoom_events:delete:vod_channel_videos:admin":"zoom_events:delete:vod_channel_videos:admin","zoom_events_vod_registration:write":"zoom_events_vod_registration:write","zoom_events_vod_registration:write:admin":"zoom_events_vod_registration:write:admin","zoom_events:update:vod_registration_questions":"zoom_events:update:vod_registration_questions","zoom_events:update:vod_registration_questions:admin":"zoom_events:update:vod_registration_questions:admin","zoom_events_vod_registration:read":"zoom_events_vod_registration:read","zoom_events_vod_registration:read:admin":"zoom_events_vod_registration:read:admin","zoom_events:read:vod_registration_questions":"zoom_events:read:vod_registration_questions","zoom_events:read:vod_registration_questions:admin":"zoom_events:read:vod_registration_questions:admin","zoom_events:write:vod_registration":"zoom_events:write:vod_registration","zoom_events:write:vod_registration:admin":"zoom_events:write:vod_registration:admin","zoom_events_videos:read":"zoom_events_videos:read","zoom_events_videos:read:admin":"zoom_events_videos:read:admin","zoom_events:read:video_metadata":"zoom_events:read:video_metadata","zoom_events:read:video_metadata:admin":"zoom_events:read:video_metadata:admin","zoom_events_videos:write":"zoom_events_videos:write","zoom_events_videos:write:admin":"zoom_events_videos:write:admin","zoom_events:update:video_metadata":"zoom_events:update:video_metadata","zoom_events:update:video_metadata:admin":"zoom_events:update:video_metadata:admin"}}}}}}}