SMS templates

Create and manage the text messages a campaign sends.

Create and manage the text messages a campaign sends.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
POSTCreate a text templateCreate a new campaign SMS template owned by the caller's company.
GETList text templatesGet SMS templates selectable for a store as a {value,label} dropdown source: the given store's templates plus the caller company's templates plus global (both company_id and store_id NULL) templates, sorted by name.
POSTEdit a text templateUpdate an existing SMS template (content, name, landing-page and review-site links).
GETGet one text templateGet a single SMS template by id.