Developers
Comments

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
comment_id*string

Header Parameters

If-Match?string

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

curl -X PATCH "https://example.com/products/string/comments/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

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.