POST
/
v1
/
messaging
/
conversations
Create a conversation
curl --request POST \
  --url https://api-staging.respondent.io/v1/messaging/conversations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '{
  "projectId": "<string>",
  "participantUserIds": [
    "<string>"
  ],
  "externalResearcherId": "<string>",
  "externalTeamId": "<string>",
  "externalCompanyId": "<string>"
}'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "uid": "<string>",
  "name": "<string>",
  "deleted": true,
  "locked": true,
  "read": true,
  "metadata": {
    "projectId": "<string>",
    "surveyResponseId": "<string>",
    "externalResearcherId": "<string>",
    "externalTeamId": "<string>",
    "externalCompanyId": "<string>"
  },
  "user": {
    "uid": "<string>",
    "foreignId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "participants": [
    {
      "uid": "<string>",
      "foreignId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "read": true,
      "deleted": true
    }
  ],
  "messages": [
    {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "uid": "<string>",
      "body": "<string>",
      "sender": {
        "uid": "<string>",
        "foreignId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "latestMessage": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "uid": "<string>",
    "body": "<string>"
  },
  "messagesCount": 123
}

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Body

application/json
​
projectId
string<ObjectId>
required

ProjectId of the project the coversation belongs to.

​
participantUserIds
string<ObjectId>[]
required

UserId(s) of participants of conversation (not including researcher). Minimum 1 participant required.

​
externalResearcherId
string
deprecated

Derived from project values.

​
externalTeamId
string
deprecated

Derived from project values.

​
externalCompanyId
string
deprecated

Derived from project values.

Response

201 - application/json
​
createdAt
string
required
​
uid
string
required

Unique identifier of conversation.

​
name
string
required

Name of conversation.

​
deleted
boolean
required

If conversation is marked as deleted.

​
locked
boolean
required

If conversation is locked.

​
read
boolean
required
deprecated
​
user
object
required

User who created the conversation. This will be the API owner/admin account for the api team. First name and last name will belong to api team user, not external researcher name. External researcherId will be stored in metadata, which can be used to lookup your external researcher's info internally.

​
participants
object[]
required

All participants of conversation including the researcher. The researcher will be the API owner/admin account for the api team.

​
messages
object[]
required

All messages in conversation.

​
latestMessage
object
required

Latest message in conversation.

​
messagesCount
number
required

Count of messages in conversation.

​
updatedAt
string
​
metadata
object

Metadata of conversation.