Update Envelope
AutomatR.DocuSign.Activities.UpdateEnvelope
The "Update Envelope" activity in AutomatR is part of the DocuSign Envelope package, allowing users to retrieve the status of an envelope. This activity enhances workflow automation in DocuSign by providing the capability to update various attributes of an existing envelope, such as email subject, advanced options, and resend settings.
Properties
| Name | Description |
|---|---|
| Input | |
| Email Subject | Enter the email subject for the envelope. String variables containing the email subject. |
| Envelope ID | Enter the ID of the envelope to be updated. This field supports only strings or string variables. |
| Advanced Update | When set to true, allows the caller to update recipients, tabs, custom fields, notification, email settings, and other envelope attributes. This field supports only strings or string variables. |
| Resend Envelope | Specifies whether or not to resend the envelope after the update. This field supports only strings or string variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Update Envelope" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Envelope Update Summary | Returns the update summary object, providing information about the changes made during the envelope update. Variables of data type 'EnvelopeUpdateSummary' to store the update summary. |
How to use:
- Drag and drop the "Update Envelope" activity onto the workflow.
- Configure the properties by specifying the envelope ID and providing details for the email subject.
- Optionally, configure advanced update options and choose whether to resend the envelope.
- Execute the workflow to update the specified envelope in DocuSign.
Important Notes:
- Ensure that the "Update Envelope" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Update Envelope" activity is used to update the email subject of an existing DocuSign envelope:
Update Envelope:
Delay: 5
Envelope ID: "Envelope123"
Email Subject: "Updated Subject"
Advanced Update: "true"
Resend Envelope: "false"
Envelope Update Summary: envelopeUpdateSummary
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then updates the email subject of the envelope with ID "Envelope123" to "Updated Subject." The advanced update option is set to true, indicating that advanced attributes can be modified. The envelope is not resent after the update. The update summary is stored in the variable "envelopeUpdateSummary" for further processing in the workflow.