Developers
FAQs6

Update an FAQ entry

PATCH/support/faqs/{faq_id}

Updates an FAQ entry. Only the fields present in the request are changed.

Setting position moves the entry within its group; positions start at 1. When group is changed in the same request, position applies within the new group. Changing status also requires the faqs.publish permission.

To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header. The header is optional; when it is omitted, the update is applied to the current revision.

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

faq_id*string

Public ID of the faq, prefixed with faq_.

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/support/faqs/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "answer": {      "blocks": [        {}      ]    },    "created_at": "2019-08-24T14:15:22Z",    "group": "string",    "id": "string",    "object": "faq",    "position": 0,    "question": "string",    "revision": "string",    "status": "draft",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve an FAQ entry GET

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

Delete an FAQ entry DELETE

Deletes an FAQ entry. Deleted entries no longer appear in the collection and can no longer be retrieved.