Skip to main content
PATCH
Update Knowledge document

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Knowledge document sid (ub_as_…).

Required string length: 18
Pattern: ^ub_as_

Body

application/json

Request body of update_agent_source.

title
string

A new name.

Required string length: 1 - 255
instruction
string | null

A new instruction, read by the next parse (read_again_agent_source); null clears it.

Maximum string length: 600
refresh
enum<string>

A website's refresh (weekly or daily); its next read moves with it. 422 on a file.

Available options:
weekly,
daily

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.