v1

latestOpenAPI 3.0.12026-07-1351620.2 KB

Submit a conversation

Submits conversation data to the system for processing. This can be content like a call transcript, email thread, or chat conversation.

post/conversations

Request body

idstring

The unique identifier for the conversation.

titlestring nullable

The title of the conversation.

sourcestring

The source of the conversation.

createdAtstring date-time

The date and time the conversation was created.

updatedAtstring date-time nullable

The date and time the conversation was last updated.

ratingnumber nullable

The numeric rating (integer)

shouldUnflattenPropertiesboolean nullable

Whether to unflatten properties that are meant to be nested objects for example { "plan.type": "Pro" } will be unflattened to { "plan": { "type": "Pro" } }

propagatePropertiesToMessagesboolean nullable

When true, conversation-level properties are merged into each message's rawData. Message properties take precedence over conversation properties when there are key conflicts.

propertiesobject

Additional metadata properties (key-value pairs)

Example request

{
  "id": "conversation-123",
  "title": "Customer Support Request",
  "source": "intercom",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "contacts": [
    {
      "properties": {
        "$contractValue": 100000
      },
      "account": {
        "id": "account-789",
        "properties": {
          "$name": "Acme, Inc.",
          "$domain": "acme.com",
          "$contractValue": 100000
        }
      }
    }
  ],
  "messages": [
    {
      "id": "message-789",
      "incoming": true,
      "contactId": "user-456",
      "content": "Hello! I'm having trouble...",
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Response

Conversation submitted successfully.

successboolean

Example response

{
  "success": true
}