Update Single Comment

PUT

/collection/{collection_id}/comment/{comment_id}

Update a single Comment

NOTE

A comment can only be changed by the user that added it, or a user with the role administrator

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Path Params

Body Params application/json

Example

{
    "text": "string",
    "user_mentions": [
        {
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "name": "string",
            "tag": "string",
            "indices": [
                0
            ]
        }
    ],
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.vplan.com/v1/collection//comment/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--data-raw '{
    "text": "string",
    "user_mentions": [
        {
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "name": "string",
            "tag": "string",
            "indices": [
                0
            ]
        }
    ],
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}'

Responses

🟢204No Content

This response does not have a body.

🟠412412

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-22 14:20:42

Retrieve Single Comment

Remove Single Comment