Skip to main content

List Recipients

UiPath.DocuSign.Activities.EnvelopeList.ListRecipients

The List Recipients activity uses the DocuSign eSignature API to get a set of recipients for an envelope.

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 List Recipients 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. This field supports only Strings or String variables. This is either an account number (int) or account ID (GUID).
  • Envelope Id - The envelope id. This field supports only Strings or String variables.
  • Include Anchor Tab Locations - Whether or not to include anchor tab locations. Enter a Boolean or Boolean variable. When true and (Include Tabs) value is set to true, all tabs with anchor tab properties are included in the response.
  • Include Extended - Whether or not to include extended properties. Enter a Boolean or Boolean variable. When true, the extended properties are included in the response.
  • Include Metadata - Whether or not to include anchor tab locations. Enter a Boolean or Boolean variable. When true, the meta data associated with the recipients is included in the response (envelopes only, not templates)
  • Include Tabs - Whether or not to include tab information. Enter a Boolean or Boolean variable.
  • Envelope Recipients - The recipients of the envelope. This field supports only EnvelopeRecipients variables.

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.