Use this API to update a user's presence status. For user-level apps, pass the me
value instead of the userId
parameter.
A user's status cannot be updated more than once per minute. For example, you can only submit a maximum of one update request per minute for a single user.
Users in the Zoom desktop client and mobile apps are assigned with a presence status. The presence status informs users of their contact's availability. Users can also change their own presence status to one the following:
- Away
- Do not disturb
- Available
- In a calendar event
- Presenting
- In a Zoom meeting
- On a call
Note that a user's presence status cannot be updated via this API if the user is not logged in to the Zoom client.
Scopes: user:write
, user:write:admin
Rate Limit Label: Medium
type: object
properties:
parameters:
type: object
properties:
userId:
type: string
example: KDcuGIm1QgePTO8WbOqwIQ
required:
- userId
title: Parameters
data:
type: object
properties:
duration:
type: integer
minimum: 20
maximum: 1440
description: >-
If updating the user's status to `Do_Not_Disturb`, the duration for
which the status should remain as `Do_Not_Disturb`, in minutes.
example: 1000
status:
type: string
description: >-
The user's presence status:
* `Away`
* `Do_Not_Disturb`
* `Available`
* `In_Calendar_Event`
* `Presenting`
* `In_A_Zoom_Meeting`
* `On_A_Call`
Users who are on Zoom Client with a version **lower than 5.3.0** can
update the status from:
* `Away` to `Do_Not_Disturb`
* `Available` to `Do_Not_Disturb`
Users who are on **Zoom Client 5.3.0 or higher** can update the status
from:
* `Do_Not_Disturb` to `Away`
* `Do_Not_Disturb` to `Available`
* `Available` to `Away`
* `Away` to `Available`
enum:
- Do_No_Disturb
- Away
- Available
- In_Calendar_Event
- Presenting
- In_A_Zoom_Meeting
- On_A_Call
example: Do_Not_Disturb
title: Data