Skip to main content

Zoom Component

Easily manage users, meetings, and webinars in your Zoom account

Component key: zoom

Description#

Zoom is a proprietary video teleconferencing software program developed by Zoom Video Communications. The Zoom component allows you to manage Users meetings, and webinars in your Zoom account.

Authorization Notes#

The Zoom component supports API key and OAuth 2.0.

API Key#

To Authenticate with the Zoom API, you must first create an application in the Zoom Developer Portal Once through the configuration you will be greeted with a screen that displays your access token, remember this value. NOw, create a credential in prismatic of type API key, and provide the token from Zoom.

OAuth 2.0#

The Zoom component authenticates requests with OAuth 2.0. To configure an application inside zendesk follow the directions in this guide Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID enter in the clientId of your app inside the Zoom developer console.
  • For Client Secret enter the client secret you received from the Zoom developer console.
  • For Scopes refer to the guide provided by the Zoom documentation. There is detailed information on picking the correct scope.
  • For Authorization URL enter https://zoom.us/oauth/authorize
  • For Access Token URL enter https://zoom.us/oauth/token

For additional information surrounding OAuth 2.0 flows with Zoom, refer to the Zoom REST API Docs

Actions#

Add Meeting Registrant#

Add a new registrant to an existing meeting | key: addMeetingRegistrant

InputKeyNotesExample

Address

string
addressProvide a string value for the address.122 S Privet dr

City

string
cityProvide a string value for the citySan Jose

Comments

string
commentsProvide a string value for comments.These are some example comments.

Country

string
countryProvide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countriesUS

Email

string
/ Required
emailProvide a valid email address.someone@example.com

First Name

string
/ Required
firstNameProvide a string value for the first name.John

Industry

string
industryProvide a string value for their industryComputer Software

Job Title

string
jobTitleProvide a string value for the job title.Graphic Designer

Last Name

string
/ Required
lastNameProvide a string value for the last nameDoe

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Number Of Employees

string
numberOfEmployeesProvide a value form the supplied list.

Organization

string
orgProvide a string value for the organization.Acme Inc.

Phone

string
phoneProvide a string value for the phone number.15558904949

Purchasing Time Frame

string
purchasingTimeFrameProvide a string value for time frame they will purchase. For more information about this value refer to the Zoom API docs: https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrantcreateWithin a month

Role In Purchase Process

string
roleInPurchaseProcessProvide a string value for the registrants role in the purchase process.

State

string
stateProvide a string value for the state or province.California

Zip Code

string
zipProvide a string value for the zipcode90210

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Add Webinar Registrant#

Add a new registrant of an existing webinar | key: addWebinarRegistrant

InputKeyNotesExample

Address

string
addressProvide a string value for the address.122 S Privet dr

City

string
cityProvide a string value for the citySan Jose

Comments

string
commentsProvide a string value for comments.These are some example comments.

Country

string
countryProvide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countriesUS

Email

string
/ Required
emailProvide a valid email address.someone@example.com

First Name

string
/ Required
firstNameProvide a string value for the first name.John

Industry

string
industryProvide a string value for their industryComputer Software

Job Title

string
jobTitleProvide a string value for the job title.Graphic Designer

Last Name

string
/ Required
lastNameProvide a string value for the last nameDoe

Number Of Employees

string
numberOfEmployeesProvide a value form the supplied list.

Organization

string
orgProvide a string value for the organization.Acme Inc.

Phone

string
phoneProvide a string value for the phone number.15558904949

Purchasing Time Frame

string
purchasingTimeFrameProvide a string value for time frame they will purchase. For more information about this value refer to the Zoom API docs: https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrantcreateWithin a month

Role In Purchase Process

string
roleInPurchaseProcessProvide a string value for the registrants role in the purchase process.

State

string
stateProvide a string value for the state or province.California

Webinar Id

string
/ Required
webinarIdProvide the unique identifier of a webinar.89347503

Zip Code

string
zipProvide a string value for the zipcode90210

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Meeting#

Create a new meeting with an existing user as the host | key: createMeeting

InputKeyDefaultNotesExample

Agenda

string
agendaProvide a string value for the agenda. This property has a maximum length of 2,000 characters.In this meeting we will discuss...

Approval Type

string
approvalType2This flag will determine the approval type of the meeting.

Audio Method

string
audioThis flag will determine if participants audio used telephony or VoIP

Auto Recording

string
autoRecordingnoneThis value will determine your automatic recording settings.

Global Dial In Countries

string
Value List
availableDialInCountriesFor each item specify the code of a country that is available for global dial in.

Duration

string
durationProvide a value for the duration in minutes. This field is only used for scheduled meetings.60

End Date Time

string
endDateTimeProvide a valid date time value for when the last meeting will occur.2017-11-25-T12:00:00Z

Host Video On Start

boolean
hostVideoThis flag will determine if the host's video is turned on by default.

Time To Join Before Host

string
jbhTimeIf joinBeforeHost is true, supply one of the given values.

Join Before Host

boolean
joinBeforeHostThis flag will determine if participants are allowed to join before the host.

Meeting Type

string
meetingTypeProvide a value from the provided list.

Monthly Day

string
monthlyDayProvide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected type 3 for recurrence. 15

Monthly Week

string
monthlyWeekProvide a value for the week of the month you would like your meeting to occur on. This field is required if you selected type 3 for recurrence.

Monthly Week Day

string
monthlyWeekDayProvide a value from 1-7 to determine which days of the day of the week your monthly meeting will occur on. You must also provide a value for monthly week. For instance if you want your meeting to occur every Tuesday and Sunday, provide '1, 3'. This field is required if you selected type 2 for recurrence. 1

Mute Upon Entry

boolean
muteUponEntryThis flag will determine if participants are muted by default when they join.

Participant Video

boolean
participantVideoThis flag will determine if participants video is turned on by default.

Password

string
passwordProvide a value up to 10 characters for the password.examplePass

Recurrence

string
/ Required
recurrencePick a value from the provided list.

Registration Email Notifications

boolean
registrationEmailNotificationsThis flag will determine whether or not to send an email notification upon registration.

Registration Type

string
registrationTypeProvide a value from the provided list.

Repeat Interval

string
repeatIntervalThis value relates to the cadence at which your meetings will occur. This value directly related to recurrence. For more information on this value and how it affects your meetings, refer to the Zoom documentation: https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate1

Start Time

string
startTimeProvide a value for the start time of the meeting. Provide your value in the following format: yyyy-MM-ddTHH:mm:ssZ2021-12-15T12:02:00Z

Timezone

string
timezoneProvide a string value for a valid timezone. Refer to the Id value in the timezone list: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezonesAmerica/New_York

Topic

string
topicProvide a string value for the topic.Daily Meeting

Use Personal Meeting ID

boolean
usePMIThis flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Use Watermark

boolean
watermarkThis flag will determine if a watermark will be displayed on screen share.

Weekly Day

string
weeklyDayProvide a value from 1-7 to determine which days of the week your meeting will occur on. You can also provide a string of comma separated integers. For instance if you want your meeting to occur every Tuesday and Sunday, provide '1, 3'. This field is required if you selected type 2 for recurrence. 1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "meetings": [      {        "uuid": "example/PiXZTLiwZLisi+dL+g==",        "id": 87272670533,        "host_id": "example_6cTCWFHEE20SifVg",        "topic": "Daily Meeting",        "type": 2,        "start_time": "2021-12-15T12:02:00Z",        "duration": 60,        "timezone": "America/Chicago",        "created_at": "2021-12-01T20:30:47Z",        "join_url": "https://example.zoom.us/j/87272670532?pwd=UE8xd2NBT0Q3TVpKMGU0WUtuSnI2Zz09"      }    ]  }}

Create User#

Create a new user | key: createUser

InputKeyDefaultNotesExample

Email

string
/ Required
emailProvide a valid email address.someone@example.com

First Name

string
/ Required
firstNameProvide a string value for the first name.John

Last Name

string
/ Required
lastNameProvide a string value for the last nameDoe

User Action

string
/ Required
userActioncreateThis value represents the method used to create the user.

User Type

string
/ Required
userTypeThe value provided will determine the type of user that will be created.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "users": [      {        "id": "exampleUserId",        "first_name": "John",        "last_name": "Doe",        "email": "someone@example.com",        "type": 1,        "pmi": 12345,        "timezone": "America/Chicago",        "verified": 1,        "created_at": "2021-11-18-T20:49:06Z",        "status": "active",        "role_id": 0      }    ]  }}

Delete User#

Delete the information and metadata of a user by Id | key: deleteUser

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Accounts Phone Recordings#

Get the information and metadata of all recordings by Account | key: getAccountsPhoneRecordings

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Meeting#

Get the information and metadata of a meeting by Id | key: getMeeting

InputKeyNotesExample

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "meetings": [      {        "uuid": "example/PiXZTLiwZLisi+dL+g==",        "id": 87272670533,        "host_id": "example_6cTCWFHEE20SifVg",        "topic": "Daily Meeting",        "type": 2,        "start_time": "2021-12-15T12:02:00Z",        "duration": 60,        "timezone": "America/Chicago",        "created_at": "2021-12-01T20:30:47Z",        "join_url": "https://example.zoom.us/j/87272670532?pwd=UE8xd2NBT0Q3TVpKMGU0WUtuSnI2Zz09"      }    ]  }}

Get Meeting Invitation#

Get an invitation for a meeting | key: getMeetingInvitation

InputKeyNotesExample

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "invitation": "\n      John Doe is inviting you to a scheduled Zoom meeting.\n\n      Topic: This is an example topic!\n      Time: This is a recurring meeting Meet anytime\n\n      Join Zoom Meeting\n      https://us05web.zoom.us/j/87634730132?pwd=bGIycHczQWc0djdnaXZSTkJnOWJWZz09\n\n      Meeting ID: 876 3473 0132\n      Passcode: examplePassword\n      "  }}

Get Meeting Recordings#

Get a list of all recordings of a meeting | key: getMeetingRecordings

InputKeyNotesExample

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Phone Recordings#

List all of the given users call recordings | key: getPhoneRecordings

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get User#

Get the information and metadata of a user by Id | key: getUser

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "users": [      {        "id": "exampleUserId",        "first_name": "John",        "last_name": "Doe",        "email": "someone@example.com",        "type": 1,        "pmi": 12345,        "timezone": "America/Chicago",        "verified": 1,        "created_at": "2021-11-18-T20:49:06Z",        "status": "active",        "role_id": 0      }    ]  }}

Get Users Phone Recordings#

List all phone recordings by a given user | key: getUsersPhoneRecordings

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Webinar#

Get the information and metadata of a webinar by Id | key: getWebinar

InputKeyNotesExample

Webinar Id

string
/ Required
webinarIdProvide the unique identifier of a webinar.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Meeting Registrants#

Get the information and metadata of all registrants to a meeting by Id | key: listMeetingRegsitrants

InputKeyNotesExample

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Meetings#

List all meetings by user Id | key: listMeetings

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "meetings": [      {        "uuid": "example/PiXZTLiwZLisi+dL+g==",        "id": 87272670533,        "host_id": "example_6cTCWFHEE20SifVg",        "topic": "Daily Meeting",        "type": 2,        "start_time": "2021-12-15T12:02:00Z",        "duration": 60,        "timezone": "America/Chicago",        "created_at": "2021-12-01T20:30:47Z",        "join_url": "https://example.zoom.us/j/87272670532?pwd=UE8xd2NBT0Q3TVpKMGU0WUtuSnI2Zz09"      }    ]  }}

List User's Channels#

List all channels of a given user | key: listUsersChannels

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List User's Chat Messages#

List all chat messages of a given user | key: listUsersChatMessages

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List User's Recordings#

List all recordings taken by a given user | key: listUsersRecordings

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Users#

List all users connected to your Zoom account | key: listUsers

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "page_count": 1,    "page_number": 1,    "page_size": 30,    "total_records": 1,    "next_page_token": null,    "users": [      {        "id": "exampleUserId",        "first_name": "John",        "last_name": "Doe",        "email": "someone@example.com",        "type": 1,        "pmi": 12345,        "timezone": "America/Chicago",        "verified": 1,        "created_at": "2021-11-18-T20:49:06Z",        "status": "active",        "role_id": 0      }    ]  }}

List Webinar Participants#

List all participants of a given webinar | key: listWebinarParticipants

InputKeyNotesExample

Webinar Id

string
/ Required
webinarIdProvide the unique identifier of a webinar.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Webinar Registrants#

List all registrants of a given webinar. | key: listWebinarRegistrants

InputKeyNotesExample

Webinar Id

string
/ Required
webinarIdProvide the unique identifier of a webinar.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Webinars#

List all webinars for the given user | key: listWebinars

InputKeyNotesExample

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Meeting#

Update the information and metadata of an existing meeting by Id | key: updateMeeting

InputKeyDefaultNotesExample

Agenda

string
agendaProvide a string value for the agenda. This property has a maximum length of 2,000 characters.In this meeting we will discuss...

Approval Type

string
approvalType2This flag will determine the approval type of the meeting.

Audio Method

string
audioThis flag will determine if participants audio used telephony or VoIP

Auto Recording

string
autoRecordingnoneThis value will determine your automatic recording settings.

Global Dial In Countries

string
Value List
availableDialInCountriesFor each item specify the code of a country that is available for global dial in.

Duration

string
durationProvide a value for the duration in minutes. This field is only used for scheduled meetings.60

End Date Time

string
endDateTimeProvide a valid date time value for when the last meeting will occur.2017-11-25-T12:00:00Z

Host Video On Start

boolean
hostVideoThis flag will determine if the host's video is turned on by default.

Time To Join Before Host

string
jbhTimeIf joinBeforeHost is true, supply one of the given values.

Join Before Host

boolean
joinBeforeHostThis flag will determine if participants are allowed to join before the host.

Meeting Id

string
/ Required
meetingIdProvide the unique identifier of a meeting.89347503

Meeting Type

string
meetingTypeProvide a value from the provided list.

Monthly Day

string
monthlyDayProvide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected type 3 for recurrence. 15

Monthly Week

string
monthlyWeekProvide a value for the week of the month you would like your meeting to occur on. This field is required if you selected type 3 for recurrence.

Monthly Week Day

string
monthlyWeekDayProvide a value from 1-7 to determine which days of the day of the week your monthly meeting will occur on. You must also provide a value for monthly week. For instance if you want your meeting to occur every Tuesday and Sunday, provide '1, 3'. This field is required if you selected type 2 for recurrence. 1

Mute Upon Entry

boolean
muteUponEntryThis flag will determine if participants are muted by default when they join.

Participant Video

boolean
participantVideoThis flag will determine if participants video is turned on by default.

Password

string
passwordProvide a value up to 10 characters for the password.examplePass

Recurrence

string
/ Required
recurrencePick a value from the provided list.

Registration Email Notifications

boolean
registrationEmailNotificationsThis flag will determine whether or not to send an email notification upon registration.

Registration Type

string
registrationTypeProvide a value from the provided list.

Repeat Interval

string
repeatIntervalThis value relates to the cadence at which your meetings will occur. This value directly related to recurrence. For more information on this value and how it affects your meetings, refer to the Zoom documentation: https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate1

Start Time

string
startTimeProvide a value for the start time of the meeting. Provide your value in the following format: yyyy-MM-ddTHH:mm:ssZ2021-12-15T12:02:00Z

Timezone

string
timezoneProvide a string value for a valid timezone. Refer to the Id value in the timezone list: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezonesAmerica/New_York

Topic

string
topicProvide a string value for the topic.Daily Meeting

Use Personal Meeting ID

boolean
usePMIThis flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.

Use Watermark

boolean
watermarkThis flag will determine if a watermark will be displayed on screen share.

Weekly Day

string
weeklyDayProvide a value from 1-7 to determine which days of the week your meeting will occur on. You can also provide a string of comma separated integers. For instance if you want your meeting to occur every Tuesday and Sunday, provide '1, 3'. This field is required if you selected type 2 for recurrence. 1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {}}

Update User#

Update the information or metadata of a user by Id | key: updateUser

InputKeyDefaultNotesExample

CMS User Id

string
cmsUserIdProvide a string value for the user Id in the CMS.1234567890

Company

string
companyProvide a string value for the company.Acme Inc.

Timezone

string
departmentProvide a string value for the department of the user.Example Department

Email

string
/ Required
emailProvide a valid email address.someone@example.com

First Name

string
/ Required
firstNameProvide a string value for the first name.John

Host Key

string
hostKeyProvide a 6-10 digit value for the host key of the user.1234567890

Job Title

string
jobTitleProvide a string value for the job title.Graphic Designer

Last Name

string
/ Required
lastNameProvide a string value for the last nameDoe

Location

string
locationProvide a string value for the location.United States

Personal Meeting Id

string
personalMeetingIdProvide an integer value for the personal meeting Id of a user.1234567890

Phone Number

string
phoneNumberProvide a string value for the phone number.16059313845

Timezone

string
timezoneProvide a string value for a valid timezone. Refer to the Id value in the timezone list: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezonesAmerica/New_York

User Action

string
/ Required
userActioncreateThis value represents the method used to create the user.

User Id

string
/ Required
userIdProvide the unique identifier of a user.89347503

User Type

string
/ Required
userTypeThe value provided will determine the type of user that will be created.

Vanity Name

string
vanityNameThis value will determine the name of your personal meeting room.Example Name

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri