Ask a question about using Bottle

POST

/help-chat/messages

curl --request POST \
  --url https://example.com/help-chat/messages \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "message": "example", "conversationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "useBusinessData": true, "pagePath": "example" }'

Authorizations

• sessionCookie
  tenant:read

Request Body^required

Media typeapplication/json

object

message

required

string

>= 1 characters <= 4000 characters

conversationId

string format: uuid

useBusinessData

boolean

pagePath

required

string

<= 400 characters /^\/(?!\/)[a-zA-Z\d_/?=&%.-]*$/

Example ^generated

{
  "message": "example",
  "conversationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "useBusinessData": true,
  "pagePath": "example"
}

Responses

200

Help answer as server-sent events

Media typetext/event-stream

string

401

Sign in required

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Session and membership required

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

An answer is already running

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

429

Chat limit reached

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Help chat unavailable

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}