Skip to main content
POST
sms.template.preview

Authorizations

Authorization
string
header
required

A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.

Body

application/json
name
string
required

The template name. The reserved name auth.signin.sms overrides the built-in sign-in text.

Required string length: 1 - 120
Pattern: ^[a-z][a-z0-9_-]*(\.[a-z][a-z0-9_-]*)*$
locale
string

Preview as a recipient in this language. Falls back the same way a real send does.

Maximum string length: 20
variables
object

Values for the template's variables

draft
boolean
default:false

Preview the unpublished draft instead of the published version

Response

{ activityId, result }. activityId is empty for reads.

activityId
string
required

The activity this call created, or empty for a read.

result
object
required
Last modified on September 13, 2026