API updates 01.31.21

Hey Zoom Developers, the following items were released on January 31, 2021.

New APIs and webhooks

  • Added APIs to manage virtual background settings.

    • DELETE /v2/accounts/{accountId}/settings/virtual_backgrounds
    • DELETE /v2/groups/{groupId}/settings/virtual_backgrounds
    • DELETE /v2/users/{userId}/settings/virtual_backgrounds
    • POST /v2/accounts/{accountId}/settings/virtual_backgrounds
    • POST /v2/groups/{groupId}/settings/virtual_backgrounds
    • POST /v2/users/{userId}/settings/virtual_backgrounds
  • Added meeting templates APIs.

    • GET /v2/users/{userId}/meeting_templates
    • For accounts that have Master account settings enabled, the endpoint for this API is GET /v2/accounts/{accountId}/users/{userId}/meeting_templates


  • Added a new response field(rate) that represents the calling rate in the telephone usage report API.

    • GET /v2/report/telephone
  • Added a new request parameter(category_type) in the operation logs report API.

    • GET /v2/report/operationlogs
  • Added a new field(login_type)in the user activity webhooks.

    • user.signed_in
    • user.signed_out
  • Added a new request parameter(include_deleted_and_edited_message) and a new response field(status) in the List chat messages API.

    • GET /v2/chat/users/{userId}/messages
  • Added new fields(template_id, authentication_exception, breakout_room) in the Meeting APIs.

    • POST /v2/users/{userId}/meetings
    • GET /v2/meetings/{meetingId}
    • PATCH /v2/meetings/{meetingId}
  • Replaced 400 response code with 403 response code for the following error message:

    • “Access to the Zoom REST API has been denied for this user. Contact Zoom Support for details.”
  • Added a new field(telephony_regions) in Account, Group and User settings APIs.

    • GET /v2/accounts/{accountId}/settings
    • PATCH /v2/accounts/{accountId}/settings
    • GET /v2/accounts/{accountId}/lock_settings
    • PATCH /v2/accounts/{accountId}/lock_settings
    • GET /v2/groups/{groupId}/settings
    • PATCH /v2/groups/{groupId}/settings
    • GET /v2/groups/{groupId}/lock_settings
    • PATCH /v2/groups/{groupId}/lock_settings
    • GET /v2/users/{userId}/settings
    • PATCH /v2/users/{userId}/settings
  • Added a new filed(virtual_background_settings) in Account, Group and User settings APIs.

    • GET /v2/accounts/{accountId}/settings
    • GET /v2/groups/{groupId}/settings
    • GET /v2/users/{userId}/settings
  • Added a new response field(status) in the past meeting participant API.

    • GET /v2/metrics/meetings/{meetingId}/participants
  • Added support for new unlimlited US CA billing plans(zoomaudio_unlimit_usca_monthly, zoomaudio_unlimit_usca_yearly) and tollfree commitment plans(tollfree_monthly_commitment_250, tollfree_monthly_commitment_500, tollfree_monthly_commitment_1000, tollfree_monthly_commitment_2500, tollfree_monthly_commitment_5000, tollfree_monthly_commitment_7500, tollfree_monthly_commitment_10000, tollfree_monthly_commitment_15000, tollfree_monthly_commitment_25000, tollfree_monthly_commitment_40000, tollfree_monthly_commitment_60000, tollfree_monthly_commitment_80000, tollfree_monthly_commitment_100000) in the Billing APIs.

    • POST /v2/accounts/{accountId}/plans
    • GET /v2/accounts/{accountId}/plans
    • POST /v2/accounts/{accountId}/plans/addons
    • PUT /v2/accounts/{accountId}/plans/addons
    • PATCH /v2/accounts/{accountId}/plans/addons/status
    • PATCH /v2/accounts/{accountId}/plans/addons/status
  • Added new fields(costCenter, employeeNumber, personalLinkName) to the SCIM2 APIs.

    • POST /scim2/Users
    • PUT /scim2/Users/{userId}

Bug fixes

  • Fixed a bug where a user’s information was being repeated across multiple pages when calling List users API.

    • GET /v2/users
  • Fixed a bug that returned incorrect number of total records when calling Get IM metrics API.

    • GET /v2/metrics/im
  • Fixed a bug where some channels were not being returned when calling List user channels API.

    • GET /v2/chat/users/{userId}/channels
  • Fixed a bug where on demand recording was not being enabled even when the value of on_demand field was set to “true”.

    • POST /v2/users/{userId}/webinars
  • Fixed a bug where webinar settings applied on the account were not being used when creating a webinar.

    • POST /v2/users/{userId}/webinars
  • Fixed a bug where alternative hosts were able to receive email notifications even when the notification setting was disabled for alternative hosts in the account.

    • POST /v2/users/{userId}/meetings
    • PATCH /v2/meetings/{meetingId}
  • Fixed a bug where the value of registrants_confirmation_email field was being overwritten as “true” even when the user set the value to “false”.

    • POST /v2/users/{userId}/meetings
  • Fixed a bug where some fields were not being included in the response of an on-prem user’s settings.

    • GET /v2/users/{userId}/settings

You can also see the update listed on our Changelog: https://marketplace.zoom.us/docs/changelog


This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.