Configurer l’envoi de l’invitation
Vous pouvez nous indiquer quand nous devons envoyer l’email d’invitation au participant, identifié par son email dans la requête. Vous pouvez demander que l’invitation soit envoyée dès que c’est au tour du participant de signer, ou vous pouvez demander que l’envoi soit différé. L’envoi de l’email d’invitation est exprimé en heures après que l’action du participant soit open (ouverte). Par exemple, si vous souhaitez que l’invitation soit envoyée dès que l’action est open, passez 0 dans l’argument schedule. Si vous souhaitez qu’elle soit envoyée 2 heures après que l’action soit open, passez 2. Pour ce faire, envoyez une requête à POST /v1/transactions/{transaction_id}/participants et définissez l’email du participant ainsi que l’argument schedule.
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d schedule=[0]
Envoyer une invitation différée
Vous pouvez envoyer une invitation différée afin que le participant reçoive une invitation quelques heures ou quelques jours après que son action ait été open. Pour ce faire, envoyez une requête à POST /v1/transactions/{transaction_id}/participants et transmettez l’email du participant ainsi que l’argument do_not_invite_before.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/participants \
-d [email protected] \
-d do_not_invite_before=2024-03-30T23:00:00Z \
Ajouter un message d’invitation personnalisé
Vous pouvez personnaliser l’objet de l’email d’invitation 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_aA5g6yzYVYW8/participants \
-d [email protected] \
-d fullname_prerequisite=john doe \
-d invitation_subject=Demande de signature \
-d invitation_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
<p>Comme discuté précédemment, voici le contrat <i>Lorem Ipsum</i> à signer.<br/>
<u>Voici les éléments mentionnés en guise de rappel</u>:</p>
<ol>
<li>Element 1</li>
<li>Element 2</li>
<li>Element 3</li>
</ol>
<u>Merci d'avance</u>
<b>Merci de bien vouloir signer le document 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 invitation_subject=Message with variables \
-d invitation_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
Hello ${participant.full_name},
<p>Vous êtes invité à participer à la transaction ${transaction.name} en signant le contrat ${metadata.Contract} pour le poste de ${metadata.Position}.</p>
<p>Notez que vous devez effectuer les actions demandées dans cette transaction ${transaction.name} avant le ${transaction.expires_at}.</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",
"invitation_subject" : "Message with variables",
"invitation_message" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><message>Hello \n${participant.full_name},<p>Vous êtes invité à participer à la transaction ${transaction.name} en signant le contrat ${metadata.Contract} pour le poste de ${metadata.Position}.</p><p>Notez que vous devez effectuer les actions demandées dans cette transaction ${transaction.name} avant le ${transaction.expires_at}.</p><p>Cordialement,</p><p>L'équipe RH<br/></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"
}
