/sms/v1/projects/{projectToken}/sync
This method allows you to trigger Transactional SMS from our API and send them through Bloomreach Engagement.
The transactional SMS API is disabled by default. To configure this API in your project, please contact your Customer Success Manager. We will set up the SMS API for you based on your needs.
Incorrect code displays
Note that some language versions incorrectly display
"params": { \"first_name\": \"Marian\" }instead of"params": { "first_name":"Marian" }.
Definition
Authorization
In this API call you must use the following authorization access and permissions:
| Available access type | Permissions needed |
|---|---|
| Private access | Campaigns > Transactional SMS API |
Read more about:
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| projectToken | string | The ID of your project. | Required |
Body parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| content | object | Content of the SMS message. This can be either by using an existing Bloomreach Engagement SMS template, or through raw text. Learn more below. | Required |
| campaign_name | string | Name of the SMS campaign. | Required |
| recipient | object | Recipient of the SMS message. | Required |
| settings | object | JSON object containing currently supported SMS template settings. Settings defined as part of the payload will override any settings pre-configured within a used template. | Optional |
transfer_identitydefault behaviorThe default behavior is
enabled, which is all clicks identification. However, it's important to note that this does not necessarily match the default configuration in the project/SMS template, which might normally be first-click identification. This is true only when you use our Campaign Link Shortener.
Content object parameters
Content object parametersThere are two ways in which you can define the content of your SMS through this API method:
- Using Bloomreach Engagement template: Create an SMS template in Bloomreach Engagement, then send it through API.
- Using raw SMS: Define the SMS message contents within your API request.
The definition of the content object will differ based on which method you specify the content. Please find below the descriptions of the object parameters for both outlined ways.
(1) Using Bloomreach Engagement template
| Parameter | Type | Description | Required |
|---|---|---|---|
| template_id | string | The ID of the SMS template you wish to send. This can be found in the URL when you go to the selected predefined template. | Required |
| params | object | Provide all the required data for email personalization used in the template. Format: "param_name": "value".For example: "first_name": "Marian" | No |
(2) Using raw message
| Parameter | Type | Description | Required |
|---|---|---|---|
| message | string | Content of the SMS message. | Required |
| sender | string | Your sender phone number. | Required |
| max_message_parts | int | The maximum allowed number of message parts. If exceeded, the SMS message will not be sent. Minimum value: 1, Maximum value: 8, Default value: 8 | No |
Recipient object parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| phone | string | Specify the phone number of the customer. If the phone number is not provided, it will be taken out from the customer profile in Bloomreach Engagement based on the customer ID. | Optional |
| customer_ids | string | Specify the customer that should receive your SMS. You can use any type of a customer ID. Common example would include registered. | Required |
| language | string | Language version of your template. If the template has several language versions created, you can choose which one to use for this SMS. | Optional |