Developers
Comments9

Retrieve a comment

GET/products/{product_id}/comments/{comment_id}

Retrieves a top-level comment by its public ID.

The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the comment to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

comment_id*string

Public ID of the comment, prefixed with cmt_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/comments/string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "lesson_id": "string",    "object": "comment",    "pinned": true,    "product_id": "string",    "replies_count": 0,    "revision": "string",    "status": "pending",    "text": "string",    "updated_at": "2019-08-24T14:15:22Z",    "user": {      "id": "string",      "name": "string"    }  }}

List product comments GET

Lists the top-level comments posted on a product's lessons. Replies are available through the list comment replies operation. The collection can be filtered by lesson, user, status, and a text search term. Results are paginated with a cursor and sorted by ID, newest first by default; use `sort=id` for oldest first.

Update a comment PATCH

Moderates or pins a top-level comment. Only `status` and `pinned` can be changed; the comment text cannot be edited. Changing `status` requires the `comments.moderate` permission, and changing `pinned` requires the `comments.pin` permission. The retrieve operation returns an `ETag` representing the current revision. Send this value in the optional `If-Match` header to avoid overwriting a newer version; if the comment has changed since that revision, the update is rejected.