Update SMS template

Update an existing SMS template (content, name, landing-page and review-site links). Copy-on-write for globals: a template with no company_id copies into the caller's company first (a name clash returns 400). When you supply channel_id the template is set as that channel's template_id.

Auth

  • bearer token, account role — authentication. sms_template_id must resolve to a template owned by the caller's company (or a global one).

Rate limit

  • No rate limit.

Body

FieldTypeRequiredNotes
sms_template_idintegerRequiredMust be an existing SMS template inside your own account tree.
contentstringRequiredSMS body with placeholders.
namestringOptionalNew name. Unique within the caller's company and against global (shared) templates (ignores this row).
channel_idintegerOptionalMust be an existing campaign channel. Sets the channel's template_id.
landing_page_idintegerOptionalMust be an existing landing-page template.
review_site_idintegerOptionalMust be an existing review site.

Behaviour

  • Synchronous. 200 OK returns data.data = only(id,name,content,landing_page_id,review_site_id,store_id). 400 (envelope) when replicating a global and the name already exists for the company. 422 on validation failure or when the template is not in the caller's company.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
string
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json