Skip to content
/
Schedule anonymization fo...

Schedule anonymization for specified entity
deprecated

Request

Security
ApiKeyAuth or BearerAuth
Bodyapplication/jsonrequired

Entity info to schedule anonymization

entity_idstringrequired

Id of the entity

entity_typestring(AnonymizationType)required

A type of entity for anonymization.

Enum:"user""conversation"
force_anonymizationboolean

If set to true, anonymizes entity regardless of the status of related conversations. Defaults to false

POST
/v1/anonymization_request
curl -i -X POST \
  /v1/anonymization_request \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_id": "string",
    "entity_type": "user",
    "force_anonymization": true
  }'

Responses

Scheduled anonymization

Bodyapplication/json
dataobject(ScheduleAnonymizationResponse)
Response
{
  "data": {
    "id": "string",
    "target_entity_id": "string",
    "entity_type": "user",
    "initiated_at": "string",
    "requested_by": "string",
    "processed_at": "string"
  }
}