Skip to main content
POST
Forget golden set rows

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.

Body

application/json

Request body of forget_agent_examples.

filter
object
required

The rows to forget, at least one field: { sender_profile_sid: { eq } } forgets what one sender profile taught, { source: { eq: "history" } } the harvest, { proposed: { eq: true } } every edit waiting for a Keep. A bare call is a 422.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required