---
title: "Upload Webchat Image"
method: POST
path: "/webchat/images"
tags: ["Web Chat"]
---

# Upload Webchat Image

`POST /webchat/images`

## Request

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

Upload an image for the widget and get back its public URL.

STATELESS: this does not change the widget. Write the returned URL into
the theme with `PATCH /webchat/settings` - `headerImageUrlExternal` /
`headerImageUrlInternal` for a header, `botAvatarCustomUrl` for an avatar.
The file type is checked from its bytes, not its declared content type.

## Query parameters

- `purpose` 'header' | 'avatar': `header` (the widget header image) or `avatar` (the assistant avatar). Only selects where the file is stored.

## Headers

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

## Response `201`

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)