Remove Customer Data¶
GDPR compliance feature
The remove customer data job is part of Apptus solutions for enabling GDPR compliance concerning data managed by Apptus eSales 4.
The remove customer data job removes all available data in Apptus eSales 4 related to a visitor.
A customerKey argument is supplied to start a removal job of all available data related to the given key. Linked keys and their related data will also be included in the removal job.
The remove customer data job works with archived data only. The removal job will start once the data from the job initiation date has been archived. Default time for archiving is 5 days. Export and removal can run concurrently but it is recommended to start the export first.
It is recommended to perform an Export and download before any customer data is removed.
All data is removed once the customer data job status returns done.
Request¶
Request method¶
POST
Request URL¶
https://{cluster-id}.api.esales.apptus.cloud/api/v2/event-data/create-remove-customer-job?customerKey={customerKey}
Request parameters¶
| Name | Type | Description | Example |
|---|---|---|---|
customerKey | string | Visitor id, e.g. UUID / GUID. | d9528...e9feca |
Request header¶
When executing queries with the GDPR API, an Api-Key header is required for authentication.
Request body¶
Not applicable
Request content-type¶
Not applicable
Response¶
A response will always return a Customer Data Job Status.
Response content-type¶
application/json
Examples¶
Request¶
cURL¶
#!/bin/bash
curl -i \
-X POST \
- H "Api-Key: {PRIVATE-KEY}"
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/event-data/create-remove-customer-job?customerKey=d9528030-509c-4e0f-b585-7168f1e9feca"
Response¶
{
"jid": "ca24b4e2-34ab-406a-a4db-b30b0247837a",
"status": "started"
}