Use this endpoint to programmatically merge two duplicate customers, effectively unifying them as one. You can choose to use this end-point to:
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. |
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. To try this endpoint:
Get the User API Key from the API Keys tab of your Account Settings in the Blueshift app.
Paste the API key in the username field for Authentication. Leave the password field blank.
Click the Base URL dropdown and select the API endpoint URL for your Blueshift region. For EU region select api.eu.getblueshift.com and for the Rest of the world select api.getblueshift.com.
Specify the values of the API call using the fields provided below. Ensure that you specify values for the required fields.
Click Try It.
Note:
If no customers are present in our platform with either a combination of
email
/customer_id
orbsft_new_customer_id
; we will create a new user 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, we will only update the most recent customer profile. In such cases, we recommend you to use the
customer_id
if you have multiple profiles on an email address.If a customer exists with an
email
/customer_id
, but no customer exists withbsft_new_customer_id
; we will update thecustomer_id
of the existing customer tobsft_new_customer_id
.