Skip to main content

Get Envelope

UiPath.DocuSign.Activities.Envelope.GetEnvelope

The Get Envelope activity uses the DocuSign eSignature API to get an envelope EnvelopeDefinition that you can choose to update 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 Get 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.
  • Envelope Id - The ID of the envelope. This field supports only Strings or String variables.
  • Advanced Update - Whether envelope information can be added or modified. Enter a Boolean or Boolean variable. When true, envelope information can be added or modified.
  • Include Options - Specifies additional information about the envelope to return. This field supports only Strings or String variables. Enter a comma-separated list, such as tabs, recipients.
  • Envelope - The EnvelopeDefinition object retrieved. Enter a EnvelopeDefinition 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.