Emails

The Privacy Request Management Platform allows you to communicate with your end-users while you are addressing their privacy requests. 
A set of default emails have been created in order to help you use the product right away. Nevertheless, you can configure these emails in order to match your branding assets. Basically, you are able to add your own HTML Template and define the email subject. You can use as well the variables made available to integrate dynamic data or links in your emails. 
Create a new template 
To create a new template, you need to send a POST request on /marketplace/emails endpoint and specify the provider (type_id), the type of email (email_type) as well as the subject and the HTML of your email template.
By creating a new template, you will replace the one provided by default. 
POST https://api.didomi.io/marketplace/emails
​
{
    "type_id": "didomi",
    /**
    * Email types available are detailled below.
    * For instance, to verify user identity, 
    * you will be using `request-verify` email
    */
    "email_type": "Email ID",
    "properties": {
        "html": "Your HTML",
        "subject": "Your subject"
    }
}
💡 Note that we are only referring to a didomi provider in this section. You can also use your own provider. The workflow will be noticeably the same with your own provider, nevertheless further configuration will be required. To fetch provider configuration schemas, send a GET request on /marketplace/emails/properties-schema.
GET https://api.didomi.io/marketplace/emails/properties-schema
Configure recipient email address (reply to)
To configure the recipients of an email, you need to configure the reply_to property in properties options. You can add one or several recipient addresses in reply_to property. 
reply_to property can be configured for both default template and your own templates. 
PATCH https://api.didomi.io/marketplace/emails/{id}
​
{
    "type_id": "didomi",
    "email_type": "Email ID",
    "properties": {
        "reply_to": ["[email protected]", "[email protected]"]
    }
} 
Be careful when you are editing the properties property. This is a JSONB and by design, you need to fill in every property already added every time you edit this object. If you have added your own HTML and now want to set a reply_to, you need to provide both html and reply_to in order to not erase your previous changes. 
Emails available by default
In the Privacy Request Management Platform, emails are sent on request creation or status update. Please find below the list of emails available by default with their dynamic parameters. 
Identity verification
ID: request-verify
Send an email to the end-user after he submitted a privacy request to validate his identity. The request has to be created with an approval workflow.
Parameters
Name
Description
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. 
Work in progress notification
ID: request-status-wip
Send an email to the end-user after request status has been set to work_in_progress. 
Type
Description
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. 
Refusal notification
ID: request-status-refused
Send an email to the end-user after request status has been set to refused. 
Type
Description
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. 
Access Data Request fulfillment notification
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. 
To populate the download_link variable, you need to add download_link property under extra_message_variables while updating the related request.
Type
Description
download_link
Link either to redirect the user on a webpage so he can access his data or download its data. This should be used in a button or link. 
Delete data request fulfillment notification
ID: request-status-fulfilled-delete-my-data
Send an email to the end-user after setting the status of an delete data request to fulfilled. 
Type
Description
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. 
​
Opt out request fulfillment notification
ID: request-status-fulfilled-opt-out
Send an email to the end-user after setting the status of an opt-out request to fulfilled. 
Type
Description
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. 

Name	Description
`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.

Type	Description
`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.

Type	Description
`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.

Type	Description
`download_link`	Link either to redirect the user on a webpage so he can access his data or download its data. This should be used in a button or link.

Type	Description
`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.

Type	Description
`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.

Last modified 1mo ago