Skip to content

organization_product_erasure_request

Erase one end user of this product, named by email address, phone number, your own user id and display name.

Tool

organization_product_erasure_request

Erase one end user of this product, named by email address, phone number, your own user id and display name.

Erase one end user of this product, named by email address, phone number, your own user id and display name. Identifiers are hashed on arrival and no tool on this surface returns one. `organization_product_erasure_list` reads the requests back. Returns: { id, subjectType, subjectId, controller, productId, subjectRefs, requestedBy, requestedAt, dueAt, status, acks }. Typical sequence: organization_product_erasure_request → organization_product_erasure_get. Fails when: no email, phone and external id is given, or the caller does not hold owner or admin on the product. Irreversible.

Behavior

HTTP
POST /governance/api/v1/products/:productId/erasure

Arguments

Name
Type
Required
Description
name
string
—
Display name of the end user, e.g. "Oleg Pravdikov". A weak match on its own; hashed on arrival.
emails
array
—
Email addresses of the end user, 0-10, e.g. ["oleg@example.com"]. Hashed on arrival; never stored.
phones
array
—
Phone numbers as the product stores them, 0-10, e.g. ["+7 999 123-45-67"]. Digits and a leading plus are kept; no country is inferred. Hashed on arrival; never stored.
productId
string
•
Product uuid, e.g. "3f6c1e2a-9c1e-4b1a-8f0e-2a7d5c9b1e34".
externalIds
array
—
Your own ids for the end user, 0-10, e.g. ["Cust-00417"]. Case is preserved; enough on their own to name the person. Hashed on arrival; never stored.

Response

Field
Type
Always
Description
id
string
•
acks
array
•
dueAt
string
•
status
string
•
productId
string
•
startedAt
string
—
subjectId
string
•
controller
string
•
finishedAt
string
—
cancelledBy
object
—
requestedAt
string
•
requestedBy
object
•
subjectRefs
object
—
subjectType
string
•
cancelReason
string
—

Try it

Erase one end user of this product, named by email address, phone number, your own user id and display name.

When to use

Erase one end user of this product, named by email address, phone number, your own user id and display name. Identifiers are hashed on arrival and no tool on this surface returns one. `organization_product_erasure_list` reads the requests back. Returns: { id, subjectType, subjectId, controller, productId, subjectRefs, requestedBy, requestedAt, dueAt, status, acks }. Typical sequence: organization_product_erasure_request → organization_product_erasure_get. Fails when: no email, phone and external id is given, or the caller does not hold owner or admin on the product. Irreversible.

Example

Ask your agent something like this:

Erase one end user of this product, named by email address, phone number, your own user id and display name.

The agent will invoke organization_product_erasure_request with these arguments:

{
  "productId": "<productId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select