users

Update User Availability

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

patch/v1/users/{user_sid}/availability

Request

Base URL
https://api.prod-us.streem.cloud
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/streem/apis/streem-api/docs/v1/users/:user_sid/availability/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

user_sidstring required

Request body

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

User availability updated

Changes

No recorded changes to this operation across all 1 revision of this API.