Conversations

Add members to the conversation

Changed on

This endpoint can be used to add members to the conversation in a project using its ID. This API returns the project conversation along with the members for the project specified.

post/1.0/conversations/{conversationId}/add-members

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

emailIdstring

Email ID

userIdinteger

User ID

firstNamestring

First name

lastNamestring

Last name

Example request

[
  {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  }
]

Response

The requested action was successfully executed.

conversationIdinteger

Conversation ID

Example response

{
  "conversationId": 201,
  "members": [
    {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201,
      "firstName": "John",
      "lastName": "Doe"
    }
  ]
}

Changes