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

Headers

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

Path Parameters

​
conversationUid
string
required

Body

application/json
​
body
string
required

Body of message.

Response

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

Unique identifier of message.

​
body
string
required

Body of message.

​
conversation
object
required

Conversation message belongs to.

​
sender
object
required

Sender of message. Either a participant or the api team owner/admin. To find the external researcher, use conversation.metadata.externalResearcherId.

​
updatedAt
string