Developers
Questions10

Update a question

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

Reopens a question or changes whether it is pinned. The question text belongs to the user and cannot be changed.

Setting status to open returns the question to the queue of questions awaiting a reply and requires the questions.reopen permission. Any published reply remains visible. Changing pinned requires the questions.pin permission.

Send the ETag returned by the retrieve operation 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_.

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" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "body": {      "blocks": [        {}      ]    },    "created_at": "2019-08-24T14:15:22Z",    "has_draft": true,    "id": "string",    "lesson_id": "string",    "object": "question",    "pinned": true,    "product_id": "string",    "replies_count": 0,    "revision": "string",    "status": "open",    "updated_at": "2019-08-24T14:15:22Z",    "user": {      "id": "string",      "name": "string"    }  }}

Retrieve a question GET

Retrieves a question by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the question to avoid overwriting a newer version.

Delete a question DELETE

Deletes the question together with all of its replies. The question and its replies are no longer returned by the API.