Skip to content

Create Webchat Blog

POST
/webchat/blogs

Add an article card. display_order is ascending; ties break newest-first.

Authorizations

Parameters

Header Parameters

Idempotency-Key
Any of:
string
>= 16 characters <= 128 characters

Retry-safety key for this create. Replaying the same key returns the FIRST result instead of creating a second row. Durability depends on the tenant’s migration state, so treat it as best-effort.

X-Target-Org-Id
Any of:
string

Request Body required

An article card in the widget’s rail.

url and image_url are validated by the app to be http/https; a scheme it refuses is a 422 here rather than a broken card later.

object
active
boolean
default: true
chat_bot_id
required

Owning chat bot id (UUID).

string
description
Any of:
string
display_order

Lower sorts first; ties break newest-first.

integer
<= 9999
image_url
Any of:
string
<= 1000 characters
paths
Array<string>
surface
Any of:
string
Allowed values: external internal
title
required
string
>= 1 characters <= 500 characters
url
required
string
>= 1 characters <= 1000 characters

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