Skip to content

Upload Webchat Image

POST
/webchat/images

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.

Authorizations

Parameters

Query Parameters

purpose

header (the widget header image) or avatar (the assistant avatar). Only selects where the file is stored.

string
default: header
Allowed values: header avatar

header (the widget header image) or avatar (the assistant avatar). Only selects where the file is stored.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
file
required

JPEG, PNG, GIF or WebP. 10 MB maximum.

string format: binary

Responses

201

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string