Edit a text template

Change a template's message, or send channel_id to attach it to a campaign's text channel. Every call replaces content, and also landing_page_id and review_site_id (left out = cleared); name keeps its value when left out. Editing a shared (global) template saves a copy under your account with a new id (400 if your account already has a template with that name). Returns the updated template.

Prerequisites: a bearer token and the template's id (value in GET /api/v1/campaign/template/sms/list). Optional: a campaign channel id (channel_id, from data.data.channels[].id in the campaign create step 2 or 3 response).

Authentication: Account token. sms_template_id must be one of your account's templates or a shared template, and channel_id must be a channel of a campaign on a location inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 469

The template to edit (value in List text templates). Must be one of your account's templates or a shared template.

string
required
Defaults to Hi [customerName], thanks for visiting [locationName]. Tell us how we did: [landingPageUrl] Reply STOP to opt out.

The message text, with merge fields in square brackets such as [customerName], [landingPageUrl] and [locationName].

string
Defaults to Welcome SMS Template

A new name for the template. Must be unique among your account's templates and the shared templates. Leave it out to keep the current name.

integer
Defaults to 5394

A campaign channel to attach the template to; it becomes the channel's template. Must belong to a campaign on a location inside your account tree.

integer
Defaults to 4548

The landing page template to link (value in List landing page templates). Must be one of your account's landing page templates or a shared one. Replaced on every call; leave it out to clear it.

integer
Defaults to 44

A review site to link, by its id (value in List supported review sites). Replaced on every call; leave it out to clear it.

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