Sign in
Conversation

post/v1/conversation/chat/create

Request body

customerIdstring required

The ID of the customer. If omitted, a new customer will be created.

publicKeystring required

The public key associated with this agent

subjectstring

The subject of the conversation.

workflowIdstring

The UUID of the workflow to trigger.

Example request

{
  "subject": "Question about order tracking number"
}

Response

conversationIdstring required

The ID of the conversation

createdAtstring date-time required

The timestamp of the when the conversation was created in our system.

status'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed' required

The status of the conversation

linkstring url required

The url of the conversation in the Lorikeet dashboard

tagsstring[] required

The tags of the conversation

Example response

{
  "link": "https://app.lorikeetcx.ai/ticket-feedback/tickets/123",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Changes