post
https://api.getblueshift.com/api/v1/sms_templates/test_send.json
API at a glance
Description: This API sends a test SMS/MMS message to a specific mobile number using a template's personalization context. Useful for testing SMS 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
- Mobile number format: Include the country code with the phone number. For example, for US number
2345678with country code1, specify as12345678. - Personalization context: The
personalize_foruser's profile data is used to populate template variables (e.g.,{{user.firstname}}). - Template UUID: The UUID of the SMS/MMS template you want to test.
- Use case: Best for testing SMS/MMS 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 SMS template to send. |
mobile | string | ✅ Yes | Mobile number with country code (e.g., 167892453 for US number with country code 1). |
personalize_for | string | ✅ Yes | Email address of the user whose personalization context to use. |
Example requests & responses
Send a test SMS message
{
"uuid": "153e6eaa-cae2-45a3-a59c-f6bed9a38712",
"mobile": "167892453",
"personalize_for": "[email protected]"
}{
"status": "OK"
}