Create SMS template

Overview

Create a new campaign SMS template owned by the caller's account. The body content is seeded with a fixed default message (Hi [customerName], … [landingPageUrl] … [locationName]. Stop 2 End.); edit it via the update endpoint. Returns a trimmed field set.

Prerequisites

A bearer token in the Authorization header.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/campaign/template/sms/create

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
bearer token, account role — authentication. Stamped with company_id = user.person.company_id. store_id, if supplied, must belong to the caller's hierarchy (an ownership check).

Rate limit

No rate limit.

Request body

Field	Type	Required	Description
`name`	string	Required	Unique among the caller's account templates and global templates.
`store_id`	integer	Optional	Scope to one store; must be in the caller's hierarchy (an ownership check).

{
  "name": "Welcome SMS Template",
  "store_id": "<storeId>"
}

How it works

Synchronous. 200 OK returns data.data = only(id,name,content,landing_page_id,review_site_id,store_id). 422 on validation failure (e.g. duplicate name).

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "message": "SMS Template has been created successfully!",
    "data": {
      "id": 1,
      "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.",
      "landing_page_id": null,
      "review_site_id": null,
      "store_id": 123
    }
  }
}

422 Duplicate name · `422`

{
  "message": "The template name has already been taken.",
  "errors": {
    "name": [
      "The template name has already been taken."
    ]
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	Duplicate name
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/template/sms/create" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Welcome SMS Template", "store_id": 4564756}'

Updated 9 days ago

Did this page help you?