Developers
Questions10

Create a reply

POST/products/{product_id}/questions/{question_id}/replies

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.

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

question_id*string

Public ID of the question, prefixed with qst_.

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/questions/string/replies" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}

List replies to a question GET

Returns all replies to a question in a single response, in chronological order, while preserving the standard collection response format. Private replies and the draft reply (ID `qrp_draft_<question_id>`) are included only when the credentials have the `questions.read_private` permission. When present, the draft is listed last.

Retrieve a reply GET

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.