API ReferenceCollections

Create a collection comment

View as Markdown

Creates a comment on a collection. To create a reply on an existing comment, include the threadId property in the request body.

Note:

This endpoint accepts a max of 10,000 characters.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

collectionIdstringRequiredformat: "uid"
The collection's unique ID.

Request

This endpoint expects an object.
bodystringRequired
The contents of the comment.
threadIdintegerOptional
The comment's thread ID. To create a reply on an existing comment, include this property.
tagsobjectOptional

Information about users tagged in the body comment.

Response

Created
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error