Skip to main content
GET
Email template Details

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

emailset_id
integer
required

The id of the email set

trigger
string
required

The trigger for the email template

Query Parameters

receipt_context
object

Optional giving-source context. Use giving_source=daf and recipient_role=soft_credit for the DAF advisor thank-you backed by the soft_credit variant. Missing context preserves ordinary Direct soft-credit behavior; a missing DAF advisor template starts disabled with recommendation wording.

Response

Successful operation

emailtemplate
object

The email template object

emailset
object

The email set object

to
string

The recipient of the email

title
string

The title of the email

shortcodes
string[]

The shortcodes used in the email

Full recommended shortcode set for the selected variant and program settings, including tokens already present in the body. Omitting these does not block delivery.

required_shortcodes
string[]

Full shortcode set required for delivery under the current program settings, including tokens already present in the body.

hysform
object

The hysform object

unrecognised_shortcodes
string[]

The unrecognised shortcodes in the email

donor_hysform
object

The donor hysform object

trigger
string

The trigger for the email

template_errors
string[]

The errors in the email template