v52

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

Update a conversation

Update fields on a conversation, such as a CSAT score collected in your own UI. Requires server-to-server API credentials.

patch/v1/conversation/{conversationId}

Path parameters

conversationIdstring uuid required

The Lorikeet conversation ID

Request body

OR
OR

Example request

{
  "csatScore": 5,
  "csatCollectedAt": "2024-01-15T10:35:00Z",
  "title": "Question about order tracking"
}

Response

conversationIdstring required

The ID of the conversation

csatScorenumber nullable required

Customer satisfaction score for the conversation

csatCollectedAtstring date-time nullable required

When the CSAT response was collected (ISO 8601 format)

csatCollectionMethod'workflow' | 'widget_inactivity' | 'widget_close' | 'api' nullable required

How the CSAT was collected

csatDidThatHelpboolean nullable required

The customer's answer to a "did that help?" style prompt

titlestring nullable required

The title of the conversation

updatedAtstring date-time required

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