Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
Email

GetEmailTemplate

Get the full data of a specific email template <b>Permissions Required: </b> GlobalPermissions.Email.Templates.GetEmailTemplateNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

get/api/Email/GetEmailTemplate

Query parameters

pkEmailTemplateRowIdinteger

Id of the email template to retrieve

Response

OK

pkEmailTemplateRowIdinteger

Row id

Namestring

Tempalte friendly name

TemplateTypestring

Template type. Used to map database field

Subjectstring

Subject of the email

Conditionstring

Condition to evaluate what template to use

PreviewBeforeGeneratingboolean

Preview email before send it

HTMLboolean

Indicate if the email is HTML

AttachPDFboolean

Indicate if the email will have an invoice attached

Enabledboolean

Template enabled or not

fkEmailAccountRowIdinteger

Row Id of the email account used to send the email

Bodystring

Email body content

PromptPreviewReferenceNumberstring

Text to be shown to the customer when he want to preview an order