Skip to main content
PATCH
Update a Knowledge answer

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

Answer sid (ub_an_…).

Required string length: 18
Pattern: ^ub_an_

Body

application/json

Request body of update_agent_answer.

question
string

A new question; the vector is written again.

Required string length: 1 - 500
phrasings
string[] | null

The ways leads put the question, up to twelve, each up to 200 chars; the question itself and repeats are dropped.

Maximum array length: 12
Maximum string length: 200
answer
string

A new answer text.

Required string length: 1 - 1200
attachment
object | null

{ when } sets when the file goes out; null takes the file away. 409 answer_has_no_file when the answer carries none.

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.