Tenant
The tenant API lets you manage and retrieve tenant-level information and configuration settings.
Customizing email messages
You can customize your tenant’s email messages by setting different templates.
These templates allow for HTML content and can contain certain context data, such as company name or current user details for a more personalized experience.
Templates can be set on tenant creation or at any point after using PATCH
Available templates
Currently the following email message templates can be defined inviteEmail - sent when a new user is created
Setting the message template
PATCH /tenant
// body:
{
"tenantId": "TENANT-123",
"templates": {
"inviteEmail": {
"body": "template string",
"subject": "template string"
}
}
}
// body:
{
"tenantId": "TENANT-123",
"templates": {
"inviteEmail": {
"body": "template string",
"subject": "template string"
}
}
}
Example request
{
"tenantId": "TENANT-123",
"templates": {
"inviteEmail": {
"body": "<h3>Welcome to 's hidout!</h3><p><strong>It is now officially party time.</strong></p><p>Here are your sign in credentials:</p><p>Company: <br/>Username: <br>Password: }</p><p>Please sign in here: </p><p>Your password must be changed at first sign in.</p>",
"subject": "Welcome to on Vince Live"
}
}
Context available in templates
Context can be used in templates to replace static text.
Messages are parsed using Vince Live Brackets which can be used to inject various dynamic values into the message.
Please see example above on how to reference context properties.
If a password or temporary reset code is present, it will be in the property code and without a reference to it the user will not be able to sign in.
user, // user entity object (see UserSchema for details)
tenant, // tenant entity object (see TenantSchema for details)
code, // password; string value that CAN contain special chars
urls: {
signIn // url that is either pointing to vince live login or from tenant's `urls.inviteEmail` property if present
}
}
Please note! code can contain special characters and MUST to be in the template as
} so that the parser does not remove non-HTML compatible characters.