Set invitation sending
You can tell us when we should send the invitation email to the participant, identified as email in the request. You can request the invitation to be sent as soon as it is the participant’s turn to sign, or you can request the sending to be delayed. The sending of the invitation email is expressed in hours after the participant’s action is open. For example, if you want the invitation to be sent as soon as the action is open, pass 0 in the schedule argument . If you want it to be sent 2 hours after the action is open, pass 2. To do so, send a request to POST /v1/transactions/{transaction_id}/participants and set the participant email as well as the schedule argument.
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d email=john@company.com \
-d schedule=[0]
Send deferred invitation
You may need to send a deferred invitation so that the participant receives an invitation a few hours or days after his action is opened. To do so, send a request to POST /v1/transactions/{transaction_id}/participants and set the participant email as well as the do_not_invite_before argument.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/participants \
-d email=john.doe@company.com \
-d do_not_invite_before=2024-03-30T23:00:00Z \
Add a custom invitation message
You can customize the subject of the invitation email and add a custom message for each participant. To do so, send a request to POST /v1/transactions/{transaction_id}/participants as follows:
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/participants \
-d email=john.doe@company.com \
-d fullname_prerequisite=john doe \
-d invitation_subject=SampleSubject \
-d invitation_message=<?xml version="1.0" encoding="UTF-8"?>
<message>
<p>As discussed with you earlier, here is the contract <i>Lorem Ipsum</i> to sign.</br>
<u>As a reminder of the shared elements</u>:</p>
<ol>
<li>Element 1</li>
<li>Element 2</li>
<li>Element 3</li>
</ol>
<u>Thank you for</u>
<b>Please sign the contract before the end of week</b>
</message>
The invitation subject value is limited to 100 characters and the invitation message to 1000 characters.
The email message should be in text format or in a valid XHTML format. We support the following tags (without attributes):
- “b”, “strong”: bold style
- “i”, “em” : italic style
- “u” : underlined style
- “ul”, “ol”, “li” : unordered and ordered list
- “p” : paragraph
- “br” : line break
Note that adding a custom message and setting the invitation sending must be done before the participant has performed his/her action.
