Skip to main content
PATCH
Update FAQ

Authorizations

Authorization
string
header
required

An API key (annie-sk-v2-...) or an OAuth access token, sent as Authorization: Bearer <token>.

Path Parameters

orgId
string<uuid>
required

The ID of the organization

faqId
string<uuid>
required

The ID of the FAQ to update

Body

Fields that can be updated on an existing FAQ

title
string

The question this FAQ answers

Maximum string length: 191
content
string

The answer Annie gives. Annie reads it aloud, so keep it short and conversational.

Maximum string length: 1000
botIds
string<uuid>[]

Bots that use this FAQ. Replaces the current list. Leave out to keep it.

Minimum array length: 1

Response

Response returned after updating an FAQ

success
enum<boolean>
required
Available options:
true
data
object
required

Represents a single FAQ entry and its bot associations