v1

latestOpenAPI 3.1.02026-07-12113560.7 KB

Conversations

Create Conversation

post/unified/messaging/conversations

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

participantsstring[] nullable

List of participant user IDs in the conversation

namestring nullable

Name or title of the conversation

Example request

{
  "participants": [
    "c28xIQ1",
    "c28xIQ2"
  ],
  "name": "Project Discussion"
}

Response

The conversation was created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}