Create Zoom Build Platform account

Use the Zoom Build Platform account links to view and edit your personal profile, account profile, and account settings. Set some of these programmatically using Account Settings APIs. Leverage subaccounts to create separate environments for production, development, and QA.

Create or update account

If you don't have a Zoom Workplace account: Choose a pricing option and create a new account.
If you already have a Zoom Workplace account:
- Sign in to the web portal.
- Upgrade to at least a Zoom Workplace Pro account.
- Under ADMIN, click Plans & Billing, Plan Management and scroll to Develop your applications with Zoom SDK products.
- Choose a pricing plan for the Zoom Build Platform.
  
  Note
  
  Contact your account representative if you don't see this option.

Access your profile

Your profile includes personal, account, and sign in information, similar to the Zoom account personal profile. To access your profile:

Sign in to your Build account web portal.
- If you created a new developer account, sign in to the web portal.
- If you added a pricing plan to your Zoom Workplace account, sign in to the web portal and click Advanced, Zoom CPaaS, and Manage next to your Zoom Build Platform account to access the SDK account page (Click Back to the main account to return to your Workplace account).
Click Profile in the navigation menu.
View or edit the following sections. Most of the sections are optional.

Profile information and picture section

Profile Picture - Click your profile picture to add or change it. You can also adjust the crop area on your current picture or upload a new one. Click Delete to delete your profile picture.
Profile information - Click Edit on the right side to update your profile information.
First Name and Last Name - Enter your first and last name.
Display Name - This is required but not used in Build accounts.
Name Pronunciation - How to pronounce your name.
Location - Enter your specific location name or area.
Company - Enter the company or organization to which you belong.
Department - Enter your division or functional area.
Job Title - Enter your specific role or position.

Personal section

Phone - Add up to three external phone numbers to your profile. To add a phone number, click Add Phone Number. When adding an external number, Zoom will prompt you to verify it before it appears in your profile.
- (Optional) When adding a phone number, you can click the Select a label drop-down menu to apply a label to the phone number; for example, Mobile, Office, Home, or Fax.
Language - Edit the default language for the Zoom web portal. See Change your language on Zoom for the list of languages.
Time Zone - Edit the time zone that applies to you.
Date Format - Edit the date format for the Zoom web portal.
Time Format - Edit the time for the Zoom web portal.

Account section

License - Displays the type of license and add-ons assigned to you. Click the question mark (?) to learn more about each license or feature.
Account No. - Your account number. You can note this if you call into Zoom support for assistance, as it will help us locate your account faster.

Sign In section

Sign-In Email - Click Edit on the right side to change your email address and password used to sign in.
Sign-In Password - Click Edit to change your password used to sign in. This option is not available if you sign in using SSO.
Two-Factor Authentication - You can use any app that supports Time-based One-Time Password (TOTP) protocol, including Google Authenticator (Android/iPhone) and Authenticator (Windows Phone 7). Enter your password to turn on two-factor authentication.
OTP Authentication - One-Time Passcode (OTP) protects your account with a verification code when accessing your account from an infrequently-used device or IP address.
Linked Accounts - Not applicable.
Sign Me Out from All Devices: Not applicable.

Manage your account profile

Your account profile includes basic information about your Build account, similar to the Zoom account profile. To access your profile, follow these steps.

Sign in to your Build account web portal.
Click Account Profile in the navigation menu.
View or edit the following sections.

Basic Information

Account Type - The plan type associated with the account.
Account Name - Click Edit to change the Account Name.
Account Alias - Click Edit to change the Account Alias.
Your Role - As an account Admin, you will have set permissions to view and edit a subset of pages belonging to the account.
Account Number - This is your account number. You can provide this when contacting Zoom support for assistance, as it will help to quickly locate your account.
Session Capacity - This lists the default session capacity assigned to your account. Contact Sales to make changes.

How to delete your Build account

Click Terminate my account to delete your Build account. You can't delete your account if it has an active subscription. You must cancel your plan first.

Update general account settings

To update general account settings, such as content storage locations and data center regions for data in transit in your account settings, follow these steps.

Sign in to your Build account web portal.
In the navigation menu, click Account Settings, then the General tab.
View or edit the following sections.

Communications Content Storage Location

Recordings: Choose where to store Video SDK recording content. Choose from one of the following regions: Australia, Brazil, Canada, Germany, Japan, Singapore, Mexico_, Switzerland_, United States. This is similar to how Zoom accounts store content (see Managing Communications Content storage location for details). (*Account data and Operation data will continue to be stored in the US.)
Live transcript location: Select the country or region where servers will generate and process live transcriptions for your sessions. Choose from one of the following regions: Australia, Canada, Germany, United States. This is similar to how Zoom accounts generate and process live transcriptions for meetings (see Managing Communications Content storage location for details).
Bring Your Own Storage: Select the configured Amazon S3 bucket storage location where to store Video SDK recording contents. (see Bring your own storage for details).

Data Configuration

Customize data center regions for session data in transit. Zoom uses data center regions to determine where to route realtime media traffic (the user's real-time session video, audio, and shared content). By default Zoom connects to the closest, fastest data center of the user. You can also restrict routing to certain data center regions at the account or user level.
- At the Build account level, use Customize data center regions for session data in transit. This operates in a similar manner to Selecting data center regions for meetings/webinars.
- At a per user, per connection level for Video SDK, use the geo_regions property in the Video SDK JWT signature payload. Note: This is different from setting where the Video SDK for web dependentAssets are served.
Customize data center region for CRC call-out. Set the Conference Room Connector (CRC) gateway region for H.323/SIP call-out from sessions. Toggle this feature on to enable, or off to disable. When you toggle, you'll see a modal window to confirm to enable or disable.
- Enable "Customize data center region for CRC call-out."
  - Toggle the setting on.
  - Click Enable in the modal window.
  - This setting will be turned on for all groups and users. Any settings that were previously changed for specific groups or users will be kept as is.
  - Under Use Preferred CRC Gateway, choose a region from the drop-down list.
- Disable "Customize data center region for CRC call-out."
  - Toggle the setting off.
  - Click Disable in the modal window.
  - This setting will be turned off for all groups and users. Any settings were been previously changed for specific groups or users will be kept as is.

Update session settings

To update settings for session security and in-session options, follow these steps. These settings are not applicable to the Cobrowse SDK.

Sign in to your Build account web portal.
In the navigation menu, click Account Settings, then the Sessions tab.
View or edit the following sections.

Security

Approve or block entry for users from specific countries/regions: Determine whether users from specific regions or countries can join sessions on your account by adding them to your Approved List or Blocked List. Blocking regions may limit options for participants joining from those regions.

In Session (Advanced)

Choose the following Video SDK settings.

Peer to Peer connection while only 2 people in a session - Allow users to directly connect to one another in a 2-person session. Optionally choose a range of listening ports. This operates in a similar manner as on Zoom accounts (see Enabling Peer-to-peer connection for 2 people in a meeting for details).
DSCP marking - Determine classification for network traffic. Enable Differentiated Services Code Point (DSCP) marking for signaling and media packets. Default is 56 for audio, 40 for video, and 40 for signaling.
Subsession - Allow the host to split session users into separate, smaller sessions. This operates similarly to meeting breakout rooms for Zoom accounts.
Send files via in-session chat - Hosts and participants can send files through the in-session chat. Select to only allow specified file types and a maximum file size.
Increase session capacity to up to 5,000 participants - Similar to the large meeting license capability, enable this option to increase session capacity. This setting will be ON for all groups and users. Settings that had been previously changed for groups or users will be kept as is.

Admin options

Meeting quality scores and network alerts on Dashboard - Not used by Build accounts.

Update Cobrowse SDK session settings

To update Cobrowse SDK settings, follow these steps.

Sign in to your Build account web portal.
In the navigation menu, click Account Settings, then the Cobrowse tab.
View or edit the following sections.

Zoom Contact Center includes cobrowsing features, documented in Configuring Zoom Cobrowse on Zoom Support. For developer implementation details, see the Cobrowse SDK documentation.

Mask Data in Cobrowse

Set the input fields requiring masking sensitive data during a Cobrowse session. Users cannot see masked data, nor does Cobrowse transmit masked data. Select to mask all data fields or mask selected fields by CSS selectors or HTML attributes.

Remote assist

Allow agents to use remote assist to help customers. You can control what operations can be set to be carried out remotely.

Scroll page - Select the checkbox to allow the agent to scroll the page. Clear the check box to disallow.
Required user's consent - Select Required to require the user to consent to remote assist or select Not required to not require their consent.

Multi-tab session persistence

Enable agents to continue the current Cobrowse session to the new tab when customers open new browser tabs within the same web app domain.

Link accounts to an organization

Link multiple accounts together within an organization. All accounts under the same organization will be able to join the Cobrowse sessions with each other.

Create new organization - Click and enter an organization name and the email of the account owner.
Link to existing organization - Click and enter an existing account owner.

Customize audio conferencing

To enable dial-in and dial-out features over PSTN (Public Switched Telephone Network), you must have an audio conferencing license. Once you have the license, you can follow these steps to enable the Call Me and Invite by Phone features in your account.

Sign in to your Build account web portal.
In the navigation menu, click Account Settings, then select the Audio Conferencing tab.
Review and configure the following options.

Audio conferencing options

Toll Call - Include the selected numbers in the Zoom app and the email invitation via the international numbers link. Participants can dial into the meeting with these numbers. Zoom recommends you to choose sufficient numbers in the list to make sure all users in your account and their meeting participants can dial into meetings based on their location.
Use dedicated phone numbers to dial in to meetings - These phone numbers can only be used for your account meetings. Users can call these numbers to join your meetings. The numbers listed here are currently available. After selecting numbers, your account will use them exclusively. You can select up to 20 numbers.
Call Me and Invite by Phone - Enable this option to allow users to join audio via phone and for hosts to invite participants by sharing a phone number.
Call Out Countries/Regions - Users can call out to the specified countries/regions.
Choose where most of the participants call into or call from the meeting - Select the region from which most calls will originate to optimize call quality.
Global Dial-in Countries/Regions - Click the Edit icon to choose countries/regions that frequently have participants who need to dial into meetings. The dial-in phone numbers of these locations appear in the email invitation, and can be used by participants dialing in from those locations.
Telephone welcome message - People who dialed in by phone will hear your uploaded welcome message. Supports the following audio file formats: .wav (8k, mono, ULAW, or ALAW). Upload a .wav file to serve as a welcome message for participants who dial into the session by phone. If you're using the Video SDK API, set invite_options require_greeting to true in Use in-session events controls.

Note: Users can press *6 to mute or unmute their audio.

H.323/SIP conferencing

Video SDK customers can use Cloud Room Connector (CRC) dial-in for Video SDK sessions. To customize the experience for H.323/SIP participants, you can configure the welcome message.

Sign in to your Build account web portal.
In the navigation menu, click Account Settings, then select the H.323/SIP Conferencing tab.
Review and configure the welcome message.

H.323/SIP conferencing options

H.323/SIP welcome message - Upload a .wav file to serve as a welcome message for participants who dial into the session by H.323/SIP. Supported audio file format: .wav (PCM, 8-bit, mono, 8kHz, μ-law or a-law) up to 10 seconds (~80KB size).

Create subaccounts

If you have a Build primary account, you can set up Build account subaccounts. Subaccounts allow a Build account owner, admin, or user with the subaccounts permission to easily switch between different Build account environments. Follow these steps to create subaccounts.

Contact developer support to enable subaccounts for your Build account.
Once enabled, you'll see a Sub Account Management option in the Web portal sidebar.
Click Sub Account List and Add.
Enter information, select a plan, and add payment details.

Manage subaccounts

Click the following options to manage your subaccounts.

Admin Dashboard - Shows the total subaccounts, hosts, seats, and room connector ports and enables you to set a contact email address for all subaccounts.
Sub Account List - lists the subaccounts and details.
- Add or Export the subaccounts.
- Search by subaccount name, owner email, or subaccount number.
- The list of subaccounts shows the account name, owner, account number, who pays for the account (you, the owner of the main account, or the subaccount owner), account type, RPS status (Approved, etc.), seats, service effective date, next invoice date, and creation time.
- Click View Plan to see more details about the plan type.
Click Invoice History to review the invoices and Report to create usage reports.

Primary accounts can use APIs to programmatically manage activities for subaccounts in their organization if both the owner of the primary account and the owner of the subaccount agree. Work with your Zoom account representative to enable this access for the primary account and each subaccount. See Access or modify subaccount data for details.

These options operate similarly to those for Zoom Accounts. For details, see Managing Zoom subaccounts. Additionally, for Video SDK, see Manage plans: Video SDK account plans.

Manage accounts (Zoom CPaaS)

If you have a Zoom Workplace account with the Zoom Build Platform add-on plan, to access it:

From your profile, click Advanced.
Select Zoom CPaaS. You'll see a table of Zoom Build Platform accounts that you can manage.
Find the account you want to manage and click Manage. The browser window will update to display the account details, with the name of the account at the top of the sidebar.

Choose links from the sidebar to manage the account. Click Back to the main account to return to your account web portal.

Table of accounts

The table includes the following fields:

Account Name - The account available for you to manage.
Plan Type - The account billing plan type.
Usage - The account usage.
Invited admin - The number of administrators who can manage this account.
Status - The status of the account.

Account options

In the options menu (the ellipsis next to the Manage button), click:

Invite admin to invite a user in your account to also manage this account.
Rename this account to change the name of the account.