Start a chat

Starts the visitor's chat with an optional first message and the pre-chat answers (a filled_form event).

One message per call; send more with send_event.

POST/v1/customer/action/start_chat

Start a chat

curl -X POST 'https://app.staging.mlive.chat/v1/customer/action/start_chat' \
  -H "Authorization: Bearer $MLC_CUSTOMER_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chat": {
      "thread": {
        "events": [
          {
            "type": "message",
            "text": "Hi! Is the Ridgeline 38L in stock?"
          }
        ]
      }
    }
  }'

const res = await fetch('https://app.staging.mlive.chat/v1/customer/action/start_chat', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${customerToken}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "chat": {
      "thread": {
        "events": [
          {
            "type": "message",
            "text": "Hi! Is the Ridgeline 38L in stock?"
          }
        ]
      }
    }
  }),
});
const data = await res.json();

Response200

{
  "chat_id": "98c7f777-40e4-7888-8901-1999911daaaa",
  "thread_id": "855d7d51-73d8-7f38-8253-a11f50ceb306",
  "event_ids": [
    "63cd2bab-0458-71e8-84e3-3825456e3e62"
  ]
}

Specifics

Method URL	`POST https://app.staging.mlive.chat/v1/customer/action/start_chat`
Who can call it	Visitors, with a customer access token (`mlcc_`).

Request body

application/json

chatobject
chat.accessobject
chat.access.group_idsarray of integer
chat.threadobject
chat.thread.eventsarray of object

Response

200 · application/json

OK.

chat_idstringrequired
thread_idstringrequired
event_idsarray of stringrequired

Errors

default