---
title: "Update User Availability"
method: PATCH
path: "/v1/users/{user_sid}/availability"
tags: ["users"]
---

# Update User Availability

`PATCH /v1/users/{user_sid}/availability`

Updates the availability status of a user (Only supported if User Availability is enabled)

## Path parameters

- `user_sid` string, required

## Request body

- StreemApiUpdateUserAvailabilityRequest
  - `availability_status` 'AVAILABILITY_STATUS_AVAILABLE' | 'AVAILABILITY_STATUS_NOT_AVAILABLE' | 'AVAILABILITY_STATUS_RESERVED' | 'AVAILABILITY_STATUS_IN_CALL' | 'AVAILABILITY_STATUS_CONFIRMING' | 'AVAILABILITY_STATUS_OFFLINE' | 'AVAILABILITY_STATUS_INVALID'

## Response `200`

User availability updated

- StreemApiUpdateUserAvailabilityResponse
  - `user_availability` StreemApiUserAvailability
    - `user_sid` string
    - `availability_status` 'AVAILABILITY_STATUS_AVAILABLE' | 'AVAILABILITY_STATUS_NOT_AVAILABLE' | 'AVAILABILITY_STATUS_RESERVED' | 'AVAILABILITY_STATUS_IN_CALL' | 'AVAILABILITY_STATUS_CONFIRMING' | 'AVAILABILITY_STATUS_OFFLINE' | 'AVAILABILITY_STATUS_INVALID'
    - `reservation_sid` string

## Other responses

- `400` — Invalid request (possibly availability_status not valid).
- `403` — Do not have permission to update this user's availability.
- `404` — User not found.
- `428` — User Availability is not currently enabled for your company.

---

[API](https://skmtc.net/streem/apis/streem-api.md) · [All operations](https://skmtc.net/streem/apis/streem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/streem/streem-api/versions/04250faebd19/schema)
