Sign in

v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01353775.9 KB
Conversation

post/v1/conversation/chat/message

Request body

conversationIdstring required

The ID of the conversation

messagestring required

The message to be sent to the user (customer or agent). This endpoint supports markdown.

variablesobject

The variables to be passed to the conversation - this can be used by workflows

Example request

{
  "customer": {
    "firstName": "Lori",
    "lastName": "Keet",
    "email": "lori@keet.com",
    "phoneNumber": "+14155552671",
    "displayName": "Lori Keet",
    "remoteId": "1234567890",
    "subscriberCustomerId": "1234567890",
    "avatarUrl": "https://example.com/image.jpg"
  },
  "attachments": [
    {
      "url": "https://example.com/example.jpg",
      "type": "image/jpeg",
      "name": "example.jpg"
    }
  ],
  "variables": {
    "tags": [
      "vip",
      "returning"
    ],
    "currentPage": {
      "url": "/products",
      "title": "Products"
    }
  }
}

Response

The returned message generated from our API. If not returned the message will be processed asynchronously.

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' | 'Triaged' | 'DraftResponse' | 'Responded' | 'Error' | 'Escalated' | 'EscalatedFailed' | 'Processed' | 'Ignored' | 'Tagged' 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

latestMessageType'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' nullable required

The latest message type - useful for polling

updatedAtstring date-time required

The timestamp of when the ticket was last updated in our system.

Example response

{
  "link": "https://app.lorikeetcx.ai/ticket-feedback/tickets/123",
  "tags": [
    "tag1",
    "tag2"
  ],
  "messages": [
    {
      "attachments": [
        {
          "url": "https://example.com/example.jpg",
          "type": "image/jpeg",
          "name": "example.jpg"
        }
      ]
    }
  ]
}