Console API

Website agent

3 endpoints.

GET/api/v1/businesses/{business_id}/website-agent/config

Get effective website-agent settings for a business

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteAgentConfigData_

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteAgentConfigData

WebsiteAgentConfigData fields

Field	Type	Description
`business_id`required	`string`
`enabled`required	`boolean`
`instructions`	`string`	default ""
`webchat_enabled`	`boolean`	default true
`editor_model_id`	`string \| null`
`version`	`integer \| null`
`updated_at`	`string (date-time) \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/businesses/{business_id}/website-agent/config

Update website-agent settings for a business

Partial diff. ``enabled`` / ``instructions`` persist as a new agent-settings version; ``webchat_enabled`` upserts webchat_configs in the same transaction (gates the live widget).

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonWebsiteAgentConfigPatchBody

Field	Type	Description
`enabled`	`boolean \| null`
`instructions`	`string \| null`
`webchat_enabled`	`boolean \| null`
`editor_model_id`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteAgentConfigData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`WebsiteAgentConfigData`	WebsiteAgentConfigData fields WebsiteAgentConfigData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/businesses/{business_id}/website-agent/models

The models the website editor offers, and its defaults

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteAgentModelsData_

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteAgentModelsData

WebsiteAgentModelsData fields

Field	Type	Description
`models`required	`WebsiteAgentModelOption[]`	WebsiteAgentModelOption[] fields WebsiteAgentModelOption (not expanded)
`default_model_id`required	`string`
`business_default_model_id`	`string \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.