Skip to content

DocuSign: Adds one or more envelope attachments to a draft or in-process envelope

DocuSign esignature.esignatureAttachmentsPutAttachments: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_attachments_putattachments

Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureAttachmentsPutAttachments"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureAttachmentsPutAttachments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_attachments_put_attachments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.envelopeIdstringRequired within parent
bodyModelOptionalExpand Deletes one or more envelope attachments from a draft envelope — request body — body

Referenced models: Deletes one or more envelope attachments from a draft envelope — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Deletes one or more envelope attachments from a draft envelope — response body

Referenced models: Deletes one or more envelope attachments from a draft envelope — response body

Deletes one or more envelope attachments from a draft envelope — response body
FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayOptionalAn array of attachment objects that contain information about the attachments.
attachments[]ModelEach itemExpand Deletes one or more envelope attachments from a draft envelope — response body — attachments item

Referenced models: Deletes one or more envelope attachments from a draft envelope — response body — attachments item

Deletes one or more envelope attachments from a draft envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayOptionalAn object that contains information about the attachment.
attachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body

Referenced models: Updates an envelope attachment in a draft or in-process envelope — request body — body

Deletes one or more envelope attachments from a draft envelope — response body — attachments item
FieldTypePresenceDescription and constraints
$objectRoot
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient. Possible values are:

- `.htm`
- `.xml`
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
labelstringOptional
namestringOptional

Referenced models: Locks a template — response body — error Details

Updates an envelope attachment in a draft or in-process envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA 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.
labelstringOptionalA label for the attachment. Potential values include:

- `guidedForm`: [Guided forms](https://www.docusign.com/products/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.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe 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.
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_attachments_putattachments. Catalog operation: esignature:Attachments_PutAttachments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.