DocuSign: Updates an envelope attachment in a draft or in-process envelope
DocuSign esignature.esignatureAttachmentsPutAttachment: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_attachments_putattachment
Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["esignatureAttachmentsPutAttachment"]>[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.esignatureAttachmentsPutAttachment(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_attachment(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.attachmentId | string | Required within parent | |
path.envelopeId | string | Required within parent | |
body | Model | Optional | Expand 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
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Updates an envelope attachment in a draft or in-process envelope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an attachment. |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. |
data | string | Optional | 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 | Optional | A 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. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | 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. |
Deletes one or more envelope attachments from a draft envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Optional | An array of attachment objects that contain information about the attachments. |
attachments[] | Model | Each item | Expand 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 — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
label | string | Optional | |
name | string | Optional |
Referenced models: Locks a template — response body — error Details
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_attachments_putattachment. Catalog operation: esignature:Attachments_PutAttachment. 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.