---
title: "Promote Chat Bot To Default"
method: POST
path: "/webchat/chat-bots/{bot_id}/promote-default"
tags: ["Web Chat"]
---

# Promote Chat Bot To Default

`POST /webchat/chat-bots/{bot_id}/promote-default`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/chat-bots/{bot_id}/promote-default`
- Auth: HTTP bearer

Make this the org's DEFAULT bot.

The default is what a legacy embed snippet with no bot id resolves to, so
promoting one CHANGES WHAT LIVE VISITORS SEE on every such page - not just
what the admin shows.

## Path parameters

- `bot_id` string, required: Chat bot id (UUID).

## Query parameters

- `expected_revision` integer, nullable: Revision you last read. When given, a concurrent edit is a 409 instead of a silent overwrite.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, 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)