post https://api.getblueshift.com/api/v1/customers/merge
Use this endpoint to programmatically merge two duplicate customers, effectively unifying them as one.
You can use this API to complete the following actions:
- Merge 2 customers with different customer_ids
- Update the customer_id of an existing customer in Blueshift
Attribute | Description |
---|---|
email or customer_id or both | Previous/current unique identifier for the customer in Blueshift. |
bsft_new_customer_id | The customer_id of the target customer. |
- If no customers are present in our platform with either a combination of
email/customer_id
orbsft_new_customer_id
, a new customer is created withbsft_new_customer_id
. - If both customers exist, the profile data of the old customers will get merged to the new customer (
bsft_new_customer_id
). - If there are multiple customer profile matches, for example if you provide an
email
and there are multiple customers associated with that email, only the most recent customer profile is updated. In such cases, if you have multiple profiles for an email address, we recommend you to use thecustomer_id
instead ofemail
. - If a customer exists with an
email/customer_id
, but no customer exists withbsft_new_customer_id
, thecustomer_id
of the existing customer is updated tobsft_new_customer_id
.
The Merge customers endpoint is throttled at 1500 calls/minute. Reach out to [email protected] if you want to increase the rate limits or if you have any questions.
Try it out
- Add the User API key as the Username and leave the Password field blank.
- Click the Base URL dropdown and select the API endpoint URL for your Blueshift region.
- Click Try It.
You can also try the API using Blueshift's API collection in Postman.