docusign.envelope-attachments.put-attachment

Updates an envelope attachment to a draft or in-process envelope. <!-- std notice DEVDOCS-114911 --> <ds-inlinemessage kind="information" markdown="1"> It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see Attachments in the concept guide. </ds-inlinemessage> <!-- end notice DEVDOCS-114911 -->

Updates an envelope attachment in a draft or in-process envelope.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
attachmentid	string	Yes	—	The unique identifier for the attachment.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
accesscontrol	string	No	—	Valid values are sender and senderAndAllRecipients.
attachmentid_2	string	No	—	The unique identifier for the attachment.
attachmenttype	string	No	—	Specifies the type of the attachment for the recipient.
data	string	No	—	A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
label	string	No	—	A label for the attachment. Potential values include: - guidedForm: Guided forms provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - eventNotifications: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the url property.
name	string	No	—	The name of the attachment.
remoteurl	string	No	—	The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the remoteUrl property to reference the chunked upload as the content in attachment and document-related requests. The remoteUrl property cannot be used for downloads.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
attachmentid	string	Yes	—	The unique identifier for the attachment.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
accesscontrol	string	No	—	Valid values are sender and senderAndAllRecipients.
attachmentid_2	string	No	—	The unique identifier for the attachment.
attachmenttype	string	No	—	Specifies the type of the attachment for the recipient.
data	string	No	—	A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
label	string	No	—	A label for the attachment. Potential values include: - guidedForm: Guided forms provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - eventNotifications: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the url property.
name	string	No	—	The name of the attachment.
remoteurl	string	No	—	The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the remoteUrl property to reference the chunked upload as the content in attachment and document-related requests. The remoteUrl property cannot be used for downloads.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelope-attachments.put-attachment",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "attachmentid": "value",
    "envelopeid": "value"
  }
}