List SMS templates

Overview

Get SMS templates selectable for a store as a {value, label} dropdown source. The list combines the given store's templates, the caller account's templates, and global templates (where both company_id and store_id are NULL). Results are sorted by name.

Prerequisites

  • A bearer token in the Authorization header.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/campaign/template/sms/list

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • bearer token, account role — authentication. Company templates scoped to user.person.company_id.

Rate limit

  • No rate limit.

Query parameters

FieldTypeRequiredDescription
store_idintegerRequiredStore to list templates for. Must be in the caller's hierarchy (an ownership check).

How it works

  • Synchronous, not paginated. 200 OK with data.response = array of {value, label}. 422 if store_id is missing or outside the caller's hierarchy.

Response

200 OK · 200

{
  "data": {
    "status": "success",
    "response": [
      {
        "value": 1,
        "label": "Welcome SMS Template"
      }
    ]
  }
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422Returned if store_id is missing or outside the caller's hierarchy
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/template/sms/list?store_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?