---
title: "Update Webchat Handoff Pool User Scope"
method: PATCH
path: "/webchat/handoff-pool/users/{user_id}/scope"
tags: ["Web Chat"]
---

# Update Webchat Handoff Pool User Scope

`PATCH /webchat/handoff-pool/users/{user_id}/scope`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/handoff-pool/users/{user_id}/scope`
- Auth: HTTP bearer

REPLACE which bots a person takes handoffs for. Empty list = every bot.

A replace, not a merge: bots left out of the list are dropped.

## Path parameters

- `user_id` string, required: Member user id.

## Query parameters

- `pool` 'external' | 'internal': Pool to re-scope. Only `external` is accepted by the app: the internal pool is not per-bot.

## Headers

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

## Request body

- HandoffPoolScopeRequest: The COMPLETE new bot scope. Empty list = every bot; bots left out are dropped.
  - `chat_bot_ids` string[]

## 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)