Get SMS template by ID

Overview

Get a single SMS template by id. When you supply campaign_id, it resolves the campaign's active SMS channel template instead. It substitutes [landingPageUrl] with the channel's landing-page URL (white-label aware). It replaces the remaining placeholders against the campaign's store.

Prerequisites

  • A bearer token in the Authorization header.
  • The smsTemplateId of the record you are targeting.

Base URL

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

Endpoint

GET /api/v1/campaign/template/sms/{smsTemplateId}

Authentication

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

  • bearer token, account role — authentication. Template must belong to the caller's account or be global.

Rate limit

  • No rate limit.

Path parameters

ParameterTypeRequiredDescription
smsTemplateIdintegerRequiredDigits only. Must belong to your own company.

Query parameters

FieldTypeRequiredDescription
campaign_idintegerOptionalMust be an existing campaign. Resolve the campaign's SMS channel template with placeholders filled from its store.

How it works

  • Synchronous. 200 OK with the full model under data.data. 422 if the id/campaign_id is invalid or the template is outside the caller's account.

Response

200 OK · 200

{
  "data": {
    "status": "success",
    "data": {
      "id": 1,
      "company_id": 30,
      "store_id": 123,
      "name": "Welcome SMS Template",
      "content": "Hi [customerName], Your feedback means a lot to us. Please click here to share: [landingPageUrl]. Thank you from [locationName]. Stop 2 End.",
      "json_content": null,
      "landing_page_id": 10,
      "review_site_id": 3,
      "created_at": "2026-07-09T10:30:00.000000Z",
      "updated_at": "2026-07-09T10:30:00.000000Z"
    }
  }
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422Returned if the id/campaign_id is invalid or the template is outside the caller's account
500Unexpected server error

Example request

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

Did this page help you?