Delete Profile
- DarkLight
Delete Profile
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API enables the deletion of a profile from Data Cloud to comply with GDPR requirements. Profile deletion is processed asynchronously. When a delete request is submitted, Data Cloud creates a deletion job that can be tracked using the Profile Deletion Job Status API.
Endpoint URL
The API endpoint used to delete a profile is:
/cxs/profiles/bulk-delete
HTTP Method
The method to be used for the request:
POST
Request Body Structure
For sending profile IDs, structure your request body as follows:
{
"profile_ids": [
"f5521b32-0eb4-4f3f-a14f-ea6b4d99b92e",
"53fb199e-dcf0-4bea-b85d-0cae3aa4732a"
]
} Request Field Descriptions
This table outlines the required fields for the API request, including their types, whether they are mandatory, and their descriptions.
Field Name | Data Type | Required | Description |
|---|---|---|---|
profile_id | String | Yes | Unique identifier of the profile whose deletion status is being queried. |
Sample Response
{
"job_id": "9354e371-e5ce-4bee-bed7-20755967ad2b"
}Response Field Description
This table outlines the response fields for the API request, including their types, whether they are, and their descriptions.
Field Name | Data Type | Description |
|---|---|---|
jobId | String | Unique identifier of the profile deletion job. This ID is used to track the deletion status. |
Limits
Profile deletion is handled asynchronously. Processing time may vary depending on system load.
Error Response
Error Response | Description |
|---|---|
401 – Unauthorized | Indicates that the API request is not authenticated. |
400 – Bad Request | The input format is incorrect. Refer to the documentation for the correct format. |
405 – Method Not Allowed | Indicates that the HTTP method used in the request is not allowed for the specified resource. |
429 – Too Many Requests | Indicates that the client has exceeded the allowed number of requests within a given time frame. |
Was this article helpful?