DocuSign: Generate and convert document
DocuSign esignature.esignatureDocsUncategorizedGenAndSendPostGenAndConvertEnvelopes: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_docs_uncategorized_genandsend_postgenandconvertenvelopes
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/generate_and_convert. 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"]["esignatureDocsUncategorizedGenAndSendPostGenAndConvertEnvelopes"]>[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.esignatureDocsUncategorizedGenAndSendPostGenAndConvertEnvelopes(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_gen_and_convert_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 | |
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 |
|---|---|---|---|
$ | string | Root | Format: binary |
Schemas
Section titled “Schemas”161 more schemas are linked from the tables above, on the schema pages.
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 email Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. *Example*: if your account has BCC for Email Archive set up for the email address 'archive@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address. |
bccEmailAddresses | array | Optional | An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. While this property is an array, note that it takes only a single email address. **Note:** Only users with the `canManageAccount` setting set to **true** can use this option. Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. **Example:** if your account has BCC for Email Archive set up for the email address [archive@example.com](mailto:archive@example.com) and you send an envelope using the BCC Email Override to send a BCC email to [salesarchive@example.com](mailto:salesarchive@example.com), then a copy of the envelope is only sent to the [salesarchive@example.com](mailto:salesarchive@example.com) email address. |
bccEmailAddresses[] | Model | Each item | Expand Add envelope archive metadata — request body — body email Settings bcc Email Addresses item |
replyEmailAddressOverride | string | Optional | The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters. |
replyEmailNameOverride | string | Optional | The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters. |
Referenced models: Add envelope archive metadata — request body — body email Settings bcc Email Addresses 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. |
Add envelope archive metadata — request body — body notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the notification settings for the envelope. |
expirations | Model | Optional | Expand Add envelope archive metadata — request body — body notification expirations |
reminders | Model | Optional | Expand Add envelope archive metadata — request body — body notification reminders |
useAccountDefaults | string | Optional | When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** |
Referenced models: Add envelope archive metadata — request body — body notification expirations, Add envelope archive metadata — request body — body notification reminders
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_docs_uncategorized_genandsend_postgenandconvertenvelopes. Catalog operation: esignature_docs:uncategorized_GenAndSend_PostGenAndConvertEnvelopes. 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.