PUT /users/{userId}/presence_status
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 be either "Away", "Do not disturb", or "Available".
Use this API to update a user's presence status. A user's status can not be updated more than once per minute, i.e., you can only submit a maximum of 1 update request/minute for a single user.
Note that a user's presence status can not be updated using this API if the user is not logged in to the Zoom client.
Scopes: user:write, user:write:admin
Rate Limit Label: Medium
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
status |
String | No |
Presence status of the user. The value can be set to one of the following:
Users who are on Zoom Client with a version lower than 5.3.0 can update the status from:
Users who are on Zoom Client 5.3.0 or higher can update the status from:
Valid values:
|
duration |
Integer | No |
If you're updating the status to The default value is 20 minutes and the maximum allowed value is 1440 minutes. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.