Skip to main content
PATCH
Change one change of a feedback session

Authorizations

X-API-Key
string
header
required

Path Parameters

event_id
string<uuid>
required
change_id
string
required
Required string length: 2 - 12

Body

application/json

Change one change of a waiting feedback session, before the page's yes saves it.

rev
integer
required

The session's rev as read: a change made against an older set is refused (409).

Required range: x >= 0
off
boolean | null

True leaves it out of the save; false brings it back.

scope
enum<string> | null

sequence or account, on a new or rewritten learning only. A rewrite kept beside every sequence's learning stays this sequence's.

Available options:
sequence,
account
text
string | null

Its words: a learning's (add or update, one line, 1 to 300 characters), or an instruction edit's new words. Other kinds take none.

Maximum string length: 4000

Response

Successful Response

One thumbs down, as the note in place shows it.

action
enum<string>
required

What one event did to an agent's learnings.

Available options:
added,
updated,
split,
carried,
skipped,
seeded,
session,
deleted
agent_name
string
required
created_at
string<date-time>
required
id
string<uuid>
required
redo_detail
string | null
required
redo_state
enum<string>
required

How the redo a thumbs down asked for went.

Available options:
none,
started,
written,
refused
restore
enum<string>
required

Where putting the original output back stands after Undo: none, waiting, restored or left.

Available options:
none,
waiting,
restored,
left
restore_detail
string | null
required

Why the original was left as the redo left it.

status
enum<string>
required

applied (its learning is saved), undone after Undo, proposed while its feedback session (on a sequence's message, a table's cells or a Preview example) waits for a person, dismissed once that one was thrown away (Undo, a rejection, a discard, or a week unsaved).

Available options:
applied,
undone,
proposed,
dismissed
subject_key
string
required

What it was given on, as subject_key names it: a read of several subjects at once sorts its thumbs downs back to each by this.

surface
enum<string>
required

Where it was given. hand_edit is a learning a person's own edit proposed (POST /agent-learnings/hand-edits/): its card dismisses it (revert) and keeps the edit, and nothing is written again.

Available options:
table_cells,
agent_preview,
task,
writing_preview,
reply_draft,
sent_message,
hand_edit,
simplified,
carried,
template,
hand
text_after
string | null
required

The learning as the thumbs down wrote it.

text_before
string | null
required

What an updated learning said before.

earlier_words
StepWordsReadSchema · object[] | null

On a Preview contact's thread: each message as it read before this Needs work rewrote it, so the new words can be shown against them. Null on every other surface, and once the earlier words are no longer kept.

more
LearnedPartReadSchema · object[]

A table agent's other learnings it wrote, one for each other point the reason made, in order; empty when it made one. Always empty on an outbound message, whose changes proposal.changes lists. Undo takes them all back.

notes
string[]

What the person said, oldest first, each note whole: the thumbs down's own, then each later note after it. Empty once its feedback session closed (saved, discarded or undone): the notes go with the session.

proposal
ProposalReadSchema · object | null

The learning an outbound thumbs down proposed; null for a table agent's.

record_ids
string<uuid>[]

The rows a thumbs down on cells covered, so the grid shows its note on each; empty on every other surface.

rev
integer
default:0

The revision of its changes: send it back when changing one, so a change made against an older set is refused.

saved_agent_id
string<uuid> | null

The saved agent the thumbs down was given to (for an outbound one, its sequence's writer); null for an unlinked column's.

thread
SessionNoteReadSchema · object[]

While its session waits (proposed): each note, oldest first, with who gave it, the AI's reply and the words it was given on. Empty once the session closed: a session lasts as long as its item waits for a decision.

would_have_written
WouldHaveWrittenReadSchema · object | null

On a sent message: what the agent would have sent instead, once written (redo_state written); null before then and on every other surface.