API ReferenceapicommsPOST /v1/admin/erasure

POST /v1/admin/erasure

Service: comms · operationId: (none)

Hard-delete comms records for a person across message history and preferences

Required scopes

(no scope declared — review service config)

Request body

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "minLength": 1
    },
    "user_id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "request_id",
    "user_id"
  ]
}

Responses

200 Comms records erased or already absent

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "deleted",
        "not_present"
      ]
    },
    "rows_affected": {
      "type": "object",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "required": [
    "status",
    "rows_affected"
  ]
}

500 Erasure failed

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://comms.platform.loop.health/v1/admin/erasure \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'