ROrocketlane
Conversations

Creates conversation

Changed on

The Create Conversation API allows users to initiate a new conversation within a specified project using its unique project ID. This endpoint facilitates seamless communication by enabling teams to start discussions, share updates, and collaborate effectively within the project workspace. Upon a successful request, the API returns the newly created conversation details, including metadata such as participants, timestamps, and initial message content.

post/1.0/conversations

Request

Query parameters

includeFieldsstring[]

Use this query parameter to opt in for fields to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Request body

namestring required

Conversation name

descriptionstring

Conversation description

allMembersboolean

Conversation all members inclusion

privateboolean

Conversation privacy

Example request

{
  "name": "General chat",
  "description": "This is the starting of the General chat",
  "source": {
    "sourceId": 201,
    "sourceType": "PROJECT_CONVERSATION"
  },
  "allMembers": true,
  "members": [
    {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201,
      "firstName": "John",
      "lastName": "Doe"
    }
  ],
  "private": true
}

Response

The requested action was successfully executed.

conversationNamestring

Conversation name

descriptionstring

Conversation description

allMembersboolean

Conversation all members inclusion

conversationIdinteger

Conversation ID

createdAtinteger

Conversation Created timestamp

privateboolean

Conversation privacy

Example response

{
  "conversationName": "General chat",
  "description": "This is the starting of the General chat",
  "allMembers": true,
  "members": [
    {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201,
      "firstName": "John",
      "lastName": "Doe"
    }
  ],
  "source": {
    "sourceId": 201,
    "sourceType": "PROJECT_CONVERSATION"
  },
  "conversationId": 201,
  "createdAt": 1681319726000,
  "private": true
}

Changes