Menu

Org erasure

1 endpoint in the Mattering Sales API.

POST org-erasure/ User APIService tier

POST to org-erasure/. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/org-erasure/
  • Service tierhttps://sales.mattering.io/api/internal/org-erasure/

Body keys (JSON)

KeyRequiredDefault
_emailoptional or conditionalnone
_org_idoptional or conditionalnone
emailoptional or conditionalnone
org_idoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "data": {
    "app": "...",
    "deleted": true,
    "anonymised": "...",
    "retained": "...",
    "files": [
      "..."
    ]
  },
  "meta": {
    "dry_run": "...",
    "more": true
  }
}

409 bare JSON object (no envelope)

...

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
500files_failed

Example

curl -X POST "https://sales.mattering.io/api/user/v1/org-erasure/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "_email": "...",
  "_org_id": "...",
  "email": "...",
  "org_id": "..."
}'

Source: CRMCore/data_rights.py (data_rights.org_erasure_view)

All Sales resources
Start Free Explore our Products