Merge customers

API at a glance

Description:
This API merges two customer profiles or updates the customer_id of an existing customer in Blueshift.
It helps consolidate duplicate profiles and maintain a single, unified customer record.

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.

Things to know before you start

Supported actions:
You can use this API to:
- Merge two customers with different customer_ids
- Update the customer_id of an existing customer in Blueshift
Required identifiers:
You must provide:
- email or customer_id (or both) to identify the existing customer and
- bsft_new_customer_id as the target customer_id
New customer creation:
If no customers exist with either the provided email/customer_id or bsft_new_customer_id, a new customer is created with bsft_new_customer_id.
Merge behavior:
If both customers exist, profile data from the old customer is merged into the target customer (bsft_new_customer_id).
Multiple profile matches:
If multiple profiles match (for example, multiple customers with the same email), only the most recent profile is updated.
Recommendation: If you have duplicate profiles, use customer_id instead of email to avoid ambiguity.
Customer ID update:
If a customer exists with email/customer_id, but no customer exists with bsft_new_customer_id, the existing customer’s customer_id is updated to bsft_new_customer_id.
Rate limit:
This endpoint is throttled at 1500 requests per minute.
Contact [email protected] if you need a higher limit.
Use case:
Best for deduplicating customer profiles, fixing incorrect customer IDs, and consolidating customer data after migrations or integrations.

Request parameters

Check out the request parameters

Body parameters

Parameter	Type	Required	Description
`email`	`string`	❌ No	Email address of the existing customer.
`customer_id`	`string`	❌ No	Current customer ID of the existing customer.
`bsft_new_customer_id`	`string`	✅ Yes	Target `customer_id` to merge into or update to.

Note: You must provide at least one of email or customer_id, along with bsft_new_customer_id.

Example requests & responses

Merge two customers

{
  "email": "[email protected]",
  "bsft_new_customer_id": "CUST-99999"
}

{
  "status": "ok"
}

Update customer ID

{
  "customer_id": "CUST-12345",
  "bsft_new_customer_id": "CUST-67890"
}

{
  "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." }`