Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
SMS
Provider Exchange
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
put

/users/{userId}/presence_status

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

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
status
string

Presence status of the user. The value can be set to one of the following:

  • 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
1 validation
duration
integer

If you’re updating the status to Do_Not_Disturb, specify a duration in minutes for which the status should remain as Do_Not_Disturb.

The default value is 20 minutes and the maximum allowed value is 1440 minutes.

2 validations

Responses

HTTP Status Code: 204

Status updated succesfully.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
userId
$$.env
1 variable not set
oauth_access_token