You can program automatic reminders for a participant. This can only be done if you have set an initial invitation email for this participant. To do so, the schedule array, which first value represents the initial invitation email, must be completed with other values, expressed in hours, representing the automatic reminders. In the following request to POST /v1/transactions/{transaction_id}/participants, the participant will receive his initial invitation as soon as his action is open (0), and if he hasn’t signed within 48 hours after receiving the invitation (48), he will receive a reminder email, and another one 72 hours later after the latest reminder (72):
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d schedule=[0,48,72]
Notez qu’il doit y avoir un minimum de 24 heures entre chaque rappel automatique. Il est possible d’envoyer un rappel manuellement via l’application web.
Ajouter un message de rappel personnalisé
Vous pouvez personnaliser l’objet de l’email de rappel et ajouter un message personnalisé pour chaque participant. Pour ce faire, envoyez une requête à POST /v1/transactions/{transaction_id}/participants comme suit :
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d reminder_subject=ExempleDeSujet \
-d reminder_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
<p>Ceci est un rappel pour signer le contrat <i>Lorem Ipsum</i>.<br/>
<u>Pour rappel des éléments partagés</u>:</p>
<ol>
<li>Élément 1</li>
<li>Élément 2</li>
<li>Élément 3</li>
</ol>
<u>Merci pour</u>:
<ul> <li>Rappel 1</li>
<li>Rappel 2</li>
</ul>
<b>Veuillez signer le contrat avant la fin de la semaine</b>
</message>
La longueur de l’objet de l’invitation est limitée à 100 caractères et celle du message à 1 000 caractères.
Le contenu du message doit être dans au format texte ou dans un format XHTML valide. Nous prenons en charge les balises suivantes (sans attributs) :
- « b », « strong » : gras
- « i », « em » : italique
- « u » : style souligné
- « ul », “ol”, « li » : liste non ordonnée et ordonnée
- « p » : paragraphe
- « br » : saut de ligne
Notez que l’ajout d’un message personnalisé et la configuration de l’envoi de l’invitation doivent être effectués avant que le participant n’ait effectué son action.
Utiliser des variables
Vous pouvez personnaliser davantage vos messages d’invitation en utilisant à la fois nos variables préconfigurées et les métadonnées que vous avez précédemment définies lors de la création de votre transaction.
Le participant reçoit le message personnalisé contenant la valeur de chaque variable ou métadonnée que vous avez définie.
Vous trouverez ci-dessous la liste des variables préconfigurées :
${participant.full_name}: à définir si vous souhaitez inclure le nom complet du participant dans votre message personnalisé.${participant.email}: à définir si vous souhaitez inclure l’email du participant dans votre message personnalisé.${transaction.name}: à définir si vous souhaitez inclure le nom de la transaction dans votre message personnalisé.${transaction.expires_at}: à définir si vous souhaitez inclure la date d’expiration de la transaction dans votre message personnalisé.
Pour ajouter une métadonnée à votre message personnalisé, ajoutez ${metadata.*} au corps de votre message (vous devez remplacer le * par la clé de la métadonnée).
Exemple de requête
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d reminder_subject=Rappel automatic avec variables \
-d reminder_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
Bonjour ${participant.full_name},
<p>Nous tenons à vous rappeler que vous n'avez pas encore effectué les actions requises pour la transaction ${transaction.name}.</p>
<p>Dans le cadre de votre contrat ${metadata.Contract} pour le poste de ${metadata.Position}, vous avez jusqu'au ${transaction.expires_at} pour les effectuer.</p>
<p>Cordialement,</p>
<p>L'équipe RH<br/></p>
</message>
Exemple de réponse
{
"email" : "[email protected]",
"phone_number" : "+33612345679",
"phone_number_type" : "suggestion",
"min_signature_level" : "level1",
"reminder_subject" : "Rappel automatique avec variables",
"reminder_message" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><message>Bonjour ${participant.full_name},<p>Nous tenons à vous rappeler que vous n'avez pas encore effectué les actions requises pour la transaction ${transaction.name}.<br /></p><p>Dans le cadre de votre contrat ${metadata.Contract} pour le poste de ${metadata.Position}, vous avez jusqu'au ${transaction.expires_at} pour les effectuer.</p><p>Cordialement,</p><p>L'équipe RH</p></message>",
"schedule" : [ 0 ],
"ongoing_conversation" : false,
"has_unread_message" : false,
"state" : "open",
"access_control" : "standard",
"shared_contact" : false,
"fullname_suggestion" : "John doe",
"phone_number_suggestion" : "+33612345679",
"full_name" : "John doe",
"waiting_period" : 0,
"full_name_type" : "suggestion"
}
