Templates
Last updated
Last updated
We support the following templates:
Consents API
Preference Management Platform
Privacy request module
Template ID: confirm-consent-changed
Send a confirmation email to let users know that their changes have been correctly taken into account.
No parameters are provided when sending a confirmation of changes email.
Template ID: consents-user-created
Send a welcome message to the user with an authenticated link to the Preference Center when the user is created through their first consent event.
The following parameters are provided to the template when sending a welcome message:
privacy_center_url
URL of the Preference Center with a valid consent token.
Template ID: validation-approval-file
Approval request for confirming changes to a user consent status from an event that uses the file validation method. Approval requests are similar to double opt-in but are intended to be processed internally, while double opt-in is a confirmation from the end-user directly.
The following parameters are provided to the template when sending an approval email:
validation_approve_url
URL to redirect the user for approving consent choices. This should be used as the URL for a link or button in the email.
Template ID: validation-approval-signature
Approval request for confirming changes to a user consent status from an event that uses the signature validation method. Approval requests are similar to double opt-in but are intended to be processed internally, while double opt-in is a confirmation from the end user directly.
The following parameters are provided to the template when sending an approval email:
validation_approve_url
URL to redirect the user for approving consent choices. This should be used as the URL for a link or button in the email.
Template ID: validation-double-optin
Collect double opt-in for a consent event that uses the email validation method.
This allows users to confirm their choices before a consent event is stored.
The following parameters are provided to the template when sending a double opt-in email:
validation_approve_url
URL to redirect the user to confirm their consent choices. This should be used as the URL for a link or button in the email.
Didomi allows you to use metadata attached to the consent events created from the API in the email sent to the end-user. By adding metadata to the consent event, you can include a custom parameter in the template to access the information recorded during consent.
To add a metadata parameter in the email template, construct the parameter using the following format:
And add this parameter in your email template:
Template ID: privacy-center-auth
Send an authentication link to users when they access a Preference Center without a valid consent token. The email allows users to confirm their identity and access a Preference Center for the associated email address.
The following parameters are provided to the template when sending a Magic Link authentication email:
privacy_center_url
URL of the Preference Center with a valid consent token.
Template ID: privacy-center-auth-otp-code
Send a 6-digit code to users when they access a Preference Center without a valid consent token. The email allows users to receive a code to submit for accessing a Preference Center for the associated email address.
The following parameters are provided to the template when sending a One-Time password authentication email:
Name
Description
code
6-digit code to submit in the widget.
ID: request-status-fulfilled-access-my-data
Send an email to the end-user after setting the status of an access data request to fulfilled.
download_link
Link that redirects users on a webpage to access or download their data. This should be used as a button or a link.
ID: request-status-fulfilled-delete-my-data
Send an email to the end-user after setting the status of a delete data request to fulfilled.
user_right_label
Right expressed by the end-user while submitting the privacy request. This should be used as a label or a title to recall the right the end-user has submitted.
ID: request-verify
user_right_label
Right expressed by the end-user while submitting the privacy request. This should be used as a label or a title to recall the right the end-user has submitted.
confirmation_link
Redirection link to validate user identity. This should be used in a button or link.
ID: request-status-fulfilled-opt-out
Send an email to the end-user after setting the status of an opt-out request to fulfilled.
user_right_label
Right expressed by the end-user while submitting the privacy request. This should be used as a label or a title to recall the right the end-user has submitted.
ID: request-status-refused
Send an email to the end-user after request status has been set to refused.
user_right_label
Right expressed by the end-user while submitting the privacy request. This should be used as a label or a title to recall the right the end-user has submitted.
Template ID: consents-user-created
Send a welcome message to the user with an authenticated link to the Preference Center when the user is created through their first consent event.
The following parameters are provided to the template when sending a welcome message:
privacy_center_url
URL of the Preference Center with a valid consent token.
Template ID: validation-approval-file
Approval request for confirming changes to a user consent status from an event that uses the file validation method. Approval requests are similar to double opt-in but are intended to be processed internally, while double opt-in is a confirmation from the end-user directly.
The following parameters are provided to the template when sending an approval email:
validation_approve_url
URL to redirect the user for approving consent choices. This should be used as the URL for a link or button in the email.
Template ID: validation-approval-signature
Approval request for confirming changes to a user consent status from an event that uses the signature validation method. Approval requests are similar to double opt-in but are intended to be processed internally, while double opt-in is a confirmation from the end user directly.
The following parameters are provided to the template when sending an approval email:
validation_approve_url
URL to redirect the user for approving consent choices. This should be used as the URL for a link or button in the email.
Template ID: validation-double-optin
Collect double opt-in for a consent event that uses the email validation method.
This allows users to confirm their choices before a consent event is stored.
The following parameters are provided to the template when sending a double opt-in email:
validation_approve_url
URL to redirect the user to confirm their consent choices. This should be used as the URL for a link or button in the email.
ID: request-status-wip
Send an email to the end-user after request status has been set to work_in_progress.
user_right_label
Right expressed by the end-user while submitting the privacy request. This should be used as a label or a title to recall the right the end-user has submitted.
To populate the download_link variable, you need to add download_link property under extra_message_variables while the related request.
Send an email to the end-user after a privacy request is submitted in order to validate identity. The request must be created with an .
Some emails )(such as Authentication emails or Privacy request emails) are already available by default. The other templates mentioned above need to be .