Create Envelope

UiPath.DocuSign.Activities.Envelope.CreateEnvelope

The Create Envelope activity uses the DocuSign eSignature API to create an envelope Envelope that you can choose to update at a later time, such as adding recipients, documents or updating other properties, before sending.

This is desirable when you do not have all of the information in advance to create and send an envelope, however want to create the initial envelope and update it at a later time.

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 Envelope 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 Definition - The envelope object to create. Enter a EnvelopeDefinition or EnvelopeDefinition variable.
• Change Routing Order - Whether or not to change the routing order. Enter a Boolean or Boolean variable. When true, you can define the routing order of recipients while sending documents for signature.
• Merge Roles On Draft - Whether or not to merge roles. Enter a Boolean or Boolean variable. When set to true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates.
• Envelope Id - The ID of the Envelope created. Enter a String variable.
• Envelope Summary - This object describes an envelope. Enter an EnvelopeSummary variable.

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.