Developers
FAQs

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 current group; positions start at 1. 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

Header Parameters

If-Match?string

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

curl -X PATCH "https://example.com/support/faqs/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

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.