---
title: "Put Webchat Human Availability"
method: PUT
path: "/webchat/human-availability"
tags: ["Web Chat"]
---

# Put Webchat Human Availability

`PUT /webchat/human-availability`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/human-availability`
- Auth: HTTP bearer

Set the office hours that decide whether a visitor is offered a person.

`enabled: true` with no reachable interval is worse than off: the widget
offers a handover nobody answers. The app refuses the unreachable shapes
and this forwards its answer rather than inventing a second opinion.

Overlapping and zero-length windows are refused at THIS boundary, because
the request model is the app's own.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- HumanAvailabilityRequest: When a human is available to take a handed-off conversation. THIS IS WHAT DECIDES WHETHER A VISITOR IS OFFERED A PERSON. Turning it on with no reachable interval is worse than leaving it off: the widget offers a handover nobody answers. The app refuses the unreachable shapes; this forwards its answer. `intervals` and `overrides` use the app's own window models, which reject a zero-length window and refuse overlapping ones - see the module docstring.
  - `enabled` boolean
  - `timezone` string: IANA zone the intervals are expressed in.
  - `intervals` AvailabilityInterval[]: Weekly windows: `{day: 0-6, start: 'HH:MM', end: 'HH:MM'}`.
    - `start` string, required
    - `end` string, required
    - `day` integer, required
  - `overrides` AvailabilityOverride[]: Date overrides: `{date: 'YYYY-MM-DD', intervals: [...]}`.
    - `date` string, required
    - `intervals` AvailabilityWindow[]
      - `start` string, required
      - `end` string, required
  - `chat_bot_id` string, nullable: Bot this schedule applies to. NULL is the org default.
  - `surface` 'external' | 'internal', nullable

## Response `200`

Successful Response

- ApiResponseWebchatPayload
  - `data` WebchatPayload, required: An open envelope for one webchat object. Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)