Update mention list

This endpoint enables you to update the list of mentions for a specific comment. Updating the mention list allows you to add or remove mentions of participants in a comment.

How to use

You can use the following cURL to obtain a response on the endpoint:

curl --location --request PUT https://api.superviz.com/threads/comments/{commentId}/mentions \
  --header 'Content-Type: application/json' \
  --header "client_id: ${YOUR CLIENT_ID}" \
  --header "secret: ${YOUR SECRET}" \
  --data '{
    "participants": [
        {
            "id": "PARTICIPANT_ID_1"
        },
        {
            "id": "PARTICIPANT_ID_2"
        }
    ]
  }'

Headers

When using this endpoint, you need to provide the Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Request Body

Name	Type	Description
commentId	string	The ID of the comment.
participants	array	The list of participants to mention.

Response

Status code 201 will indicate that the mention list was updated successfully.