Skip to main content

Zoom Component

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

Component key: zoom

Description#

Zoom is a video teleconferencing software program developed by Zoom Video Communications. The Zoom component allows you to manage meetings, recordings, users and webinars.

Zoom Connections#

OAuth 2.0#

This component uses OAuth 2.0 to connect to Zoom's API. To create a Zoom OAuth 2.0 app, first visit the Zoom Marketplace. Log in and click Develop -> Build an App. Select OAuth as your app type and give your app a name. Select that you want an Account-level app. Do not elect to publish your app to Marketplace.

On the next page give your app an icon (probably your core product's logo). Add Prismatic's OAuth callback URL, https://oauth2.prismatic.io/callback to two places: the Redirect URL for OAuth and to Add allow lists.

Take note of the Client ID and Client secret that were generated - these will be entered into Prismatic when you create an integration that uses the Zoom component. Click Continue.

Give your app a short description, and fill in the remaining basic information about your app. This is the information your customers will see when they grant your integration permission to interact with Zoom on their behalf. Click Continue.

You can safely ignore the Verification Token that is generated for you on the next screen - that's used for incoming webhooks from Zoom. Click Continue.

Zoom OAuth 2.0 Scopes#

Scopes determine what an integration is allowed to do on your customer's behalf. For Zoom apps, scopes are configured on the next page. For the correct permissions, add the following scopes to your app:

  • If you plan to view and manage meetings, add meeting:master, meeting:read:admin and meeting:write:admin
  • If you plan to view and manage webinars, add webinar:master, webinar:read:admin and webinar:write:admin
  • If you plan to view and manage recordings, add recording:master, recording:read:admin and recording:write:admin
  • If you plan to view and manage users, add user:master, user:read:admin and user:write:admin

You can omit the other scopes, as this component does not implement actions for accounts, billing, etc. Click Continue to complete the creation of your OAuth app.

You can now authenticate your integration with Zoom. Additional information on Zoom OAuth 2.0 apps is available in Zoom's documentation.

InputDefaultNotes
Input
Authorize URL
string
/ Required
Hidden Field
Default
https://zoom.us/oauth/authorize
Notes
The OAuth 2.0 Authorization URL for Zoom
Input
Client ID
string
/ Required
Default
Notes
Client Identifier of your app for Zoom
Input
Client Secret
password
/ Required
Default
Notes
Client Secret of your app for Zoom
Input
Scopes
string
Hidden Field
Default
Notes
Scopes are configured when a Zoom OAuth 2.0 app is created
Input
Token URL
string
/ Required
Hidden Field
Default
https://zoom.us/oauth/token
Notes
The OAuth 2.0 Token URL for Zoom

Actions#

Add Meeting Registrant#

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

InputNotesExample
Input
Address
string
Notes
Provide a string value for the address.
Example
122 S Privet dr
Input
City
string
Notes
Provide a string value for the city
Example
San Jose
Input
Comments
string
Notes
Provide a string value for comments.
Example
These are some example comments.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide 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#countries
Example
US
Input
Email
string
/ Required
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
/ Required
Notes
Provide a string value for the first name.
Example
John
Input
Industry
string
Notes
Provide a string value for their industry
Example
Computer Software
Input
Job Title
string
Notes
Provide a string value for the job title.
Example
Graphic Designer
Input
Last Name
string
/ Required
Notes
Provide a string value for the last name
Example
Doe
Input
Meeting Id
string
/ Required
Notes
Provide the unique identifier of a meeting.
Example
89347503
Input
Number Of Employees
string
Notes
Provide a value form the supplied list.
Example
 
Input
Organization
string
Notes
Provide a string value for the organization.
Example
Acme Inc.
Input
Phone
string
Notes
Provide a string value for the phone number.
Example
15558904949
Input
Purchasing Time Frame
string
Notes
Provide 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/meetingregistrantcreate
Example
Within a month
Input
Role In Purchase Process
string
Notes
Provide a string value for the registrants role in the purchase process.
Example
 
Input
State
string
Notes
Provide a string value for the state or province.
Example
California
Input
Zip Code
string
Notes
Provide a string value for the zipcode
Example
90210

Add Webinar Registrant#

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

InputNotesExample
Input
Address
string
Notes
Provide a string value for the address.
Example
122 S Privet dr
Input
City
string
Notes
Provide a string value for the city
Example
San Jose
Input
Comments
string
Notes
Provide a string value for comments.
Example
These are some example comments.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Country
string
Notes
Provide 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#countries
Example
US
Input
Email
string
/ Required
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
/ Required
Notes
Provide a string value for the first name.
Example
John
Input
Industry
string
Notes
Provide a string value for their industry
Example
Computer Software
Input
Job Title
string
Notes
Provide a string value for the job title.
Example
Graphic Designer
Input
Last Name
string
/ Required
Notes
Provide a string value for the last name
Example
Doe
Input
Number Of Employees
string
Notes
Provide a value form the supplied list.
Example
 
Input
Organization
string
Notes
Provide a string value for the organization.
Example
Acme Inc.
Input
Phone
string
Notes
Provide a string value for the phone number.
Example
15558904949
Input
Purchasing Time Frame
string
Notes
Provide 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/meetingregistrantcreate
Example
Within a month
Input
Role In Purchase Process
string
Notes
Provide a string value for the registrants role in the purchase process.
Example
 
Input
State
string
Notes
Provide a string value for the state or province.
Example
California
Input
Webinar Id
string
/ Required
Notes
Provide the unique identifier of a webinar.
Example
89347503
Input
Zip Code
string
Notes
Provide a string value for the zipcode
Example
90210

Create Meeting#

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

InputDefaultNotesExample
Input
Agenda
string
Default
Notes
Provide a string value for the agenda. This property has a maximum length of 2,000 characters.
Example
In this meeting we will discuss...
Input
Approval Type
string
Default
2
Notes
This flag will determine the approval type of the meeting.
Example
 
Input
Audio Method
string
Default
Notes
This flag will determine if participants audio used telephony or VoIP
Example
 
Input
Auto Recording
string
Default
none
Notes
This value will determine your automatic recording settings.
Example
 
Input
Global Dial In Countries
string
Value List
Default
Notes
For each item specify the code of a country that is available for global dial in.
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Duration
string
Default
Notes
Provide a value for the duration in minutes. This field is only used for scheduled meetings.
Example
60
Input
End Date Time
string
Default
Notes
Provide a valid date time value for when the last meeting will occur.
Example
2017-11-25T12:00:00Z
Input
Host Video On Start
boolean
Default
false
Notes
This flag will determine if the host's video is turned on by default.
Example
 
Input
Time To Join Before Host
string
Default
Notes
If joinBeforeHost is true, supply one of the given values.
Example
 
Input
Join Before Host
boolean
Default
false
Notes
This flag will determine if participants are allowed to join before the host.
Example
 
Input
Meeting Type
string
Default
Notes
Provide a value from the provided list.
Example
 
Input
Monthly Day
string
Default
Notes
Provide 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.
Example
15
Input
Monthly Week
string
Default
Notes
Provide 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.
Example
 
Input
Monthly Week Day
string
Default
Notes
Provide 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.
Example
1
Input
Mute Upon Entry
boolean
Default
false
Notes
This flag will determine if participants are muted by default when they join.
Example
 
Input
Participant Video
boolean
Default
false
Notes
This flag will determine if participants video is turned on by default.
Example
 
Input
Password
string
Default
Notes
Provide a value up to 10 characters for the password.
Example
examplePass
Input
Recurrence
string
Default
Notes
Pick a value from the provided list.
Example
 
Input
Registration Email Notifications
boolean
Default
false
Notes
This flag will determine whether or not to send an email notification upon registration.
Example
 
Input
Registration Type
string
Default
Notes
Provide a value from the provided list.
Example
 
Input
Repeat Interval
string
Default
Notes
This 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/meetingcreate
Example
1
Input
Start Time
string
Default
Notes
Provide a value for the start time of the meeting. Provide your value in the following format: yyyy-MM-ddTHH:mm:ssZ
Example
2021-12-15T12:02:00Z
Input
Timezone
string
Default
Notes
Provide 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#timezones
Example
America/New_York
Input
Topic
string
Default
Notes
Provide a string value for the topic.
Example
Daily Meeting
Input
Use Personal Meeting ID
boolean
Default
false
Notes
This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.
Example
 
Input
User Id
string
/ Required
Default
Notes
Provide the unique identifier of a user.
Example
89347503
Input
Use Watermark
boolean
Default
false
Notes
This flag will determine if a watermark will be displayed on screen share.
Example
 
Input
Weekly Day
string
Default
Notes
Provide 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.
Example
1

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

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Email
string
/ Required
Default
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
/ Required
Default
Notes
Provide a string value for the first name.
Example
John
Input
Last Name
string
/ Required
Default
Notes
Provide a string value for the last name
Example
Doe
Input
User Action
string
/ Required
Default
create
Notes
This value represents the method used to create the user.
Example
 
Input
User Type
string
/ Required
Default
Notes
The value provided will determine the type of user that will be created.
Example
 

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

Get Accounts Phone Recordings#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

Get Meeting#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Meeting Id
string
/ Required
Notes
Provide the unique identifier of a meeting.
Example
89347503

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Meeting Id
string
/ Required
Notes
Provide the unique identifier of a meeting.
Example
89347503

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Meeting Id
string
/ Required
Notes
Provide the unique identifier of a meeting.
Example
89347503

Get Phone Recordings#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

Get User#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

Get Webinar#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Webinar Id
string
/ Required
Notes
Provide the unique identifier of a webinar.
Example
89347503

List Meeting Registrants#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Meeting Id
string
/ Required
Notes
Provide the unique identifier of a meeting.
Example
89347503

List Meetings#

List all meetings by user Id | key: listMeetings

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

List User's Chat Messages#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

List User's Recordings#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

List Users#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Webinar Id
string
/ Required
Notes
Provide the unique identifier of a webinar.
Example
89347503

List Webinar Registrants#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Webinar Id
string
/ Required
Notes
Provide the unique identifier of a webinar.
Example
89347503

List Webinars#

List all webinars for the given user | key: listWebinars

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
User Id
string
/ Required
Notes
Provide the unique identifier of a user.
Example
89347503

Raw Request#

Issue a raw HTTP request with the configured connection | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
Default
Notes
 
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Update Meeting#

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

InputDefaultNotesExample
Input
Agenda
string
Default
Notes
Provide a string value for the agenda. This property has a maximum length of 2,000 characters.
Example
In this meeting we will discuss...
Input
Approval Type
string
Default
2
Notes
This flag will determine the approval type of the meeting.
Example
 
Input
Audio Method
string
Default
Notes
This flag will determine if participants audio used telephony or VoIP
Example
 
Input
Auto Recording
string
Default
none
Notes
This value will determine your automatic recording settings.
Example
 
Input
Global Dial In Countries
string
Value List
Default
Notes
For each item specify the code of a country that is available for global dial in.
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Duration
string
Default
Notes
Provide a value for the duration in minutes. This field is only used for scheduled meetings.
Example
60
Input
End Date Time
string
Default
Notes
Provide a valid date time value for when the last meeting will occur.
Example
2017-11-25T12:00:00Z
Input
Host Video On Start
boolean
Default
false
Notes
This flag will determine if the host's video is turned on by default.
Example
 
Input
Time To Join Before Host
string
Default
Notes
If joinBeforeHost is true, supply one of the given values.
Example
 
Input
Join Before Host
boolean
Default
false
Notes
This flag will determine if participants are allowed to join before the host.
Example
 
Input
Meeting Id
string
/ Required
Default
Notes
Provide the unique identifier of a meeting.
Example
89347503
Input
Meeting Type
string
Default
Notes
Provide a value from the provided list.
Example
 
Input
Monthly Day
string
Default
Notes
Provide 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.
Example
15
Input
Monthly Week
string
Default
Notes
Provide 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.
Example
 
Input
Monthly Week Day
string
Default
Notes
Provide 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.
Example
1
Input
Mute Upon Entry
boolean
Default
false
Notes
This flag will determine if participants are muted by default when they join.
Example
 
Input
Participant Video
boolean
Default
false
Notes
This flag will determine if participants video is turned on by default.
Example
 
Input
Password
string
Default
Notes
Provide a value up to 10 characters for the password.
Example
examplePass
Input
Recurrence
string
/ Required
Default
Notes
Pick a value from the provided list.
Example
 
Input
Registration Email Notifications
boolean
Default
false
Notes
This flag will determine whether or not to send an email notification upon registration.
Example
 
Input
Registration Type
string
Default
Notes
Provide a value from the provided list.
Example
 
Input
Repeat Interval
string
Default
Notes
This 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/meetingcreate
Example
1
Input
Start Time
string
Default
Notes
Provide a value for the start time of the meeting. Provide your value in the following format: yyyy-MM-ddTHH:mm:ssZ
Example
2021-12-15T12:02:00Z
Input
Timezone
string
Default
Notes
Provide 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#timezones
Example
America/New_York
Input
Topic
string
Default
Notes
Provide a string value for the topic.
Example
Daily Meeting
Input
Use Personal Meeting ID
boolean
Default
false
Notes
This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.
Example
 
Input
Use Watermark
boolean
Default
false
Notes
This flag will determine if a watermark will be displayed on screen share.
Example
 
Input
Weekly Day
string
Default
Notes
Provide 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.
Example
1

Output Example Payload#

{  "data": {}}

Update User#

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

InputDefaultNotesExample
Input
CMS User Id
string
Default
Notes
Provide a string value for the user Id in the CMS.
Example
1234567890
Input
Company
string
Default
Notes
Provide a string value for the company.
Example
Acme Inc.
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Timezone
string
Default
Notes
Provide a string value for the department of the user.
Example
Example Department
Input
Email
string
/ Required
Default
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
/ Required
Default
Notes
Provide a string value for the first name.
Example
John
Input
Host Key
string
Default
Notes
Provide a 6-10 digit value for the host key of the user.
Example
1234567890
Input
Job Title
string
Default
Notes
Provide a string value for the job title.
Example
Graphic Designer
Input
Last Name
string
/ Required
Default
Notes
Provide a string value for the last name
Example
Doe
Input
Location
string
Default
Notes
Provide a string value for the location.
Example
United States
Input
Personal Meeting Id
string
Default
Notes
Provide an integer value for the personal meeting Id of a user.
Example
1234567890
Input
Phone Number
string
Default
Notes
Provide a string value for the phone number.
Example
16059313845
Input
Timezone
string
Default
Notes
Provide 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#timezones
Example
America/New_York
Input
User Action
string
/ Required
Default
create
Notes
This value represents the method used to create the user.
Example
 
Input
User Id
string
/ Required
Default
Notes
Provide the unique identifier of a user.
Example
89347503
Input
User Type
string
/ Required
Default
Notes
The value provided will determine the type of user that will be created.
Example
 
Input
Vanity Name
string
Default
Notes
This value will determine the name of your personal meeting room.
Example
Example Name