context

Create or update a context entry

Changed on

Save context (Messaging Playbook, user profile, what they sell) the moment the user says save or remember, identity facts as type "user-profile". Who they want to find is never saved here: that is the search plan. A playbook write AMENDS the saved document: send the fields that change, a field left out is kept, a field sent as null is removed. Every other type replaces the whole entry, so merge the new information into what is already saved. Renaming is not a rewrite, send the type and the saved scope with the new label and no content. To delete a saved memory, an old ICP included, send its type and scope with remove true and no content.

put/context

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/context
  • Auth: HTTP bearer

Request body

typestring required

One of three closed slots, user-profile, offering or playbook, chosen by what the content means for outreach (global identity or offering, or a named first-DM voice), never a free-form custom:* slug. A remove also takes icp, to delete an old saved ICP.

contentstring

Markdown content, or the document itself when it is structured.

scopestring

Omit scope and pass label so the server derives and attaches "user:playbook:<slug>" (identity/offering fields keep plain "user", rejected for playbook); to reuse a voice already saved instead of rewriting it, send its existing scope alone with no content.

labelstring

Display label

removeboolean

True deletes the saved memory of this type (icp included) at this scope, or with this label, instead of saving, and unbinds it from every list that used it. Send no content.

Response

Context saved, or removed

OR

Changes

  • b657f915ce03Revision changes
    • info

      added the optional property // to the response with the status

  • 0d86cfdab3a4Revision changes
    • warning

      removed the optional property // from the response with the status