API at a glance
Description:
This API starts tracking a customer again in Blueshift. It allows the customer to be included in future tracking and campaigns.
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.
NoteIf a customer was previously forgotten, calling this API does not restore any previously deleted customer data. The customer will be treated as a new profile going forward.
Things to know before you start
- Required identifier: You must provide at least one identifier:
emailorcustomer_id. - No data recovery: This endpoint does not recover any historical data deleted using the Stop tracking a customer API.
- Tracking resumes: After a successful call, the customer becomes eligible for tracking and campaigns again.
- Use case: Best for re-enabling tracking for customers who have opted back in after being forgotten.
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 start tracking. |
customer_id | string | ❌ No | External customer ID of the customer. |
Example requests & responses
Start tracking by email
{
"email": "[email protected]"
}{
"status": "ok"
}Start tracking by customer ID
{
"customer_id": "CUST-12345"
}{
"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. Retry with exponential backoff.
You can upload up to 50 users in an API call.
Rate limit exceeded. Too many requests. Contact us at [email protected] for recommended throughput.
Internal server error. Contact Blueshift for more information.
Service unavailable, please retry. Bad gateway.
Service unavailable, please retry.
Service unavailable, please retry. Gateway timeout.