> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Change one change of a feedback session

> While a feedback session waits, change one of its changes before the page's yes (Approve, Send, Looks good) saves every change still on: leave it out (`off`) or bring it back, edit its words, or switch who it applies to. Send the session's `rev` as read; a change made against an older set is refused. The words on screen still follow the set as it was: ask for a rewrite (`/regenerate/`) to write them again. Only a signed-in person can, never an API key.



## OpenAPI

````yaml /openapi.json patch /agent-learnings/thumbs-downs/{event_id}/changes/{change_id}/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /agent-learnings/thumbs-downs/{event_id}/changes/{change_id}/:
    patch:
      tags:
        - agent-learnings
      summary: Change one change of a feedback session
      description: >-
        While a feedback session waits, change one of its changes before the
        page's yes (Approve, Send, Looks good) saves every change still on:
        leave it out (`off`) or bring it back, edit its words, or switch who it
        applies to. Send the session's `rev` as read; a change made against an
        older set is refused. The words on screen still follow the set as it
        was: ask for a rewrite (`/regenerate/`) to write them again. Only a
        signed-in person can, never an API key.
      operationId: update_session_change
      parameters:
        - in: path
          name: event_id
          required: true
          schema:
            format: uuid
            title: Event Id
            type: string
        - in: path
          name: change_id
          required: true
          schema:
            maxLength: 12
            minLength: 2
            title: Change Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionChangeUpdateSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThumbsDownEventReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Session or change not found
        '409':
          description: >-
            It was saved or discarded meanwhile, or a note or another edit
            changed the set since it was read: read it again.
        '422':
          description: The change's kind does not take this edit.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    SessionChangeUpdateSchema:
      description: >-
        Change one change of a waiting feedback session, before the page's yes
        saves it.
      properties:
        'off':
          anyOf:
            - type: boolean
            - type: 'null'
          description: True leaves it out of the save; false brings it back.
          title: 'Off'
        rev:
          description: >-
            The session's `rev` as read: a change made against an older set is
            refused (409).
          minimum: 0
          title: Rev
          type: integer
        scope:
          anyOf:
            - $ref: '#/components/schemas/ProposedScope'
            - type: 'null'
          description: >-
            `sequence` or `account`, on a new or rewritten learning only. A
            rewrite kept beside every sequence's learning stays this sequence's.
        text:
          anyOf:
            - maxLength: 4000
              type: string
            - type: 'null'
          description: >-
            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.
          title: Text
      required:
        - rev
      title: SessionChangeUpdateSchema
      type: object
    ThumbsDownEventReadSchema:
      description: One thumbs down, as the note in place shows it.
      properties:
        action:
          $ref: '#/components/schemas/LearningAction'
        agent_name:
          title: Agent Name
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        earlier_words:
          anyOf:
            - items:
                $ref: '#/components/schemas/StepWordsReadSchema'
              type: array
            - type: 'null'
          description: >-
            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.
          title: Earlier Words
        id:
          format: uuid
          title: Id
          type: string
        more:
          description: >-
            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.
          items:
            $ref: '#/components/schemas/LearnedPartReadSchema'
          title: More
          type: array
        notes:
          description: >-
            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.
          items:
            type: string
          title: Notes
          type: array
        proposal:
          anyOf:
            - $ref: '#/components/schemas/ProposalReadSchema'
            - type: 'null'
          description: >-
            The learning an outbound thumbs down proposed; null for a table
            agent's.
        record_ids:
          description: >-
            The rows a thumbs down on cells covered, so the grid shows its note
            on each; empty on every other surface.
          items:
            format: uuid
            type: string
          title: Record Ids
          type: array
        redo_detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Redo Detail
        redo_state:
          $ref: '#/components/schemas/RedoState'
        restore:
          $ref: '#/components/schemas/RestoreState'
          description: >-
            Where putting the original output back stands after Undo: `none`,
            `waiting`, `restored` or `left`.
        restore_detail:
          anyOf:
            - type: string
            - type: 'null'
          description: Why the original was left as the redo left it.
          title: Restore Detail
        rev:
          default: 0
          description: >-
            The revision of its changes: send it back when changing one, so a
            change made against an older set is refused.
          title: Rev
          type: integer
        saved_agent_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The saved agent the thumbs down was given to (for an outbound one,
            its sequence's writer); null for an unlinked column's.
          title: Saved Agent Id
        status:
          $ref: '#/components/schemas/LearningEventStatus'
          description: >-
            `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).
        subject_key:
          description: >-
            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.
          title: Subject Key
          type: string
        surface:
          $ref: '#/components/schemas/LearningSource'
          description: >-
            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.
        text_after:
          anyOf:
            - type: string
            - type: 'null'
          description: The learning as the thumbs down wrote it.
          title: Text After
        text_before:
          anyOf:
            - type: string
            - type: 'null'
          description: What an updated learning said before.
          title: Text Before
        thread:
          description: >-
            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.
          items:
            $ref: '#/components/schemas/SessionNoteReadSchema'
          title: Thread
          type: array
        would_have_written:
          anyOf:
            - $ref: '#/components/schemas/WouldHaveWrittenReadSchema'
            - type: 'null'
          description: >-
            On a sent message: what the agent would have sent instead, once
            written (`redo_state` `written`); null before then and on every
            other surface.
      required:
        - id
        - subject_key
        - action
        - text_after
        - text_before
        - status
        - surface
        - restore
        - restore_detail
        - redo_state
        - redo_detail
        - created_at
        - agent_name
      title: ThumbsDownEventReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    ProposedScope:
      description: Which writers a proposed learning reaches once saved.
      enum:
        - sequence
        - account
      title: ProposedScope
      type: string
    LearningAction:
      description: What one event did to an agent's learnings.
      enum:
        - added
        - updated
        - split
        - carried
        - skipped
        - seeded
        - session
        - deleted
      title: LearningAction
      type: string
    StepWordsReadSchema:
      description: >-
        One email or message of a Preview contact's thread, as it read before a
        Needs work.
      properties:
        body:
          description: The words.
          title: Body
          type: string
        step_id:
          description: The sequence step it was written for.
          format: uuid
          title: Step Id
          type: string
        subject:
          anyOf:
            - type: string
            - type: 'null'
          description: The subject line; null for LinkedIn.
          title: Subject
      required:
        - step_id
        - subject
        - body
      title: StepWordsReadSchema
      type: object
    LearnedPartReadSchema:
      description: >-
        One more learning a thumbs down wrote, for another point its reason
        made.
      properties:
        action:
          $ref: '#/components/schemas/LearningAction'
          description: '`added` a learning, or `updated` one about the same thing.'
        learning_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: The learning; null once it was deleted.
          title: Learning Id
        previous_text:
          anyOf:
            - type: string
            - type: 'null'
          description: What the updated learning said before; null for an added one.
          title: Previous Text
        text:
          anyOf:
            - type: string
            - type: 'null'
          description: The learning as the thumbs down wrote it.
          title: Text
      required:
        - action
        - learning_id
        - text
        - previous_text
      title: LearnedPartReadSchema
      type: object
    ProposalReadSchema:
      description: >-
        What a feedback session will learn, before a person saves it.


        Saved by Save (POST .../save/), by approving the rewritten task or
        reply, or by Looks

        good on the rewritten Preview contact, the cells or the Preview example;
        thrown away by

        Undo, a rejection or a discard. A table agent's changes are its own, at
        `sequence` scope.

        `changes` lists every change; the fields beside it describe the first
        add or rewrite.
      properties:
        auto_rewrites:
          description: >-
            How many messages written ahead (Tasks cards, messages waiting to
            send on their own, and waiting reply drafts) were written again once
            it was saved.
          title: Auto Rewrites
          type: integer
        changes:
          description: Every change it makes to the learnings, in the learner's order.
          items:
            $ref: '#/components/schemas/ProposedChangeReadSchema'
          title: Changes
          type: array
        learn_detail:
          anyOf:
            - type: string
            - type: 'null'
          description: Why it failed, said on the card; null when ok.
          title: Learn Detail
        learn_state:
          $ref: '#/components/schemas/LearnState'
          description: >-
            `ok`, or `failed` when the learner could not work out what to learn
            from the last note: nothing new is learned until Retry, and the
            changes before it stand.
        moved_from_text:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Once saved for every sequence: this sequence's learning it took the
            place of, which Undo puts back.
          title: Moved From Text
        points:
          description: >-
            What the notes ask for, as its learner read them; each change names
            its own. Empty once the session closed: they go with its notes.
          items:
            $ref: '#/components/schemas/ProposalPointReadSchema'
          title: Points
          type: array
        replaces_scope:
          anyOf:
            - $ref: '#/components/schemas/ProposedScope'
            - type: 'null'
          description: >-
            Whose learning the first change rewrites: this sequence's, or every
            sequence's. A rewrite of every sequence's learning kept at
            `sequence` scope saves a new learning for this sequence instead
            (Replaces in this sequence).
        replaces_text:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The saved learning the first change rewrites, as it read when
            proposed (Replaces: ...); null when it adds one.
          title: Replaces Text
        rev:
          description: 'The revision of `changes`: it moves on every refine or edit of them.'
          title: Rev
          type: integer
        saved_learning_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The learning the first change saved, once saved; null while it waits
            or once thrown away.
          title: Saved Learning Id
        scope:
          $ref: '#/components/schemas/ProposedScope'
          description: >-
            The first change's scope. `sequence`: this sequence only (the
            default). `account`: every sequence's writer, its emails, LinkedIn
            messages and replies.
        text:
          description: The first change's learning as it would be saved, one line.
          title: Text
          type: string
      required:
        - changes
        - rev
        - text
        - scope
        - replaces_text
        - replaces_scope
        - saved_learning_id
        - moved_from_text
        - auto_rewrites
        - points
        - learn_state
        - learn_detail
      title: ProposalReadSchema
      type: object
    RedoState:
      description: How the redo a thumbs down asked for went.
      enum:
        - none
        - started
        - written
        - refused
      title: RedoState
      type: string
    RestoreState:
      description: Where putting an undone event's original output back stands.
      enum:
        - none
        - waiting
        - restored
        - left
      title: RestoreState
      type: string
    LearningEventStatus:
      description: >-
        Where an event stands.


        A thumbs down starts ``proposed``: the learner's learning waits, on the
        rewritten message

        or on the cells or Preview example it runs again (FS-18), until a person
        saves it

        (``applied``) or it is thrown away (``dismissed``). Older table
        learnings, saved at once,

        stay ``applied``.
      enum:
        - applied
        - undone
        - proposed
        - dismissed
      title: LearningEventStatus
      type: string
    LearningSource:
      description: >-
        Where a learning came from: the surface a thumbs down was given on, or a
        release pass.


        Also the ``surface`` of the event that wrote it.
      enum:
        - table_cells
        - agent_preview
        - task
        - writing_preview
        - reply_draft
        - sent_message
        - hand_edit
        - simplified
        - carried
        - template
        - hand
      title: LearningSource
      type: string
    SessionNoteReadSchema:
      description: One note of a feedback session and the AI's reply to it.
      properties:
        at:
          description: When it was given.
          format: date-time
          title: At
          type: string
        dropped:
          description: Changes of earlier notes this note took back.
          items:
            $ref: '#/components/schemas/DroppedChangeReadSchema'
          title: Dropped
          type: array
        kind:
          $ref: '#/components/schemas/ThreadNoteKind'
          description: '`note` a person typed, or `edit`: a person''s own edit of the words.'
        number:
          description: 'From 1, oldest first: what a change''s `note` names.'
          title: Number
          type: integer
        reply:
          description: 'The AI''s reply: what it changed and what it kept to this item.'
          title: Reply
          type: string
        text:
          description: The note; for an edit, the passages changed.
          title: Text
          type: string
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Who gave it.
          title: User Id
        words:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: >-
            The words the note was given on, before its rewrite: what the page
            marks the rewrite against. Null when not kept.
          title: Words
      required:
        - number
        - kind
        - text
        - user_id
        - at
        - reply
        - words
        - dropped
      title: SessionNoteReadSchema
      type: object
    WouldHaveWrittenReadSchema:
      description: >-
        What the agent would have sent in place of a sent message, with the
        proposed learning.
      properties:
        body:
          description: The words.
          title: Body
          type: string
        subject:
          anyOf:
            - type: string
            - type: 'null'
          description: The subject line; null for LinkedIn.
          title: Subject
      required:
        - subject
        - body
      title: WouldHaveWrittenReadSchema
      type: object
    ProposedChangeReadSchema:
      description: >-
        One change a feedback session makes: a learning, an instruction, the
        link or a fact.
      properties:
        find:
          anyOf:
            - type: string
            - type: 'null'
          description: An instruction edit's words it replaces.
          title: Find
        history:
          description: How it read before later notes rewrote it, oldest first.
          items:
            $ref: '#/components/schemas/ChangeVersionReadSchema'
          title: History
          type: array
        id:
          description: 'Stable within its session: `c1`, `c2`...'
          title: Id
          type: string
        kind:
          $ref: '#/components/schemas/ChangeKind'
          description: >-
            `add` a learning, `update` (rewrite) one, `delete` one, or `keep`
            one that already says what a point asks (nothing is written);
            `instruction`: edit a step's or the reply's instruction (`find`
            becomes `replace_with`); `link`: the sequence's call-to-action link
            becomes `text`; `fact`: keep `question` and its answer `text` in the
            business Q&A.
        note:
          description: >-
            The note of the session (`thread[].number`) that last made or
            rewrote it; 0 for one made before notes were threaded.
          title: Note
          type: integer
        'off':
          description: >-
            A person left it out: the page's yes saves every change still on,
            never this one.
          title: 'Off'
          type: boolean
        outcome:
          anyOf:
            - $ref: '#/components/schemas/ChangeOutcome'
            - type: 'null'
          description: >-
            Null while it waits. Once saved: `applied`, `skipped_full` (its list
            was full) or `skipped_changed` (what it changes was edited
            meanwhile); an instruction, link or fact is `pending` until written,
            a moment after the save. Once undone: `undo_pending`, then `undone`,
            or `left` when it was changed since.
        points:
          description: The numbers of the points it learns (`points`).
          items:
            type: integer
          title: Points
          type: array
        question:
          anyOf:
            - type: string
            - type: 'null'
          description: A fact's question.
          title: Question
        replace_with:
          anyOf:
            - type: string
            - type: 'null'
          description: What an instruction edit puts in their place; empty removes them.
          title: Replace With
        replaces_scope:
          anyOf:
            - $ref: '#/components/schemas/ProposedScope'
            - type: 'null'
          description: 'Whose learning it rewrites: this sequence''s, or every sequence''s.'
        replaces_text:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The saved learning it rewrites or deletes, as it read when proposed;
            null for an add.
          title: Replaces Text
        saved_learning_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The learning it saved, once applied; null for a delete or while it
            waits.
          title: Saved Learning Id
        scope:
          $ref: '#/components/schemas/ProposedScope'
          description: >-
            `sequence`: this sequence only. `account`: every sequence's writer.
            For a delete, whose learning goes.
        step_label:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            An instruction edit's step, e.g. "Step 2 · Follow up", or "Replies";
            for an add or an update, the one step the learning holds for, null
            for every message.
          title: Step Label
        text:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The learning as it would read; a link change's new link; a fact's
            answer. Null for a delete, a keep or an instruction edit.
          title: Text
        words:
          description: >-
            How many words its learning has (a learning aims at 5 to 10); 0 for
            a change with no learning.
          title: Words
          type: integer
      required:
        - id
        - kind
        - text
        - step_label
        - find
        - replace_with
        - question
        - scope
        - replaces_text
        - replaces_scope
        - outcome
        - saved_learning_id
        - points
        - note
        - 'off'
        - history
        - words
      title: ProposedChangeReadSchema
      type: object
    LearnState:
      description: Whether a session's learner turned its notes into changes (F3, F5).
      enum:
        - ok
        - failed
      title: LearnState
      type: string
    ProposalPointReadSchema:
      description: One thing a feedback session's notes ask for, as its learner read them.
      properties:
        covered:
          description: Whether a change learns it.
          title: Covered
          type: boolean
        goes_to:
          $ref: '#/components/schemas/PointGoesTo'
          description: >-
            Where it belongs: `rule` (a learning), `this_message` (only this
            message: the rewrite follows it, nothing is kept), `instruction` (a
            step's or the reply's instruction), `link` (the sequence's
            call-to-action link), `fact` (the business Q&A), `sender` (a
            sender's own setting, changed on Senders) or `research` (the
            sequence's research settings). `sender` and `research` are never
            written.
        note:
          description: The note it is in, from 1, oldest first (see `notes`).
          title: Note
          type: integer
        number:
          description: 'From 1, across every note: what a change''s `points` name.'
          title: Number
          type: integer
        quote:
          description: >-
            The note's own words for it; empty when the learner's quote was not
            found.
          title: Quote
          type: string
        reason:
          anyOf:
            - type: string
            - type: 'null'
          description: Why it is not learned (it names this contact, say); null when it is.
          title: Reason
        said:
          description: The point in a few words.
          title: Said
          type: string
      required:
        - number
        - note
        - quote
        - said
        - covered
        - reason
        - goes_to
      title: ProposalPointReadSchema
      type: object
    DroppedChangeReadSchema:
      description: A change a later note took back.
      properties:
        id:
          description: The change's id, as it was.
          title: Id
          type: string
        kind:
          $ref: '#/components/schemas/ChangeKind'
        text:
          anyOf:
            - type: string
            - type: 'null'
          description: What it said.
          title: Text
      required:
        - id
        - kind
        - text
      title: DroppedChangeReadSchema
      type: object
    ThreadNoteKind:
      description: What a note of a feedback session is.
      enum:
        - note
        - edit
      title: ThreadNoteKind
      type: string
    ChangeVersionReadSchema:
      description: How a session's change read before a later note rewrote it.
      properties:
        find:
          anyOf:
            - type: string
            - type: 'null'
          description: An instruction edit's words it replaced.
          title: Find
        note:
          description: The note that made this version.
          title: Note
          type: integer
        replace_with:
          anyOf:
            - type: string
            - type: 'null'
          description: What the instruction edit put in their place.
          title: Replace With
        text:
          anyOf:
            - type: string
            - type: 'null'
          description: The learning, link or fact's answer as it read.
          title: Text
      required:
        - note
        - text
        - find
        - replace_with
      title: ChangeVersionReadSchema
      type: object
    ChangeKind:
      description: What one change of a feedback session does to the learnings (F2).
      enum:
        - add
        - update
        - delete
        - keep
        - instruction
        - link
        - fact
      title: ChangeKind
      type: string
    ChangeOutcome:
      description: What saving a session did with one of its changes (F2).
      enum:
        - applied
        - skipped_full
        - skipped_changed
        - pending
        - undo_pending
        - undone
        - left
        - left_out
      title: ChangeOutcome
      type: string
    PointGoesTo:
      description: Where one point of a session's notes belongs (F7).
      enum:
        - rule
        - this_message
        - instruction
        - link
        - fact
        - sender
        - research
        - pending
      title: PointGoesTo
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.