Create Envelope Recipients

UiPath.DocuSign.Activities.Envelope.CreateRecipients

The Create Envelope Recipients activity uses the DocuSign eSignature API to add one or more recipients to an envelope.

For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional resend_envelope query string is set to true (per DocuSigns API notes).

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the DocuSign Scope activity to your project.
3. Add the Create Recipient activity inside the DocuSign Scope activity.
4. Enter values for the properties located inside the body of the activity.
5. Create and enter a ResponseStatus variable for the Output property.

In the Body of the Activity

• Account Id - The account id to create an envelope in. This field supports only Strings or String variables. This is either an account number (int) or account ID (GUID).
• Envelope Id - The envelope's ID (as a GUID). This field supports only String variables.
• Envelope Recipients -The envelope recipients to add. Enter an EnvelopeRecipients or EnvelopeRecipients variable.
• Recipient Data (Multiple recipients) - A DataTable of recipient data. Enter a DataTable or DataTable variable. DataTable columns must include at least a recipient type and name.
• Resend Envelope - Resend the envelope to the recipients specified. Enter a boolean variable.

  • When set to true, resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification.

    Note: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables.