Transactional API v1

10,000 requests per minutes

How Transactional Messages works

Templates are stored in springbig and will go through a review phase. Only when templates are approved can the templates be used to deliver the SMS to the springbig recipient.

Create a Template for review

Templates will be reviewed by a springbig curation agent to ensure the template holds acceptable content to avoid carrier rejections. The template message will include your complete template string.

CURL Example

curl --request POST  
   --url <https://{environment}.api.springbig.technology/general/v1/message_templates>  
   --header 'AUTH-TOKEN: {YOUR AUTH-TOKEN}'  
   --header 'Content-Type: application/json'  
   --header 'x-api-key: {YOUR x-api-key}'  
   --data '{  
       "message": "Thanks for shopping with us. Your order will be ready soon."  
    }'

Retrieve a list of approved templates

You can retrieve a list of templates tied to your account. These templates will include an id that will be required when sending a template message to the springbig recipient.

CURL Example

curl --request GET \
  --url https://{environment}.api.springbig.technology/general/v1/message_templates \
  --header 'AUTH-TOKEN: {YOUR AUTH-TOKEN}' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {YOUR x-api-key}' \

Send template messaging to springbig recipient

URL Endpoint: https://{environment}.api.springbig.technology/general/v1/members/{member_id}/template_message member_id is a required value on the path
{environment} accepts staging , gamma or production

Headers:
AUTH-TOKEN authenticates the merchant

x-api-key authenticates the client

Body:

*required parameters

• template_message :string
• template_id :integer
• arguments : object.
  • arguments accept two properties:
    args: array of comma-separated strings
    url: string or null string

CURL Example

curl --request POST  
  --url \`<https://{environment}.api.springbig.technology/general/v1/members/{member_id}/template_message>  
  --header 'AUTH-TOKEN: {YOUR AUTH TOKEN}'  
  --header 'Content-Type: application/json'  
  --header 'x-api-key: {YOUR x-api-key}'  
  --data '{  
    "template": {  
        "template_id": 1,  
        "template_message": "Thanks for shopping with us.Your order will be ready soon.",  
        "arguments": {  
					"args": [],  
					"url": "" }  
} }'

🚧

At this time we will not be accepting arguments or url. However, the empty strings should be included

SMS Log

• A “reply END to stop.” text will be appended at the end of the message

  Response Types and Responses