DocuSign: Add envelope archive metadata
DocuSign esignature.esignatureDocsUncategorizedGenAndSendPostLinkMetadataEnvelopes: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_docs_uncategorized_genandsend_postlinkmetadataenvelopes
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/archive_metadata. 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"]["esignatureDocsUncategorizedGenAndSendPostLinkMetadataEnvelopes"]>[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.esignatureDocsUncategorizedGenAndSendPostLinkMetadataEnvelopes(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_docs_uncategorized_gen_and_send_post_link_metadata_envelopes(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.envelopeId | string | Required within parent | |
body | Model | Optional | Expand Add envelope archive metadata — request body — body |
Referenced models: Add envelope archive metadata — 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 Add envelope archive metadata — response body |
Referenced models: Add envelope archive metadata — response body
Schemas
Section titled “Schemas”164 more schemas are linked from the tables above, on the schema pages.
Add envelope archive metadata — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes an envelope. |
bulkEnvelopeStatus | Model | Optional | Expand Add envelope archive metadata — response body — bulk Envelope Status |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
recipientSigningUri | string | Optional | |
recipientSigningUriError | string | Optional | |
status | string | Optional | Indicates the envelope status. Valid values are: - `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. - `created`: The envelope is created as a draft. It can be modified and sent later. - `declined`: The envelope has been declined by the recipients. - `delivered`: The envelope has been delivered to the recipients. - `sent`: The envelope will be sent to the recipients after the envelope is created. - `signed`: The envelope has been signed by the recipients. - `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
statusDateTime | string | Optional | The DateTime that the envelope changed status (i.e. was created or sent.) |
uri | string | Optional | A URI containing the user ID. |
Referenced models: Add envelope archive metadata — response body — bulk Envelope Status, Add envelope archive metadata — response body — error Details
Add envelope archive metadata — response body — bulk Envelope Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batchId | string | Optional | Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. |
batchSize | string | Optional | The number of items returned in this response. |
bulkEnvelopes | array | Optional | A list of bulk envelope objects. |
bulkEnvelopes[] | Model | Each item | Expand Add envelope archive metadata — response body — bulk Envelope Status bulk Envelopes item |
bulkEnvelopesBatchUri | string | Optional | URI at which you can retrieve the batch envelopes. |
endPosition | string | Optional | The last index position in the result set. |
failed | string | Optional | The number of entries with a status of failed. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
queued | string | Optional | The number of entries with a status of queued. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
sent | string | Optional | The number of entries with a status of sent. |
startPosition | string | Optional | The starting index position of the current result set. |
submittedDate | string | Optional | The date on which the bulk envelope was created. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Add envelope archive metadata — response body — bulk Envelope Status bulk Envelopes item
Add envelope archive metadata — 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. |
Add envelope archive metadata — request body — body attachments item
| 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. |
Add envelope archive metadata — request body — body composite Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/ |
compositeTemplateId | string | Optional | The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. |
document | Model | Optional | Expand Add envelope archive metadata — request body — body documents item |
inlineTemplates | array | Optional | Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. |
inlineTemplates[] | Model | Each item | Expand Add envelope archive metadata — request body — body composite Templates item inline Templates item |
pdfMetaDataTemplateSequence | string | Optional | A number representing the sequence in which to apply the template that contains the PDF metadata. Example: `4` |
serverTemplates | array | Optional | Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. |
serverTemplates[] | Model | Each item | Expand Add envelope archive metadata — request body — body composite Templates item server Templates item |
Referenced models: Add envelope archive metadata — request body — body documents item, Add envelope archive metadata — request body — body composite Templates item inline Templates item, Add envelope archive metadata — request body — body composite Templates item server Templates item
Add envelope archive metadata — request body — body custom Fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about custom fields. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body custom Fields list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body custom Fields text Custom Fields item |
Referenced models: Add envelope archive metadata — request body — body custom Fields list Custom Fields item, Add envelope archive metadata — request body — body custom Fields text Custom Fields item
Add envelope archive metadata — request body — body envelope Custom Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item |
Referenced models: Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item
Add envelope archive metadata — request body — body envelope Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowAdvancedCorrect | string | Optional | Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. |
allowCorrect | string | Optional | Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. |
enableSignWithNotary | string | Optional | Specifies if Docusign eNotary service is enabled for the envelope. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_docs_uncategorized_genandsend_postlinkmetadataenvelopes. Catalog operation: esignature_docs:uncategorized_GenAndSend_PostLinkMetadataEnvelopes. 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.