Skip to main content
GET
Read an automated SMS template editor

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

smsset_id
integer
required

Smsset id in the current organization.

trigger
string
required

Supported automated SMS trigger from the template catalog.

Query Parameters

donation_type
string

Stored variant key; defaults default.

Response

Operation result.

Receipt variants/support fields appear only when the trigger supports variants. data contains at most three latest commitment preview options.

smstemplate
object
smsset
object
to
boolean
Example:

true

title
string

Serialized value.

Example:

"Example"

shortcodes
string[]
participant_shortcodes
string[]
hysform
object[]
unrecognised_shortcodes
string[]
donor_hysform
object[]
trigger
string
Example:

"pay_receipt"

template_errors

SMS-set-id to trigger validation map; empty state serializes as an array.

data
object[]
sendblue
object

Authenticated organization Sendblue configuration. The current API includes credential values; treat this response as sensitive. Examples contain no real credentials.

supports_variants
boolean
Example:

true

variants
object
variant_shortcodes
object