Create New Comment

POST

/collection/{collection_id}/comment

Create a new Comment and store it for this collection

Because oAuth is authenticated by a user, this is the user creating this comment.
For integrations that are not user specific, customers are advised to create a separate user specifically for this integration.

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 POST '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

🟢201Created

application/json

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "text": "string",
    "user_mentions": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "name": "string",
            "tag": "string",
            "indices": [
                0
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}

🟠412412

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In

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

Retrieve Comment List

Retrieve Single Comment