POST
/
unified
/
messaging
/
conversations
Create Conversation
curl --request POST \
  --url https://api.stackone.com/unified/messaging/conversations \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "participants": [
    "c28xIQ1",
    "c28xIQ2"
  ],
  "name": "Project Discussion",
  "private": true
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Body

application/json
​
participants
string[] | null

List of participant user IDs in the conversation

Example:
["c28xIQ1", "c28xIQ2"]
​
name
string | null

Name or title of the conversation

Example:

"Project Discussion"

​
private

Whether the conversation is private

Example:

true

Response

The conversation was created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required