Skip to main content
POST
Get the welcome message

Authorizations

Authorization
string
header
required

Access token from POST /management/v1/auth/token (publishable-key exchange) or a login session. Publishable-key tokens are agent-scoped and serve the messaging surface; login tokens also serve management.

Body

application/json

Optional body for POST /welcome-message. Omit entirely to keep the static welcome; pass placeholders to seed dynamic_welcome_message.

placeholders
Placeholders · object

Placeholder name → value to seed into dynamic_welcome_message (e.g. {"page-title": "honda civic"}).

Response

Successful Response

The agent's opening message — the resolved dynamic template when placeholders match, otherwise general_settings.welcome_message.

welcome_message
string | null