Subscribe

The UiPath Marketplace Guide

Create Envelope

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 Intput properties.
  5. Create and enter Envelope and Envelope ID variables for the Output properties.
  6. Create and enter a ResponseStatus variable for the Output property.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

Create Envelope

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Account ID

The account id to create an envelope in.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

This is either an account number (int) or account ID (GUID).

Envelope Definition

The envelope object to create.

Attributes

Details

Type

EnvelopeDefinition

Required

Yes

Default value

Empty

Allowed values

Enter a EnvelopeDefinition or EnvelopeDefinition variable.

Notes

N/A


Misc

Private

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

Attributes

Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

Envelope Id

The ID of the Envelope created.

Attributes

Details

Type

String

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a String variable.

Notes

N/A

Envelope

The Envelope object that was created.

Attributes

Details

Type

Envelope

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Envelope variable.

Notes

N/A

ResponseStatus

The status of the request (success/failure information).

Attributes

Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

Notes

N/A


Options

Change Routing Order

Whether or not to change the routing order.

Attributes

Details

Type

Boolean

Required

No

Default value

Empty

Allowed values

Enter a Boolean or Boolean variable.

Notes

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.

Attributes

Details

Type

Boolean

Required

No

Default value

Empty

Allowed values

Enter a Boolean or Boolean variable.

Notes

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.

Updated 5 months ago


Create Envelope


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.