> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Update chat availability status

> Toggles the authenticated user availability for chat routing. Affects whether new conversations are assigned to this user by the round-robin allocator.



## OpenAPI

````yaml /api-reference/openapi.yaml put /api/user/chat-availability
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/user/chat-availability:
    put:
      tags:
        - User
      summary: Update chat availability status
      description: >-
        Toggles the authenticated user availability for chat routing. Affects
        whether new conversations are assigned to this user by the round-robin
        allocator.
      operationId: put_user_chat_availability
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateChatAvailabilityRequest'
      responses:
        '200':
          description: Chat availability updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUpdateChatAvailabilityResponse'
        '400':
          description: isAvailable must be a boolean
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UserUpdateChatAvailabilityRequest:
      type: object
      properties:
        isAvailable:
          type: boolean
          description: >-
            New availability flag; when set to `true` the escalation queue is
            processed and the user becomes eligible for round-robin chat
            assignment.
      required:
        - isAvailable
      additionalProperties: false
      example:
        isAvailable: true
    UserUpdateChatAvailabilityResponse:
      type: object
      description: >-
        Returned after `PUT /api/user/chat-availability` toggles the user's
        availability flag.
      properties:
        success:
          type: boolean
          enum:
            - true
        message:
          type: string
        data:
          type: object
          properties:
            isAvailable:
              type: boolean
            lastStatusChange:
              type: string
              format: date-time
          required:
            - isAvailable
          additionalProperties: true
      required:
        - success
        - data
      additionalProperties: true
      example:
        success: true
        message: Chat availability enabled
        data:
          isAvailable: true
          lastStatusChange: '2026-05-20T15:04:01.135Z'
    UserErrorResponse:
      type: object
      description: >-
        Generic error envelope returned by Users endpoints. Most paths only
        include `error`; some add `details` for diagnostic context.
      properties:
        error:
          type: string
        details:
          type: string
      required:
        - error
      additionalProperties: true
      example:
        error: User not found
        details: No user with id 64ee9a8b1e7f2a0011223399
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````