Delivery mode

On this page, you will learn how to manage notifications sent to Signature Request participants.

For each Signature Request, it is possible to specify a Delivery Mode. The Delivery Mode allows you to specify who is in charge to notify the Signature Request's participant when an event occurs. You will find more information about the different events on our Webhooks sections.

For example, if you have a Signature Request with only one Signer:

  • In Delivery Mode "email", the Signer will be notified by Yousign that he has to sign a document.
  • In Delivery Mode "none", you will be in charge to notify the Signer that a document is ready to be signed.
Who handles notificationsDelivery mode EmailDelivery mode None
Signers notificationsYousignIntegrator
Approvers notificationsYousignIntegrator
Followers notificationsYousignIntegrator
Identity verification contentYousignYousign
Signer/Approver/Follower renewal linkYousignYousign

Delivery Mode Email

This is the best option if you want to delegate email management to Yousign. All notifications will be sent by Yousign to the different participants: Approvers, Signers, Followers and Senders.

Disable specific email

When using the Delivery Mode email, it is possible to personalize the notification emails sent to the participants. To do that, two complementary options can be considered:

  • associate a Custom Experience to the Signature Request and select unwanted emails
  • use an email exclusion list

Option 1: Custom Experience

With Custom Experiences, you can disable specific emails for Signers, Approvers, Followers and the Sender by simply unselecting them. Custom Experience settings will apply to all people involved in the Signature Request.

Option 2: Email exclusion list

An email exclusion list can be associated with a Signature Request's Signer in Delivery Mode email. This list should contain the names of all the emails you don't want the Signer to receive.

An exclusion list needs to be associated with a Signer using the email_notification.disabled parameter.

Here is an extract of a Signer's creation payload showing all the emails that it's possible to exclude.

"email_notification": {
	"disabled": [		
		"signer.signature_request_signature_requested.reminder_to_sign"
			// Reminder email sent to the Signers who haven't signed yet.

 		"signer.signature_request_signature_requested.first_notification"
			// Notification email sent to the Signers once the Signature Request is activated.

		"signer.signature_request_updated_by_sender.new_signer_details
			// Email sent when Signers details of a Signature Request have been updated by the sender.

		"signer.signature_request_updated.new_expiration_date"
			// Email sent when the expiration date has been updated.

		"signer.signature_request_with_multiple_signers_signed.signed_by_a_signer"
			// Email sent to all Signers of a Signature Request once of of them have signed and if the Signature Request is not completed yet.

		"signer.signature_request_done.signature_request_contains_multiple_signers"
			// Email sent to Signers of a Signature Request once the Signature Request is completed. The email is sent for Signature Requests with more than one Signer.

		"signer.signature_request_done.signature_request_contains_one_signer"
			//Email sent to the Signer of a Signature Request once the Signature Request is completed. The email is sent for Signature Requests with only one Signer.

		"signer.signature_request_canceled_by_sender.signer_who_has_already_signed"
			// Email sent to Signers who have already signed, if the Signature Request is cancelled by the Sender.

		"signer.signature_request_canceled_by_sender.signer_who_has_not_signed"
			// Email sent to Signers who haven't signed yet, if the Signature Request is cancelled by the Sender.

		"signer.signature_request_canceled_due_to_an_error.signer_who_has_already_signed"
			// Email sent to Signers who have already signed, if the Signature Request is cancelled due to a technical error.

		"signer.signature_request_canceled_due_to_an_error.signer_who_has_not_signed
			//Email sent to Signers who haven't signed yet, if the Signature Request is cancelled due to a technical error.
	]
}

Please note that if the Signer Delivery Mode changes from email to none, the parameter email_notification.disabledwill be set to null.

Advice when using the Delivery Mode email

With the Delivery Mode set to email, the signers will receive the signature links with emails sent by Yousign. However, you can still retrieve the signature links as they will be included in the response payload when you activate the Signature Request.

Delivery Mode None

This option should be used for two different reasons:

  • You don't want to send any emails to the participants. This implies that everything is automated from beginning to end in your product and, the Signers and Approvers donโ€™t need to receive emails to complete the signature process.
  • You want to send the notifications to the participants by yourself using your favourite channel (email, SMS, or any other channel).

To leverage the Delivery Mode None you will have to rely on two different concepts:

  • You will have to retrieve the signature and approvals links in the API response to the different calls that you will perform.
  • You will have to use the webhooks to react to the different events occurring if your use case needs it.

๐Ÿ“˜

The Signature Request status "Notified" doesn't have the same meaning with the Delivery Mode None

In Delivery Mode Email, the Signer's status "notified" implies that this Signer has been notified by Yousign.
In Delivery Mode None, the Signer's status "notified" implies that this Signer is ready to be notified. It's now up to you to do so.

How to retrieve the Approver link?

Retrieving the Approvers links is very straightforward, they will be included in the response payload when you activate the Signature Request.

How to retrieve the Signature link?

Use caseHow to retrieve the Signature link
One or many non-ordered Signers - No ApproversAll the Signature links are included in the activation response payload.
One or many ordered Signers - No Approvers1 - The Signature link of the first Signer will be included in the activation response payload.
2 - When the first Signer will sign the document, the next Signer's status will change to "notified".
3 - The next Signer id can be retrieved in the Signer.notified Webhook and used to get the Signature link using this endpoint.
4 - Repeat step #3 until no Signer is left to sign.
One or many non-ordered Signers - One or many Approvers1 - When the Signature will be approved, the Signature_request.approved Webhook will be sent and all Signers will have the "notified" status.
2 - Use this endpoint to get the Signature link for all Signers .
One or many ordered Signers - One or many Approvers1 - When the Signature will be approved, the Signature_request.approved Webhook will be sent and the first Signer will have the "notified" status.
2 - Use this endpoint to get the first Signature link.
3 - When the first Signer will sign the document, the next Signer's status will change to "notified".
4 - The next Signer id can be retrieved in the Signer.notified Webhook and used to get the Signature link using this endpoint.
5 - Repeat step #4 until no Signer is left to sign.

On the next page, you will find an example with implementation details showing how the Delivery Mode works with no Approvers and Ordered Signers.