Retrieve a reply

GET/products/{product_id}/questions/{question_id}/replies/{reply_id}

Retrieves a published reply by its public ID, or the question's draft reply using the ID qrp_draft_<question_id>.

Private replies and drafts are visible only to credentials with the questions.read_private permission. Without it, they return 404 Not Found.

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

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_.

question_id*string

Public ID of the question, prefixed with qst_.

reply_id*string

Public ID of the reply, prefixed with qrp_.

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/questions/string/replies/string"
{  "data": {    "author": {      "id": "string",      "kind": "user"    },    "body": {      "blocks": [        {}      ]    },    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "object": "question_reply",    "revision": "string",    "status": "published",    "visibility": "public"  }}

Create a reply POST

Publishes a support reply to a question or saves a draft reply. Requires an `Idempotency-Key` header. With `status` set to `published` (the default), the reply is published with the requested `visibility` (`public` by default) and any saved draft is discarded. A question has a single support reply: if one already exists, its content is replaced. The user is notified only when the reply is first published, and only public replies generate events. With `status` set to `draft`, the content is saved as the question's draft reply without publishing it, and `visibility` is ignored. The draft does not affect any reply already visible to the user.

Update a reply PATCH

Updates a published support reply or the question's draft reply (ID `qrp_draft_<question_id>`). For a published reply, `body` corrects the content without notifying the user again, and `visibility` switches the reply between `public` and `private`. Only support replies can be updated; replies written by users are rejected with `403`, the `permission_denied` error code, and `details[].field` set to `author.kind`. For the draft, `body` replaces the draft content. Setting `status` to `published` publishes the draft (using the supplied `body`, if any) with the supplied `visibility` (`public` by default), with the same effects as publishing through the create operation. Send the `ETag` returned by the retrieve operation, for a published reply or for the draft, in the `If-Match` header to avoid overwriting a newer version.