Create Remove Customer Job¶
https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/event-data/create-remove-customer-job
POST¶
The remove customer data job removes all available data in Elevate related to a visitor. More GDPR information is available here.
Request¶
Header parameters¶
| Name | Description | Example |
|---|---|---|
| Api-Key Required | Api-key that was supplied during on-boarding | pkA123456789AB1BE.. |
Query parameters¶
| Name | Description | Example |
|---|---|---|
| customerKey Required | The customerKey to export data for. | e3921377-18a2-47c9-a449-06b894898623 |
curl -i \
-X POST \
-H 'Api-Key: pkA123456789AB1BE..' \
"https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/event-data/create-remove-customer-job?customerKey=e3921377-18a2-47c9-a449-06b894898623"
Response¶
Response codes¶
| Status | Description |
|---|---|
| 403 | Incorrect cluster credentials. |
| 400 | Invalid or missing required arguments. |
| 200 | Request accepted, remove job created |
Response body¶
Example
application/json
{
"jid" : "962d41f3-1a53-4bb8-bd01-3b85310fb45f",
"status" : "created"
}
Schema
EventDataJobResult¶
The object representation of create or checking the status of a event data job.
| Name | Type | Description | Example |
|---|---|---|---|
| jid | string | The identifier of the event data job. | "962d41f3-1a53-4bb8-bd01-3b85310fb45f" |
| status | string | The current status of the job Supported values: not_found, created, waiting, running, done, error. | "created" |