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_valueYou can generate the encoded value using a trusted Base64 encoder.
Postman collection
Try it with Postman: Explore the API using Blueshift's Postman collection.
CautionThis 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, setdelete_all_matching_customers=truein 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"
}OK
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
Resource not found. This can happen due to resource conflicts. Retry with exponential backoff. If the issue persists, contact Blueshift.
Conflict error, please retry. The request could not be completed due to a conflict with the current state of the target resource. Re-try with exponential backoff.
You can upload up to 50 users in an API call.
Rate limit exceeded. Too many requests. Contact us on [email protected] for recommended throughput.
Internal server error. Contact Blueshift for more information.
Service unavailable, please retry. Bad gateway. Retry with exponential backoff.
Service unavailable, please retry. Service unavailable. Retry with exponential backoff.
Service unavailable, please retry. Gateway timeout. Retry with exponential backoff.