Email Templates
Allows customization of email templates
Definition of terms
The following keys are needed to work with email templates
flowKey
There can be many flows each with its own email templates
Email template types
The following email template types are available Signup
, Notification
,
Confirmation
or SalesPerson
.
Template type | Description | When | Address to use in To field |
---|---|---|---|
Signup | Sent to the customer requesting his signature | When a signing process or sequence is created | {{customer.email}} |
Notification | Sent to the company | When a signing process or sequence has completed | someemail@yourcompany.com |
Confirmation | Sent to the customer | When a signing process or sequence has completed | {{customer.email}} |
SalesPerson | Sent to your company user that sent the signature request to the customer | When a signing process or sequence has completed | {{salesPerson}} |
Register an email template
Email templates can be managed via the API. All routes can be viewed in Swagger
Handler template
Example email template
{
"flowKey": "722989cac3fx",
"to": "{{customer.email}}",
"Bcc": "",
"subject": "Electronic signature request from {{companyName}}",
"message": "<p>{{companyName}} asks you to sign {{customer.Meta.pdfFileName}}</p>",
"includeFiles": false,
"templateType": "Signup",
"language": "En"
}
Handler template values
The following values are available for use in the message
Handle | Description |
---|---|
{{customer.address}} | The customers address * |
{{customer.city}} | The customers city * |
{{customer.email}} | The customers email * |
{{customer.name}} | The customers name * |
{{customer.phoneNumber}} | The customers phone number * |
{{customer.postalCode}} | The customers postal code * |
{{customer.ssn}} | The customers social security number * |
{{customer.Meta.pdfFileName}} | The name of the file to be signed |
{{salesPerson}} | The email of the company user that sent the signature request |
{{companyName}} | The name of your company |
{{companySsn}} | The social security number of your company * |
{{flowName}} | The name of the flow |
{{customer.Meta.VARIABLE}} | where VARIABLE is your custom field created via Smart Form |
- *if provided by you