post https://{host}/v2/requests
The PII deletion request API allows you to raise a PII deletion request.
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Make sure that PII deletion configuration is enabled. Refer Enable PII deletion documentation for more information.
- Make sure that you have appropriate access control configured. For more information, see access group documentation.
Request
Request curl: https://<host>/v2/requests
Body parameters
| Parameter | Type | Description |
|---|---|---|
| type | string | Type of the data. At present, only CUSTOMER is supported. |
| baseType | string | Type of the operation. In this context, DELETE is the operation type. |
| comments | string | Comments or description. |
| source | string | Source of customer data |
| identifierType | string | Type of identifier |
| identifierValue | string | Value of the identifier |
Response
| Parameter | Description |
|---|---|
| createdId | The request-id created. |
| warnings | Warnings, if any. |