Skip to main content
POST
Create starter

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatbotId
string
required

Chatbot ID.

Body

application/json
title
string
required
Minimum string length: 1
message
string
description
string
type
enum<string>
Available options:
PROMPT,
LINK
promptType
enum<string>

Alias of type; type wins when both are sent.

Available options:
PROMPT,
LINK
isEscalationPrompt
boolean
functionId
string | null
order
integer
Required range: x >= 0
paths
string[] | null

Page paths where this starter shows, like /pricing or /docs/* (the Excluded Pages grammar; at most 20). Empty or null shows it on every page — the default. Web widget only: channels always show every starter.

Response

Successful SiteGPT API v2 response.

ok
boolean
required
data
object
required
meta
object
required