ROrocketlane
Conversations

Update conversation

Changed on

The Update Conversation API allows users to modify an existing conversation within a specified project using its unique project ID. This endpoint enables updates to message content, metadata, or status, ensuring that project discussions remain accurate and up to date. This API is designed for use cases where message edits, status updates, or other modifications need to be applied to an ongoing project conversation. It is particularly useful for integrations that require real-time collaboration updates, correction of message errors, or status adjustments for read/unread tracking.

put/1.0/conversations/{conversationId}

Request

Path parameters

conversationIdinteger required

The ID of the conversation object

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

conversationIdinteger

Conversation ID

namestring

Conversation name

descriptionstring

Conversation description

allMembersboolean

Conversation all members inclusion

Example request

{
  "conversationId": 201,
  "name": "General chat",
  "description": "This is the starting of the General chat",
  "allMembers": 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