Submit a conversation

curl --request POST \
  --url https://insights.reforge.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "id": "conversation-123",
  "title": "Customer Support Request",
  "source": "intercom",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "contacts": [
    {
      "id": "<string>",
      "shouldUnflattenProperties": true,
      "properties": {
        "$email": "<string>",
        "$name": "<string>",
        "$createdAt": "2023-11-07T05:31:56Z",
        "$updatedAt": "2023-11-07T05:31:56Z",
        "$contractValue": 100000
      },
      "account": {
        "id": "account-789",
        "shouldUnflattenProperties": true,
        "properties": {
          "$name": "Acme, Inc.",
          "$domain": "acme.com",
          "$createdAt": "2023-11-07T05:31:56Z",
          "$updatedAt": "2023-11-07T05:31:56Z",
          "$contractValue": 100000
        }
      },
      "source": "<string>"
    }
  ],
  "messages": [
    {
      "id": "message-789",
      "incoming": true,
      "contactId": "user-456",
      "content": "Hello! I'm having trouble...",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "shouldUnflattenProperties": true,
      "properties": {}
    }
  ],
  "rating": 123,
  "shouldUnflattenProperties": true,
  "properties": {}
}
EOF

{
  "success": true
}

POST

conversations

curl --request POST \
  --url https://insights.reforge.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "id": "conversation-123",
  "title": "Customer Support Request",
  "source": "intercom",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "contacts": [
    {
      "id": "<string>",
      "shouldUnflattenProperties": true,
      "properties": {
        "$email": "<string>",
        "$name": "<string>",
        "$createdAt": "2023-11-07T05:31:56Z",
        "$updatedAt": "2023-11-07T05:31:56Z",
        "$contractValue": 100000
      },
      "account": {
        "id": "account-789",
        "shouldUnflattenProperties": true,
        "properties": {
          "$name": "Acme, Inc.",
          "$domain": "acme.com",
          "$createdAt": "2023-11-07T05:31:56Z",
          "$updatedAt": "2023-11-07T05:31:56Z",
          "$contractValue": 100000
        }
      },
      "source": "<string>"
    }
  ],
  "messages": [
    {
      "id": "message-789",
      "incoming": true,
      "contactId": "user-456",
      "content": "Hello! I'm having trouble...",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "shouldUnflattenProperties": true,
      "properties": {}
    }
  ],
  "rating": 123,
  "shouldUnflattenProperties": true,
  "properties": {}
}
EOF

{
  "success": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json

string

The unique identifier for the conversation.

Example:

"conversation-123"

title

string | null

The title of the conversation.

Example:

"Customer Support Request"

source

string

The source of the conversation.

Example:

"intercom"

createdAt

string<date-time>

The date and time the conversation was created.

Example:

"2024-01-01T00:00:00.000Z"

updatedAt

string<date-time> | null

The date and time the conversation was last updated.

Example:

"2024-01-01T00:00:00.000Z"

contacts

object[]

Show child attributes

contacts.id

string

required

External contact ID

contacts.shouldUnflattenProperties

boolean | null

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

contacts.properties

object

Properties prefixed with $ are handled specially. Otherwise, additional key-value pairs will be metadata once ingested into the system

Show child attributes

contacts.properties.$email

string | null

contacts.properties.$name

string | null

contacts.properties.$createdAt

string<date-time> | null

contacts.properties.$updatedAt

string<date-time> | null

contacts.properties.$contractValue

number | null

The contract value of the contact.

Example:

100000

contacts.account

object

Show child attributes

contacts.account.id

string

required

The unique identifier for the account.

Example:

"account-789"

contacts.account.shouldUnflattenProperties

boolean | null

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

contacts.account.properties

object

Show child attributes

contacts.account.properties.$name

string

required

The name of the account.

Example:

"Acme, Inc."

contacts.account.properties.$domain

string

required

The domain of the account.

Example:

"acme.com"

contacts.account.properties.$createdAt

string<date-time> | null

contacts.account.properties.$updatedAt

string<date-time> | null

contacts.account.properties.$contractValue

number | null

The contract value of the account.

Example:

100000

contacts.source

string | null

Source system to limit search to

messages

object[]

Show child attributes

messages.id

string

The unique identifier for the message.

Example:

"message-789"

messages.incoming

boolean

Indicates if the message is incoming (from an external user or customer) or outgoing (e.g. from a support agent or sales person on your team).

Example:

true

messages.contactId

string

The unique identifier for the contact that sent this message.

Example:

"user-456"

messages.content

string

The content of the message.

Example:

"Hello! I'm having trouble..."

messages.createdAt

string<date-time>

The date and time the message was created.

Example:

"2024-01-01T00:00:00.000Z"

messages.shouldUnflattenProperties

boolean | null

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

messages.properties

object

Additional metadata properties (key-value pairs)

rating

number | null

The numeric rating (integer)

shouldUnflattenProperties

boolean | null

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

properties

object

Additional metadata properties (key-value pairs)

Response

Conversation submitted successfully.

success

boolean

Example:

true

Create a new Feedback Record

⌘I

API Reference

Authorizations

Body

Response