POST
/
projects
/
{projectId}
/
conversations
curl --request POST \
  --url https://api.chat-dash.com/v1/public/projects/{projectId}/conversations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "platformId": "<string>",
  "name": "<string>",
  "read:": false,
  "endedAt": "current_timestamp",
  "browser": "<string>",
  "device": "<string>",
  "os": "<string>",
  "countryCode": "<string>",
  "ipAddress": "<string>",
  "record": false,
  "interacted": false,
  "isLive": false,
  "channel": "<string>",
  "phone": "<string>",
  "instagramId": "<string>",
  "instagramUsername": "<string>"
}'
{
  "message": "Conversation added successfully",
  "conversation": {
    "_id": "<string>",
    "platformId": "<string>",
    "name": "<string>",
    "read:": true,
    "endedAt": "<string>",
    "browser": "<string>",
    "device": "<string>",
    "os": "<string>",
    "countryCode": "<string>",
    "ipAddress": "<string>",
    "record": true,
    "interacted": true,
    "isLive": false,
    "channel": "<string>",
    "phone": "<string>",
    "instagramId": "<string>",
    "instagramUsername": "<string>"
  }
}

Headers

​
Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

​
projectId
string
required

The ID of the project

Body

application/json
​
platformId
string

The ID of the conversation from the original platform (e.g. Voiceflow transcriptID, OpenAI thread_id)

​
name
string

The name of the user who created the conversation

​
read:
boolean
default:
false

Whether the conversation has been read

​
endedAt
string
default:
current_timestamp

The date and time the conversation ended (ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ)

​
browser
string

The browser used for the conversation

​
device
string

The device used for the conversation

​
os
string

The operating system used for the conversation

​
countryCode
string

The country code associated with the user's location (ISO 3166-1 alpha-2)

​
ipAddress
string

The IP address of the User

​
record
boolean
default:
false

Whether to record the conversation

​
interacted
boolean
default:
false

Whether there is user interaction in the conversation

​
isLive
boolean
default:
false

Whether the conversation is still ongoing or has ended

​
channel
string

The channel where the conversation took place (Webchat, WhatsApp, Instagram)

​
phone
string

The phone number of the user for WhatsApp conversations

​
instagramId
string

The Instagram ID of the user for Instagram conversations

​
instagramUsername
string

The Instagram username of the user for Instagram conversations

Response

200
application/json
OK
​
message
string
​
conversation
object
Fetch Project ConversationsUpdate Conversation