Skip to main content
PUT
Update a knowledge base item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The knowledge base item id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
restricted_to_segments
string[]

Contact segment ids this item should be restricted to. Pass [] to make it available to all contacts.

restricted_to_channels
enum<string>[]

Channels this item should be restricted to. Pass [] to make it available on all channels.

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice,
twitter,
twitter_mentions,
app_review,
internal
start_time
string<date-time> | null

ISO 8601 instant (UTC) when the AI may start using this item. Null clears it.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
end_time
string<date-time> | null

ISO 8601 instant (UTC) when the AI stops using this item. Null clears it.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
visibility
enum<string>
Available options:
internal,
public
title
string

Response

Default Response

id
string
required
title
string
required
visibility
enum<string>
required
Available options:
internal,
public
source_type
enum<string>
required
Available options:
custom_training,
help_center,
integration,
website,
workflow
source_url
string | null
required
restricted_to_segments
string[]
required

Contact segment ids this item is restricted to. Empty = available to all contacts.

restricted_to_channels
enum<string>[]
required

Channels this item is restricted to. Empty = available on all channels.

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice,
twitter,
twitter_mentions,
app_review,
internal
start_time
string<date-time> | null
required

Active window start (UTC). Null = no start bound.

end_time
string<date-time> | null
required

Active window end (UTC). Null = no end bound.

updated_at
string<date-time>
required
data_source
enum<string> | null

External source the item was synced from (present when listing).

Available options:
confluence,
notion,
zendesk_support,
shopify,
gitbook,
intercom,
front,
freshdesk,
hubspot_kb,
sharepoint,
genesys,
ai_instructions,
custom_training,
website,
workflow,
help_center
stream
string | null
folder_path
string[] | null

Synced folder trees (Confluence): folder ids from the source root down to the item (present when listing).