Developers
Comments9

Update a comment

PATCH/products/{product_id}/comments/{comment_id}

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.

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

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/string/comments/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"    }  }}

Retrieve a comment GET

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.

Delete a comment DELETE

Deletes a top-level comment together with all of its replies. To remove a single reply while keeping the rest of the conversation, use the delete reply operation.