Web Chat

Put Webchat Human Availability

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

enabledboolean
timezonestring

IANA zone the intervals are expressed in.

chat_bot_idstring nullable

Bot this schedule applies to. NULL is the org default.

surface'external' | 'internal' nullable

Response

Successful Response

dataWebchatPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.