Developers
Questions10

Update a reply

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

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.

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

reply_id*string

Public ID of the reply, prefixed with qrp_.

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/questions/string/replies/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"  }}

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.

Delete a reply DELETE

Deletes a published support reply or discards the question's draft reply. To discard the draft, use the reply ID `qrp_draft_<question_id>`. Deleting a published reply removes it from the user's view, and the question returns to the `open` status when no other support reply remains. Only support replies can be deleted; replies written by users are rejected with `403`, the `permission_denied` error code, and `details[].field` set to `author.kind`.