API at a glance
Description: This API retrieves a list of SMS templates from your Blueshift account. You can filter by template name, message type (SMS/MMS), archived status, and use pagination to manage large result sets.
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
- Optional filters: All query parameters are optional. Leave them blank to retrieve all templates.
- Message types: Filter by
smsfor text messages ormmsfor multimedia messages. - Archived status: Use
0for unarchived templates,1for archived templates. Leave blank for all templates. - Pagination: Use
per_pageandpageparameters to paginate through results. - Response structure: Returns an array of SMS template objects with metadata.
- Use case: Best for managing SMS templates, auditing template inventory, and integrating with external systems.
Request parameters
Check out the request parameters
Query parameters
Note: All query parameters are optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
resource.message_type | string | ❌ No | Filter by message type. Values: sms or mms. |
name | string | ❌ No | Search for SMS templates that contain the specified string in the name. |
archived | integer | ❌ No | Filter by archived status. 0 for unarchived, 1 for archived. Leave blank for all. |
per_page | string | ❌ No | Specify the number of records to return per page. |
page | string | ❌ No | Specify the page number for the search results. |
Example requests & responses
List all SMS templates
Request
curl --request GET \
--url https://api.getblueshift.com/api/v1/sms_templates.json \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'Response
[
{
"name": "Template SMS test",
"created_at": "2024-10-03T04:57:24.000Z",
"updated_at": "2024-10-15T09:30:12.000Z",
"uuid": "bb8e4fd8-12cf-3409-899b-7d2b4ecfc93b",
"archived": false,
"is_destroy": true,
"author": "Jane Doe"
}
]Filter by message type with pagination
Request
curl --request GET \
--url 'https://api.getblueshift.com/api/v1/sms_templates.json?resource.message_type=sms&per_page=5&page=1' \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'Response
[
{
"name": "Template SMS test",
"created_at": "2024-10-03T04:57:24.000Z",
"updated_at": "2024-10-15T09:30:12.000Z",
"uuid": "bb8e4fd8-12cf-3409-899b-7d2b4ecfc93b",
"archived": false,
"is_destroy": true,
"author": "Jane Doe"
}
]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. Re-try with exponential backoff.
Rate limit exceeded. Too many requests. Contact us on [email protected] for recommended throughput.
Internal server error. Contact Blueshift for more information.
Service unavailable, please retry. Bad gateway. Retry with exponential backoff.
Service unavailable, please retry. Service unavailable. Retry with exponential backoff.
Service unavailable, please retry. Gateway timeout. Retry with exponential backoff.