post
https://api.getblueshift.com/api/v1/push_templates/test_push.json
API at a glance
Description: This API sends a test push notification to a specific user using a template's personalization context. Useful for testing push templates before launching 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.
Things to know before you start
- Finding template UUID: Template UUIDs can be found from the URL when viewing a template in Blueshift:
https://app.getblueshift.com/dashboard#/app/push_template/studio/<TEMPLATE_UUID>/edit/info. - Personalization context: The
personalize_foruser's profile data is used to populate template variables. - Recipient: The
emailparameter specifies who receives the test push notification. - Device requirement: The recipient must have a registered device to receive push notifications.
- Use case: Best for testing push templates, verifying personalization, previewing content before campaign launch, and QA testing.
Request parameters
Check out the request parameters
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | ✅ Yes | The UUID of the push template to send. |
personalize_for | string | ✅ Yes | Email address of the user whose personalization context to use. |
email | string | ❌ No | Email address of the user to whom you want to push the test message. |
Example requests & responses
Send a test push notification
Request
curl --request POST \
--url https://api.getblueshift.com/api/v1/push_templates/test_push.json \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>' \
--header 'content-type: application/json' \
--data '{
"uuid": "9da0744e-141d-4c9d-85d7-c89a54ac745b",
"personalize_for": "[email protected]",
"email": "[email protected]"
}'Response
{
"status": "OK"
}OK