Delete a customer

API at a glance

Description:
This API deletes a customer profile from Blueshift. Depending on the request, it can delete a single matching profile or multiple matching profiles.

Authentication & testing

Testing the API on this page

How to try it here

Use your User API Key as the Username (leave Password blank).

Select the appropriate API endpoint based on your Blueshift region.

Enter the necessary parameters and click Try It to run the request.

Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.

Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.

🚧
Caution
This action is irreversible. All customer data for the specified customer will be permanently deleted.

Things to know before you start

Multiple profile matches:
If multiple customer profiles match the identifier, this endpoint deletes only the first matching customer by default.
Delete all matching profiles:
To delete all matching profiles, set delete_all_matching_customers=true in the API call.
A single request can delete up to 50 profiles.
Deletion limit example:
If there are 100 profiles with the same email address, one API request deletes only 50 profiles.
Additional requests are required to delete the remaining profiles.
Asynchronous deletion:
Customer data deletion is not immediate. It can take a couple of hours to complete fully across systems.
Use case:
Best for permanently removing duplicate or unwanted customer profiles and fulfilling privacy or data cleanup requirements.

Request parameters

Check out the request parameters

Body parameters

Note: At least one identifier is required.

Parameter	Type	Required	Description
`email`	`string`	❌ No	Email address of the customer to delete.
`customer_id`	`string`	❌ No	External customer ID of the customer.
`cookie`	`string`	❌ No	Cookie ID assigned to the customer by your website.
`device_id`	`string`	❌ No	Device ID linked to the customer’s mobile or web device.
`delete_all_matching_customers`	`boolean`	❌ No	Set to `true` to delete all matching customer profiles (up to 50 per request).

Example requests & responses

Delete a single matching customer

{
  "email": "[email protected]"
}

{
  "status": "ok"
}

Delete all matching customer profiles

{
  "email": "[email protected]",
  "delete_all_matching_customers": true
}

{
  "status": "ok"
}

API error responses

Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.

Status code	Description	Example responses
400 Bad Request	The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.	`{ "errors": { "name": ["can't be blank"] } }` `{ "errors": { "startdate": ["can't be blank"] } }`
401 Unauthorized	API authentication failed due to an invalid or missing API key.	`{ "message": "Not authorized" }`
403 Forbidden	The API key does not have sufficient permissions to perform this action.	`{ "message": "Permission denied" }`
404 Not Found	The specified campaign was not found. Verify the campaign UUID.	`{ "message": "Campaign not found" }`
422 Unprocessable Entity	The campaign cannot be paused due to its current status (e.g., already completed or archived). One or more scheduling parameters may be invalid (if applicable).	`{ "message": "Campaign cannot be paused in its current status." }` `{ "message": "Invalid schedule values" }`
429 Too Many Requests	The request limit has been exceeded. Reduce request frequency.	`{ "message": "Rate limit exceeded" }`
500 Internal Server Error	An unexpected server error occurred. Contact support if the issue persists.	`{ "message": "Internal Server Error - Please contact support for more information." }`
502 Bad Gateway	The server received an invalid response. Retry the request.	`{ "message": "Bad Gateway - Please retry the request." }`
503 Service Unavailable	The service is temporarily unavailable. Try again later.	`{ "message": "Service Unavailable - The service is temporarily unavailable. Try again later." }`
504 Gateway Timeout	The server took too long to respond. Retry the request with exponential backoff.	`{ "message": "Gateway Timeout - The server took too long to respond. Retry with exponential backoff." }`