Une fois qu’une transaction est « terminée », chaque participant reçoit un email automatique contenant le lien pour télécharger ses documents signés.
Cependant, vous pouvez personnaliser l’objet et le message de l’email contenant les documents signés. 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 signed_documents_subject=Téléchargez vos documents signés \
-d signed_documents_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
<p>Merci d'avoir envoyé le <i>Document</i></p><br/>
<p>Vous trouverez ci-dessous le lien pour accéder au document signé et le télécharger.</p>
</message>
La longueur de l’objet de l’email des documents signés 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
Utiliser des variables
Vous pouvez personnaliser davantage vos messages de transactions terminées 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 signed_documents_subject=Message de transaction terminée avec variables \
-d signed_documents_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
Bonjour ${participant.full_name},
<p>Vous avez effectué les actions liées à la transaction ${transaction.name} dans le cadre de votre contrat ${metadata.Contract} pour le poste de ${metadata.Position}.</p>
<p>Vous pouvez désormais télécharger votre document signé.</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",
"signed_documents_subject" : "Completed-transaction message with variables",
"signed_documents_message" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><message>Hello ${participant.full_name},\n<p>You have completed the actions related to the transaction ${transaction.name} as part of your contract ${metadata.Contract} for the position of ${metadata.Position}.</p>\n<p>You can now download your signed document.</p>\n<p>Regards,</p>\n<p>HR Team<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"
}
Désactiver l’envoi de l’email des documents signés
Par défaut, une fois qu’une transaction est « terminée », chaque participant reçoit un email contenant un lien lui permettant d’accéder à ses documents signés et de les télécharger. Vous pouvez toutefois désactiver l’envoi de cet email. Pour ce faire, envoyez une requête à POST /v1/transactions/{transaction_id}/participants et définissez l’argument send_signed_documents_mail à false.
Notez que cette fonctionnalité doit être activée sur votre espace de travail. Si vous souhaitez l’activer, vous devez contacter votre gestionnaire de compte chez Universign.
Exemple de requête
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/participants \
-d [email protected] \
-d send_signed_documents_mail=false
Exemple de réponse
{
"email" : "[email protected]",
"phone_number_type" : "suggestion",
"min_signature_level" : "level1",
"schedule" : [ ],
"send_signed_documents_mail" : false,
"ongoing_conversation" : false,
"has_unread_message" : false,
"state" : "open",
"full_name_type" : "suggestion",
"waiting_period" : 0
}
