Developers
Comments9

Create a comment reply

POST/products/{product_id}/comments/{comment_id}/replies

Adds a reply to a top-level comment.

Replies created through the API are attributed to the credential that made the request (author.kind is credential).

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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

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

curl -X POST "https://example.com/products/string/comments/string/replies" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "data": {    "author": {      "id": "string",      "kind": "user"    },    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "object": "comment_reply",    "revision": "string",    "status": "pending",    "text": "string"  }}

List comment replies GET

Lists the replies to a top-level comment in chronological order.

Update a comment reply PATCH

Updates the text or the moderation status of a comment reply. Only the text of replies written by an administrator or an API credential (`author.kind` is `admin` or `credential`) can be changed; attempts to edit the text of any other reply return `403` with the `permission_denied` error code and `details[].field` set to `author.kind`. Changing `status` requires the `comments.moderate` permission. To avoid overwriting a newer version, send the optional `If-Match` header built from the reply's `revision` field, in the format `W/"comment_reply:<reply_id>:<revision>"`. If the reply has changed since that revision, the update is rejected.