# DocuSign on boxd

> DocuSign provides eSignature and digital agreement solutions, enabling businesses to send, sign, track, and manage documents electronically.

- Page: https://boxd.sh/integrations/docusign/
- CLI: `run docusign` (338 commands, 10 marked common)
- SDK: `import { docusign } from "@boxd/run"`; every parameter and response type is at `@boxd/run/docusign`
- Triggers: none
- Connect: `run auth docusign` (Sign in with DocuSign), or https://app.boxd.sh/integrations/detail/docusign
- All integrations: https://boxd.sh/integrations/ (Markdown: https://boxd.sh/integrations/index.md)

## From the shell

```sh
run auth docusign      # once: prints a link to connect your account
run docusign           # list its commands
run docusign list-oauth-userinfo
```

Parameters are flags (`--flag value`); object and array parameters take a JSON string. Output is YAML, or JSON with `--json`. Calls use your own connection; `--scope <name>` uses a connection shared with your team.

## From a script

```ts
import { every, docusign } from "@boxd/run";

every("1 hour", async () => {
  const result = await docusign.listOauthUserinfo();
  console.log(result);
});
```

Run it with `run docusign.run.ts`. DocuSign has no triggers; `every()` polls on a schedule, keeps the script running as a job, and wakes the machine when it is due.

## Commands

Required flags are listed; `run docusign <command> --help` lists the optional ones. "common" marks what `run docusign` shows without `--all`.

| Command | SDK method | Required flags | Optional | Description |
|---|---|---|---|---|
| `add-contacts-to-contacts-list` ·common | `docusign.addContactsToContactsList()` | — | 2 | Adds multiple contacts to a user's contacts list in DocuSign |
| `add-email-overrides-to-envelope` | `docusign.addEmailOverridesToEnvelope()` | `--envelopeId` | 4 | Adds or modifies email override settings for a specific DocuSign envelope, allowing customization of the reply-to email address and name, as well as BCC email addresses for archiving purposes |
| `add-envelope-attachments` | `docusign.addEnvelopeAttachments()` | `--envelopeId` | 2 | Adds one or more envelope attachments to a draft or in-process envelope in DocuSign |
| `add-existing-brand-to-group` | `docusign.addExistingBrandToGroup()` | `--brands` `--groupId` | 1 | This endpoint adds one or more existing brands to a specified group in DocuSign |
| `add-file-to-workspace` | `docusign.addFileToWorkspace()` | `--file` `--folderId` `--workspaceId` | 1 | This endpoint adds a file to a specific folder within a DocuSign workspace |
| `add-members-to-signing-group` | `docusign.addMembersToSigningGroup()` | `--signingGroupId` | 2 | This endpoint adds one or more new members to a specified signing group within a DocuSign account |
| `add-new-users-to-specified-account` | `docusign.addNewUsersToSpecifiedAccount()` | — | 2 | This endpoint adds new users to a specified DocuSign account, allowing bulk creation of up to 500 users in a single call |
| `add-or-update-account-stamps` | `docusign.addOrUpdateAccountStamps()` | — | 3 | Add or update account-level stamps (Japanese Hanko-style stamps) in DocuSign |
| `add-or-update-user-custom-settings` | `docusign.addOrUpdateUserCustomSettings()` | `--userId` | 2 | Adds or updates custom user settings for a specified DocuSign user |
| `add-or-update-user-signature` | `docusign.addOrUpdateUserSignature()` | `--userId` | 2 | This endpoint allows you to add or update a user's signature in DocuSign |
| `add-part-to-chunked-upload` | `docusign.addPartToChunkedUpload()` | `--chunkedUploadId` `--chunkedUploadPartSeq` | 2 | Adds a chunk or part to an existing chunked upload in DocuSign |
| `add-step-to-envelope-workflow` | `docusign.addStepToEnvelopeWorkflow()` | `--envelopeId` | 12 | This endpoint adds a new step to an existing envelope's workflow in DocuSign |
| `add-templates-to-document-in-envelope` | `docusign.addTemplatesToDocumentInEnvelope()` | `--documentId` `--envelopeId` | 3 | This endpoint adds pre-configured templates to a specific document within an existing envelope in DocuSign |
| `add-templates-to-envelope` | `docusign.addTemplatesToEnvelope()` | `--envelopeId` | 3 | This endpoint adds templates to an existing DocuSign envelope |
| `add-user-signature-and-initials-images` | `docusign.addUserSignatureAndInitialsImages()` | `--accountId` `--userId` | 1 | Add or update a user's signature and initials images in DocuSign |
| `add-users-to-existing-group` | `docusign.addUsersToExistingGroup()` | `--groupId` | 2 | Adds one or more existing DocuSign users to an existing group within a specified account |
| `apply-action-to-bulk-send-envelopes` | `docusign.applyActionToBulkSendEnvelopes()` | `--bulkAction` `--bulkSendBatchId` | 10 | This endpoint allows users to apply specific actions (resend, correct, or void) to all envelopes within a specified DocuSign bulk send batch |
| `change-users-in-account` | `docusign.changeUsersInAccount()` | — | 9 | This endpoint allows you to update information for one or more users within a DocuSign account |
| `close-users-in-account` | `docusign.closeUsersInAccount()` | — | 3 | Closes one or more users in a DocuSign account, preventing them from accessing account features without permanently deleting them |
| `commit-chunked-upload-for-envelopes` | `docusign.commitChunkedUploadForEnvelopes()` | `--chunkedUploadId` | 2 | This endpoint commits a chunked upload in DocuSign, finalizing the upload process and preparing the uploaded content for use in other API calls |
| `configure-cloud-storage-redirect-url` | `docusign.configureCloudStorageRedirectUrl()` | `--userId` | 2 | Configures the OAuth redirect URL for one or more cloud storage providers (Box, Dropbox, GoogleDrive, SkyDrive/OneDrive, Salesforce) for a specific user in DocuSign |
| `create-account-custom-field` | `docusign.createAccountCustomField()` | — | 8 | Creates a new custom field at the account level in DocuSign, making it available for all new envelopes associated with the account |
| `create-bcc-email-archive-configuration` | `docusign.createBccEmailArchiveConfiguration()` | — | 2 | Creates a BCC email archive configuration for a DocuSign account, enabling automatic archiving of DocuSign-generated emails |
| `create-brand-profiles-for-account` | `docusign.createBrandProfilesForAccount()` | — | 24 | Creates a new brand profile for a DocuSign account to customize the signing and sending experience with your organization's visual identity and branding elements |
| `create-bulk-send-request` | `docusign.createBulkSendRequest()` | `--bulkSendListId` `--envelopeOrTemplateId` | 2 | Initiates a bulk send process in DocuSign to send a single template or envelope to multiple recipients in a single batch operation |
| `create-bulk-send-test-request` | `docusign.createBulkSendTestRequest()` | `--bulkSendListId` | 3 | This endpoint creates a Bulk Send Test Request to validate the compatibility between a bulk send list and an envelope or template for DocuSign's bulk sending feature |
| `create-collaborative-workspace` | `docusign.createCollaborativeWorkspace()` | — | 71 | Creates a new collaborative workspace in DocuSign for document management and team collaboration |
| `create-connect-configuration-for-account` | `docusign.createConnectConfigurationForAccount()` | — | 46 | This endpoint creates a custom Connect configuration for a specified DocuSign account, enabling webhook notifications for envelope and recipient events |
| `create-custom-document-fields-in-envelope` | `docusign.createCustomDocumentFieldsInEnvelope()` | `--documentId` `--envelopeId` | 2 | Creates custom document fields in an existing envelope document within DocuSign |
| `create-custom-fields-for-envelope` | `docusign.createCustomFieldsForEnvelope()` | `--envelopeId` | 3 | This endpoint allows you to create or update custom fields for a specific DocuSign envelope |
| `create-custom-fields-in-template-document` | `docusign.createCustomFieldsInTemplateDocument()` | `--documentId` `--templateId` | 2 | Creates custom document fields in an existing template document within DocuSign |
| `create-custom-tab-with-properties` | `docusign.createCustomTabWithProperties()` | — | 86 | Creates a custom tab with pre-defined properties for use in DocuSign envelopes |
| `create-document-responsive-html-preview` | `docusign.createDocumentResponsiveHtmlPreview()` | `--documentId` `--envelopeId` | 11 | Creates a responsive HTML preview for a specific document in an envelope |
| `create-envelope-from-template` ·common | `docusign.createEnvelopeFromTemplate()` | `--account-id` `--email-subject` `--template-id` `--template-roles` | 1 | Creates a signing envelope from a pre-existing DocuSign template |
| `create-groups-for-account` | `docusign.createGroupsForAccount()` | — | 8 | Creates one or more groups for a specified DocuSign account |
| `create-idproof-resource-token-for-recipient` | `docusign.createIdproofResourceTokenForRecipient()` | `--envelopeId` `--recipientId` | 2 | Generates a 2-minute resource token to access recipient identity verification data via DocuSign's ID Evidence API |
| `create-new-account-permission-profile` | `docusign.createNewAccountPermissionProfile()` | — | 322 | This endpoint creates a new permission profile for a DocuSign account, defining specific sets of permissions for user groups |
| `create-notary-jurisdiction-object` | `docusign.createNotaryJurisdictionObject()` | — | 8 | Registers a notary jurisdiction for the current DocuSign user, enabling electronic notarizations for a specific U.S. state |
| `create-or-update-user-authorizations` | `docusign.createOrUpdateUserAuthorizations()` | `--userId` | 2 | Creates or updates user authorizations in DocuSign, allowing an agent user to perform actions on behalf of a principal user |
| `create-preview-of-responsive-html` | `docusign.createPreviewOfResponsiveHtml()` | `--documentId` `--templateId` | 11 | Creates a preview of the responsive HTML version of a specific template document in DocuSign |
| `create-preview-of-responsive-html-in-envelope` | `docusign.createPreviewOfResponsiveHtmlInEnvelope()` | `--envelopeId` | 12 | Creates a preview of the responsive HTML versions of all documents in an envelope, allowing users to review how PDF documents will appear as responsive HTML across different device types before… |
| `create-recipient-manual-review-link` | `docusign.createRecipientManualReviewLink()` | `--envelopeId` `--recipientId` | 1 | Creates a URL for manually reviewing a recipient's identity in DocuSign |
| `create-recipient-preview-for-envelope` | `docusign.createRecipientPreviewForEnvelope()` | `--envelopeId` `--returnUrl` | 20 | Creates a URL for previewing the recipient's view of a draft envelope or template |
| `create-recipient-view-url` | `docusign.createRecipientViewUrl()` | `--envelopeId` | 28 | Creates a URL for embedding the DocuSign recipient view UI within an application, allowing users to sign documents directly in the app |
| `create-sender-view-url-for-envelope` | `docusign.createSenderViewUrlForEnvelope()` | `--envelopeId` | 30 | Creates a URL for the sender view of a DocuSign envelope, enabling the embedding of DocuSign UI within an external application |
| `create-signing-group` | `docusign.createSigningGroup()` | — | 2 | Creates one or more signing groups in a DocuSign account |
| `create-template-document-custom-fields` | `docusign.createTemplateDocumentCustomFields()` | `--templateId` | 3 | Creates custom fields on a DocuSign template to capture additional metadata |
| `create-template-recipient-preview-url` | `docusign.createTemplateRecipientPreviewUrl()` | `--templateId` | 21 | Generate a preview URL showing how a template will appear to recipients |
| `create-template-responsive-html-preview` | `docusign.createTemplateResponsiveHtmlPreview()` | `--templateId` | 12 | Creates a preview of the responsive HTML versions of all documents associated with a DocuSign template |
| `create-template-workflow-step` | `docusign.createTemplateWorkflowStep()` | `--templateId` | 12 | Adds a new workflow step to an existing DocuSign template |
| `create-urlfor-template-edit-view` | `docusign.createUrlforTemplateEditView()` | `--templateId` | 3 | Creates a URL for embedding the DocuSign Template Edit view within an application |
| `create-user-authorization-for-agent-user` | `docusign.createUserAuthorizationForAgentUser()` | `--agentUser--accountId` `--agentUser--userId` `--permission` `--userId` | 5 | Creates a user authorization in DocuSign, enabling an agent user to perform specific actions on behalf of a principal user within the same account |
| `delete-account-brand` | `docusign.deleteAccountBrand()` | `--brandId` | 1 | This endpoint deletes a specific brand from a DocuSign account |
| `delete-account-custom-field` | `docusign.deleteAccountCustomField()` | `--customFieldId` | 2 | Deletes an existing account custom field from a DocuSign account |
| `delete-account-permission-profile` | `docusign.deleteAccountPermissionProfile()` | `--permissionProfileId` | 2 | This endpoint deletes a specific permission profile from a DocuSign account |
| `delete-account-stamp` | `docusign.deleteAccountStamp()` | `--signatureId` | 1 | Deletes a specific account stamp (signature) from a DocuSign account |
| `delete-bcc-email-archive-configuration` | `docusign.deleteBccEmailArchiveConfiguration()` | `--bccEmailArchiveId` | 1 | This endpoint deletes a BCC (Blind Carbon Copy) email archive configuration from a specified DocuSign account |
| `delete-brand-from-group` | `docusign.deleteBrandFromGroup()` | `--groupId` | 2 | This endpoint allows users to delete one or more brands from a specified group within a DocuSign account |
| `delete-brand-logo-by-type` | `docusign.deleteBrandLogoByType()` | `--brandId` `--logoType` | 1 | This endpoint deletes a specific logo from an account brand in DocuSign |
| `delete-brand-profiles` | `docusign.deleteBrandProfiles()` | `--brands` | 1 | This endpoint allows you to delete one or more brand profiles from a DocuSign account |
| `delete-chunked-upload` | `docusign.deleteChunkedUpload()` | `--chunkedUploadId` | 1 | Deletes a chunked upload that has been committed but not yet consumed in the DocuSign system |
| `delete-connect-configuration` | `docusign.deleteConnectConfiguration()` | `--accountId` `--connectId` | 0 | Deletes a specified DocuSign Connect configuration from the given account |
| `delete-connect-failure-log-entry` | `docusign.deleteConnectFailureLogEntry()` | `--failureId` | 1 | Deletes one or all Connect failure log entries for a specified DocuSign account |
| `delete-connect-log-entries` | `docusign.deleteConnectLogEntries()` | — | 2 | Deletes Connect log entries for a DocuSign account |
| `delete-connect-oauth-configuration` | `docusign.deleteConnectOauthConfiguration()` | — | 1 | Deletes the Connect OAuth configuration for a specified DocuSign account |
| `delete-contact-from-account` | `docusign.deleteContactFromAccount()` | `--contactId` | 1 | Deletes a specific contact from a DocuSign account |
| `delete-custom-document-fields` | `docusign.deleteCustomDocumentFields()` | `--documentId` `--envelopeId` | 2 | Deletes custom document fields from an existing envelope document in DocuSign |
| `delete-custom-document-fields-from-template` | `docusign.deleteCustomDocumentFieldsFromTemplate()` | `--documentId` `--templateId` | 2 | Deletes specified custom document fields from an existing template document in DocuSign |
| `delete-custom-fields-in-template` | `docusign.deleteCustomFieldsInTemplate()` | `--templateId` | 3 | Deletes specified custom fields from a DocuSign template |
| `delete-custom-tab-information` | `docusign.deleteCustomTabInformation()` | `--customTabId` | 1 | Deletes a specified custom tab from a DocuSign account |
| `delete-custom-user-settings` | `docusign.deleteCustomUserSettings()` | `--userId` | 2 | Deletes specified custom user settings for a DocuSign user by their names |
| `delete-delayed-routing-rule-for-envelope-step` | `docusign.deleteDelayedRoutingRuleForEnvelopeStep()` | `--envelopeId` `--workflowStepId` | 1 | This endpoint deletes the delayed routing object for a specific envelope's workflow step in DocuSign |
| `delete-delayed-routing-rules-for-template` | `docusign.deleteDelayedRoutingRulesForTemplate()` | `--templateId` `--workflowStepId` | 1 | Deletes the delayed routing rules for a specific template workflow step in DocuSign |
| `delete-draft-envelope-attachments` | `docusign.deleteDraftEnvelopeAttachments()` | `--envelopeId` | 2 | Deletes one or more envelope attachments from a draft envelope in DocuSign |
| `delete-enote-configuration` | `docusign.deleteEnoteConfiguration()` | — | 1 | Deletes an existing eNote configuration associated with a specific DocuSign account |
| `delete-envelope-custom-fields` | `docusign.deleteEnvelopeCustomFields()` | `--envelopeId` | 3 | This endpoint deletes envelope custom fields for draft and in-process envelopes in DocuSign |
| `delete-envelope-email-settings` | `docusign.deleteEnvelopeEmailSettings()` | `--envelopeId` | 1 | Deletes all existing email override settings for a specific envelope in DocuSign |
| `delete-envelope-lock` | `docusign.deleteEnvelopeLock()` | `--envelopeId` `--lockToken` | 1 | Deletes the lock from a specified envelope, allowing it to be modified again |
| `delete-envelope-scheduled-sending-rules` | `docusign.deleteEnvelopeScheduledSendingRules()` | `--envelopeId` | 1 | Deletes the scheduled sending rules for a specific envelope's workflow in DocuSign |
| `delete-envelope-transfer-rule` | `docusign.deleteEnvelopeTransferRule()` | `--envelopeTransferRuleId` | 1 | Deletes a specific envelope transfer rule from a DocuSign account |
| `delete-envelope-workflow-definition` | `docusign.deleteEnvelopeWorkflowDefinition()` | `--envelopeId` | 1 | This endpoint deletes the workflow definition for a specified envelope in DocuSign |
| `delete-envelope-workflow-step` | `docusign.deleteEnvelopeWorkflowStep()` | `--envelopeId` `--workflowStepId` | 1 | Deletes a specific workflow step from an envelope in DocuSign |
| `delete-existing-workspace-logically` | `docusign.deleteExistingWorkspaceLogically()` | `--workspaceId` | 1 | Marks a DocuSign workspace as deleted by changing its status to "status_deleted" |
| `delete-members-from-signing-group` | `docusign.deleteMembersFromSigningGroup()` | `--signingGroupId` | 2 | Removes one or more members from a specified DocuSign signing group |
| `delete-multiple-contacts-from-account` | `docusign.deleteMultipleContactsFromAccount()` | — | 2 | Deletes multiple contacts associated with a specific DocuSign account |
| `delete-notary-jurisdiction` | `docusign.deleteNotaryJurisdiction()` | `--jurisdictionId` | 0 | Deletes a specified notary jurisdiction from the DocuSign system |
| `delete-one-or-more-signing-groups` | `docusign.deleteOneOrMoreSigningGroups()` | — | 2 | Deletes one or more signing groups from a specified DocuSign account |
| `delete-page-from-document-in-envelope` | `docusign.deletePageFromDocumentInEnvelope()` | `--documentId` `--envelopeId` `--pageNumber` | 1 | Deletes a specific page from a document within a DocuSign envelope |
| `delete-page-from-template-document` | `docusign.deletePageFromTemplateDocument()` | `--documentId` `--pageNumber` `--templateId` | 1 | Deletes a specific page from a document within a DocuSign template |
| `delete-power-form-by-id` | `docusign.deletePowerFormById()` | `--powerFormId` | 1 | This endpoint deletes a specific PowerForm identified by its unique ID within a DocuSign account |
| `delete-request-log-files` | `docusign.deleteRequestLogFiles()` | — | 0 | Deletes all request log files for the authenticated user in DocuSign |
| `delete-scheduled-sending-rules` | `docusign.deleteScheduledSendingRules()` | `--templateId` | 1 | Deletes all scheduled sending rules associated with a specific DocuSign template's workflow |
| `delete-signature-for-captive-recipients` | `docusign.deleteSignatureForCaptiveRecipients()` | — | 3 | Deletes the signature for one or more captive (embedded) recipients in DocuSign |
| `delete-specific-connect-log-entry` | `docusign.deleteSpecificConnectLogEntry()` | `--logId` | 1 | Deletes a specified entry or all entries from the DocuSign Connect log for a given account |
| `delete-specified-account` | `docusign.deleteSpecifiedAccount()` | — | 2 | Deletes (closes) a specified DocuSign account |
| `delete-stamp-image-for-account` | `docusign.deleteStampImageForAccount()` | `--imageType` `--signatureId` | 1 | This endpoint deletes a specific stamp image associated with an account signature in DocuSign |
| `delete-template-from-envelope-document` | `docusign.deleteTemplateFromEnvelopeDocument()` | `--documentId` `--envelopeId` `--templateId` | 1 | Deletes a template from a document within an envelope |
| `delete-template-lock` | `docusign.deleteTemplateLock()` | `--lockToken` `--templateId` | 1 | Deletes the lock from a specified DocuSign template, releasing it for editing by others |
| `delete-template-workflow-step` | `docusign.deleteTemplateWorkflowStep()` | `--templateId` `--workflowStepId` | 1 | Deletes a specific workflow step from a template's workflow definition in DocuSign |
| `delete-user-auth-for-cloud-storage-providers` | `docusign.deleteUserAuthForCloudStorageProviders()` | `--userId` | 2 | This endpoint deletes the user authentication information for one or more cloud storage providers associated with a specific DocuSign user account |
| `delete-user-authorization` | `docusign.deleteUserAuthorization()` | `--authorizationId` `--userId` | 1 | Deletes a specific user authorization within the DocuSign system |
| `delete-user-authorizations` | `docusign.deleteUserAuthorizations()` | `--authorizations` `--userId` | 1 | The DeleteUserAuthorizations endpoint is used to remove one or more user authorizations for a specified principal user within a DocuSign account |
| `delete-user-cloud-storage-authentication` | `docusign.deleteUserCloudStorageAuthentication()` | `--serviceId` | 2 | This endpoint deletes the user authentication information for a specified cloud storage provider in DocuSign |
| `delete-user-group` | `docusign.deleteUserGroup()` | — | 8 | Deletes one or more existing user groups from a specified DocuSign account |
| `delete-user-initials-or-signature-image` | `docusign.deleteUserInitialsOrSignatureImage()` | `--imageType` `--signatureId` `--userId` | 1 | This endpoint deletes a specified initials image or signature image for a user in DocuSign |
| `delete-user-profile-image` | `docusign.deleteUserProfileImage()` | — | 2 | Deletes the profile image of a specified user within a DocuSign account |
| `delete-users-from-group` | `docusign.deleteUsersFromGroup()` | `--groupId` | 2 | Deletes one or more users from a specified group within a DocuSign account |
| `delete-workflow-definition-for-template` | `docusign.deleteWorkflowDefinitionForTemplate()` | `--templateId` | 1 | Deletes the workflow definition associated with a specific template in DocuSign |
| `delete-workspace-files-or-folders` | `docusign.deleteWorkspaceFilesOrFolders()` | `--folderId` `--workspaceId` | 2 | This endpoint allows for the deletion of one or more files or sub-folders from a DocuSign workspace folder or root |
| `deprecated-endpoint-for-tab-blob` | `docusign.deprecatedEndpointForTabBlob()` | `--envelopeId` | 1 | This deprecated endpoint is used to update tab-related data (tab blobs) within a specific envelope in a DocuSign account |
| `export-brand-to-xmlfile` | `docusign.exportBrandToXmlfile()` | `--brandId` | 1 | Exports a DocuSign brand's configuration as an XML string |
| `fetch-recipient-names-for-email` | `docusign.fetchRecipientNamesForEmail()` | `--email` | 1 | Retrieves a list of all names associated with a specified email address in DocuSign |
| `generate-edit-view-urlfor-envelope` | `docusign.generateEditViewUrlforEnvelope()` | `--envelopeId` | 30 | Generates a URL for accessing and editing an existing envelope within the DocuSign UI, allowing for embedded editing functionality in external applications |
| `generate-envelope-correction-url` | `docusign.generateEnvelopeCorrectionUrl()` | `--envelopeId` `--returnUrl` | 29 | Generates a URL that allows embedding the envelope correction view of the DocuSign UI within an application |
| `generate-recipient-shared-view-url` | `docusign.generateRecipientSharedViewUrl()` | `--envelopeId` `--recipientId` `--userId` | 26 | Generates a URL for embedding the DocuSign recipient view of a shared envelope in your application |
| `get-account-billing-charges-list` | `docusign.getAccountBillingChargesList()` | — | 2 | Retrieves a detailed list of recurring and usage charges for a specified DocuSign account |
| `get-account-contacts` | `docusign.getAccountContacts()` | `--contactId` | 2 | Retrieves detailed information about a specific contact from a DocuSign account's address book |
| `get-account-password-rules` | `docusign.getAccountPasswordRules()` | — | 1 | Retrieves the current password rules and security settings for a specified DocuSign account |
| `get-account-stamp-image` | `docusign.getAccountStampImage()` | `--imageType` `--signatureId` | 2 | Retrieves the image file for a specific account stamp, signature, or initials in DocuSign |
| `get-agent-user-authorizations` | `docusign.getAgentUserAuthorizations()` | — | 7 | Returns the authorizations for which the specified user is the agent user |
| `get-bcc-email-archive-configurations` | `docusign.getBccEmailArchiveConfigurations()` | — | 3 | Retrieves a list of BCC (Blind Carbon Copy) email archive configurations associated with a specified DocuSign account |
| `get-bccemail-archive-history` | `docusign.getBccemailArchiveHistory()` | `--bccEmailArchiveId` | 3 | Retrieves the history of changes made to a specific BCC email archive configuration for a DocuSign account |
| `get-brand-logo-by-type` | `docusign.getBrandLogoByType()` | `--brandId` `--logoType` | 1 | Retrieves a specific logo used in a brand for a DocuSign account |
| `get-brands-information-for-group` | `docusign.getBrandsInformationForGroup()` | `--groupId` | 1 | Retrieves detailed brand information associated with a specific group within a DocuSign account |
| `get-bulk-send-batch-status` | `docusign.getBulkSendBatchStatus()` | `--bulkSendBatchId` | 1 | Get the status and progress of a DocuSign bulk send batch operation |
| `get-bulk-send-lists-information` | `docusign.getBulkSendListsInformation()` | — | 1 | Retrieves a list of Bulk Send Lists belonging to the current user in a specified DocuSign account |
| `get-downgrade-plan-info-for-account` | `docusign.getDowngradePlanInfoForAccount()` | — | 1 | Retrieves detailed billing information related to a downgrade request for a specific DocuSign account |
| `get-electronic-disclosure-for-recipient` | `docusign.getElectronicDisclosureForRecipient()` | `--envelopeId` `--langCode` `--recipientId` | 1 | Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for a specific envelope recipient in DocuSign |
| `get-electronic-record-and-signature-disclosure` | `docusign.getElectronicRecordAndSignatureDisclosure()` | — | 2 | Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with a specific DocuSign account |
| `get-enote-integration-settings` | `docusign.getEnoteIntegrationSettings()` | — | 1 | Retrieves the eNote integration settings for a specified DocuSign account |
| `get-envelope` ·common | `docusign.getEnvelope()` | `--account-id` `--envelope-id` | 0 | Gets the status and basic information about an envelope from DocuSign |
| `get-envelope-doc-gen-form-fields` ·common | `docusign.getEnvelopeDocGenFormFields()` | `--envelope-id` | 1 | Retrieves document generation form fields from an envelope's documents |
| `get-envelope-document-fields` ·common | `docusign.getEnvelopeDocumentFields()` | `--account-id` `--document-id` `--envelope-id` | 0 | Retrieves custom document fields from a specific document within a DocuSign envelope |
| `get-envelope-lock-information` | `docusign.getEnvelopeLockInformation()` | `--envelopeId` | 1 | Retrieves general information about an envelope lock in DocuSign |
| `get-envelope-notification-defaults` | `docusign.getEnvelopeNotificationDefaults()` | — | 1 | Retrieves the default email notification settings for envelopes at the account level |
| `get-envelope-workflow-definition` | `docusign.getEnvelopeWorkflowDefinition()` | `--envelopeId` | 1 | Retrieves the workflow definition for a specified envelope in DocuSign |
| `get-envelope-workflow-delayed-routing-definition` | `docusign.getEnvelopeWorkflowDelayedRoutingDefinition()` | `--envelopeId` `--workflowStepId` | 1 | Retrieves the delayed routing rules for a specific workflow step within a DocuSign envelope |
| `get-groups-information-for-account` | `docusign.getGroupsInformationForAccount()` | — | 6 | Retrieves detailed information about groups associated with a specific DocuSign account |
| `get-list-of-account-permission-profiles` | `docusign.getListOfAccountPermissionProfiles()` | — | 2 | This endpoint retrieves a comprehensive list of permission profiles associated with a specified DocuSign account |
| `get-members-of-signing-group` | `docusign.getMembersOfSigningGroup()` | `--signingGroupId` | 1 | Retrieves the list of members in a specified DocuSign Signing Group |
| `get-notary-journals` | `docusign.getNotaryJournals()` | — | 3 | Retrieve notary journal entries for the current user |
| `get-notary-jurisdiction-object` | `docusign.getNotaryJurisdictionObject()` | `--jurisdictionId` | 0 | Retrieves detailed information about a specific notary jurisdiction for the authenticated user |
| `get-notary-user-settings` | `docusign.getNotaryUserSettings()` | — | 1 | Retrieves notary settings and configuration for the currently authenticated user |
| `get-original-html-definition-for-template` | `docusign.getOriginalHtmlDefinitionForTemplate()` | `--templateId` | 1 | Retrieves the original HTML definition for a specified DocuSign template |
| `get-page-image-from-envelope` | `docusign.getPageImageFromEnvelope()` | `--documentId` `--envelopeId` `--pageNumber` | 5 | Retrieves an image of a specific page from a document within a DocuSign envelope |
| `get-pdftranscript-of-envelope-comments` | `docusign.getPdftranscriptOfEnvelopeComments()` | `--envelopeId` | 2 | Retrieves a PDF transcript containing all comments added by senders and recipients to documents within a specific envelope in a DocuSign account |
| `get-permission-profile-for-account` | `docusign.getPermissionProfileForAccount()` | `--permissionProfileId` | 2 | This endpoint retrieves detailed information about a specific permission profile in a DocuSign account |
| `get-power-form-senders` | `docusign.getPowerFormSenders()` | — | 2 | Retrieves a list of users who have sent PowerForms within a specified DocuSign account |
| `get-recipient-document-visibility` | `docusign.getRecipientDocumentVisibility()` | `--accountId` `--envelopeId` `--recipientId` | 0 | Retrieves document visibility settings for a specific recipient within a DocuSign envelope |
| `get-request-log-settings` | `docusign.getRequestLogSettings()` | — | 0 | Retrieve current API request logging settings for the authenticated user |
| `get-request-logging-log-file` | `docusign.getRequestLoggingLogFile()` | `--requestLogId` | 0 | Downloads the complete log file for a specific API request from DocuSign's Diagnostics service |
| `get-request-logs` | `docusign.getRequestLogs()` | — | 1 | Retrieves a list of API request log entries as a JSON object |
| `get-resource-information` | `docusign.getResourceInformation()` | — | 0 | Retrieves the base resources available for the DocuSign eSignature REST API |
| `get-service-information` | `docusign.getServiceInformation()` | — | 0 | Gets the current version and other information about the DocuSign eSignature REST API |
| `get-signature-information-for-recipient` | `docusign.getSignatureInformationForRecipient()` | `--envelopeId` `--recipientId` | 1 | Retrieves signature information for a specific recipient in a DocuSign envelope |
| `get-signing-group-information` | `docusign.getSigningGroupInformation()` | `--signingGroupId` | 1 | Retrieves detailed information about a specific signing group in a DocuSign account |
| `get-specific-brand-resource-file` | `docusign.getSpecificBrandResourceFile()` | `--brandId` `--resourceContentType` | 3 | Retrieves a specific branding resource file (XML format) for customizing DocuSign experiences |
| `get-specified-account-stamp-info` | `docusign.getSpecifiedAccountStampInfo()` | `--signatureId` | 1 | Retrieves detailed information about a specific account stamp (signature) in DocuSign |
| `get-supported-languages-for-recipients` | `docusign.getSupportedLanguagesForRecipients()` | — | 1 | Retrieves a comprehensive list of supported languages that can be set for individual recipients when creating a DocuSign envelope |
| `get-tab-settings-for-account` | `docusign.getTabSettingsForAccount()` | — | 1 | Retrieves the current tab settings and functionality enabled for a specific DocuSign account |
| `get-tabs-blob-for-envelope` | `docusign.getTabsBlobForEnvelope()` | `--accountId` `--envelopeId` | 0 | This deprecated endpoint retrieves the tabs blob associated with a specific envelope in DocuSign |
| `get-template` ·common | `docusign.getTemplate()` | `--account-id` `--template-id` | 1 | Gets a template definition from the specified account |
| `get-template-delayed-routing-rules` | `docusign.getTemplateDelayedRoutingRules()` | `--templateId` `--workflowStepId` | 1 | Retrieves the delayed routing rules for a specific workflow step within a DocuSign template |
| `get-template-document-html-definition` | `docusign.getTemplateDocumentHtmlDefinition()` | `--documentId` `--templateId` | 1 | Retrieves the HTML definition for a specific document within a DocuSign template |
| `get-template-lock-information` | `docusign.getTemplateLockInformation()` | `--templateId` | 1 | Retrieves lock information for a DocuSign template |
| `get-template-notification-information` | `docusign.getTemplateNotificationInformation()` | `--templateId` | 1 | Retrieves the envelope notification, reminders, and expiration information for an existing template in DocuSign |
| `get-template-recipient-document-visibility` | `docusign.getTemplateRecipientDocumentVisibility()` | `--recipientId` `--templateId` | 1 | Retrieves document visibility settings for a specific recipient in a DocuSign template |
| `get-template-scheduled-sending-settings` | `docusign.getTemplateScheduledSendingSettings()` | `--templateId` | 1 | Retrieves the scheduled sending settings for a specified DocuSign template |
| `get-templates-for-envelope-document` | `docusign.getTemplatesForEnvelopeDocument()` | `--documentId` `--envelopeId` | 2 | Retrieves the templates associated with a specific document within a DocuSign envelope |
| `get-templates-used-in-envelope` | `docusign.getTemplatesUsedInEnvelope()` | `--envelopeId` | 2 | This endpoint retrieves a list of server-side templates used in a specific DocuSign envelope |
| `get-unsupported-file-types-list` | `docusign.getUnsupportedFileTypesList()` | — | 1 | Retrieves the list of file types (extensions and MIME types) that DocuSign does not support for upload |
| `get-urlfor-embedding-ui` | `docusign.getUrlforEmbeddingUi()` | — | 3 | Generate a URL to embed the DocuSign console view within your application |
| `get-user-authorization-details` | `docusign.getUserAuthorizationDetails()` | `--authorizationId` | 2 | Retrieves detailed information about a specific user authorization in DocuSign |
| `get-user-authorizations-for-principal` | `docusign.getUserAuthorizationsForPrincipal()` | — | 9 | Retrieves user authorizations for a specified principal user within a DocuSign account |
| `get-user-cloud-storage-provider-configuration` | `docusign.getUserCloudStorageProviderConfiguration()` | `--serviceId` | 3 | Retrieves the cloud storage provider configuration for a specific cloud storage service (identified by serviceId) for a user within a DocuSign account |
| `get-user-information-by-id` | `docusign.getUserInformationById()` | — | 4 | Retrieves detailed information about a specific user within a DocuSign account |
| `get-users-in-group` | `docusign.getUsersInGroup()` | `--groupId` | 3 | Retrieves a paginated list of users belonging to a specific group within a DocuSign account |
| `get-watermark-details-for-account` | `docusign.getWatermarkDetailsForAccount()` | — | 1 | Retrieves and previews the watermark details for a specific DocuSign account |
| `get-workflow-step-for-envelope` | `docusign.getWorkflowStepForEnvelope()` | `--envelopeId` `--workflowStepId` | 1 | Retrieves detailed information about a specific workflow step for a DocuSign envelope |
| `get-workspace-file` | `docusign.getWorkspaceFile()` | `--fileId` `--folderId` `--workspaceId` | 3 | Retrieves a binary version of a file from a DocuSign workspace |
| `get-workspace-folder-contents` | `docusign.getWorkspaceFolderContents()` | `--folderId` `--workspaceId` | 8 | Retrieves the contents of a specific workspace folder in DocuSign, including sub-folders and files |
| `initiate-new-chunked-upload` | `docusign.initiateNewChunkedUpload()` | — | 3 | Initiates a new chunked upload in DocuSign by sending the first part of the content |
| `list-all-templates` ·common | `docusign.listAllTemplates()` | `--account-id` | 23 | Gets the definition of a template or templates in the specified account |
| `list-billing-invoices` | `docusign.listBillingInvoices()` | — | 3 | Retrieves a list of billing invoices for a specified DocuSign account |
| `list-brands-for-account` | `docusign.listBrandsForAccount()` | — | 3 | Retrieves a comprehensive list of brands associated with a DocuSign account, including default brand profiles |
| `list-bulk-send-batch-summaries` | `docusign.listBulkSendBatchSummaries()` | — | 9 | Retrieves a summary of bulk send batches for a DocuSign account |
| `list-cloud-storage-items` | `docusign.listCloudStorageItems()` | `--folderId` `--serviceId` | 9 | Retrieves a list of items (files and folders) from a specific folder in a cloud storage provider integrated with DocuSign |
| `list-envelope-and-document-custom-fields` | `docusign.listEnvelopeAndDocumentCustomFields()` | — | 1 | Retrieves all account-level custom fields defined for a DocuSign account |
| `list-envelope-attachments-by-envelope-id` | `docusign.listEnvelopeAttachmentsByEnvelopeId()` | `--envelopeId` | 1 | Retrieves a list of envelope attachments associated with a specified envelope in DocuSign |
| `list-oauth-userinfo` ·common | `docusign.listOauthUserinfo()` | — | 0 | Retrieve authenticated user's account information from DocuSign OAuth |
| `list-past-due-invoices` | `docusign.listPastDueInvoices()` | — | 1 | Retrieves a list of past due invoices for a specified DocuSign account and indicates if payment can be made through the REST API |
| `list-payment-gateway-accounts-info` | `docusign.listPaymentGatewayAccountsInfo()` | — | 1 | Retrieves a list of all payment gateway accounts associated with a specific DocuSign account, along with detailed information about each account |
| `list-registered-notary-jurisdictions` | `docusign.listRegisteredNotaryJurisdictions()` | — | 0 | Retrieves a paginated list of registered notary jurisdictions for the current user, who must be a notary |
| `list-signature-providers-for-account` | `docusign.listSignatureProvidersForAccount()` | — | 1 | Retrieves a list of signature providers available for a specified DocuSign account |
| `list-users-for-account` | `docusign.listUsersForAccount()` | — | 14 | Retrieves a list of users for a specified DocuSign account |
| `list-workspace-file-pages` | `docusign.listWorkspaceFilePages()` | `--fileId` `--folderId` `--workspaceId` | 6 | Retrieves a workspace file as rasterized pages from a DocuSign workspace |
| `list-workspaces` | `docusign.listWorkspaces()` | — | 1 | Retrieves a list of DocuSign workspaces and their associated information for a specified account |
| `lock-envelope-for-editing` | `docusign.lockEnvelopeForEditing()` | `--envelopeId` | 6 | This endpoint locks an envelope for editing, preventing other users or recipients from changing it |
| `lock-template-for-editing` | `docusign.lockTemplateForEditing()` | `--templateId` | 6 | Locks a specified DocuSign template for editing to prevent concurrent modifications |
| `modify-account-notification-settings` | `docusign.modifyAccountNotificationSettings()` | — | 57 | Updates the default email notification settings for envelope senders and signers in a DocuSign account |
| `modify-tab-settings-for-account` | `docusign.modifyTabSettingsForAccount()` | — | 169 | This endpoint modifies the tab types and tab functionality that are enabled for a DocuSign account |
| `post-payment-to-invoice` | `docusign.postPaymentToInvoice()` | `--paymentAmount` | 1 | Posts a payment to past due invoices for a DocuSign account |
| `purchase-additional-envelopes` | `docusign.purchaseAdditionalEnvelopes()` | `--accountId` | 9 | This endpoint completes the purchase of additional envelopes for a DocuSign account through an internal workflow interaction with an envelope vendor |
| `queue-downgrade-billing-plan-request` | `docusign.queueDowngradeBillingPlanRequest()` | `--accountId` | 11 | Queues a downgrade request for a DocuSign account's billing plan |
| `register-current-user-as-notary` | `docusign.registerCurrentUserAsNotary()` | — | 772 | This endpoint registers the current user as a notary in DocuSign, enabling remote online notarization capabilities |
| `remove-bulk-send-list` | `docusign.removeBulkSendList()` | `--bulkSendListId` | 1 | This endpoint deletes a specific bulk send list from a DocuSign account |
| `remove-group-sharing-permissions-for-template` | `docusign.removeGroupSharingPermissionsForTemplate()` | `--templateId` `--templatePart` | 8 | Removes sharing permissions for specified member groups from a DocuSign template |
| `remove-templates-from-favorites` | `docusign.removeTemplatesFromFavorites()` | `--accountId` | 4 | Removes one or more templates from an account's list of favorite templates in DocuSign |
| `remove-user-signature-information` | `docusign.removeUserSignatureInformation()` | `--signatureId` | 2 | Removes the signature information for a specific user in DocuSign |
| `republish-connect-data-for-envelope` | `docusign.republishConnectDataForEnvelope()` | `--envelopeId` | 1 | Republishes Connect information for a specified envelope in DocuSign |
| `republish-connect-info-for-envelopes` | `docusign.republishConnectInfoForEnvelopes()` | — | 3 | Republishes Connect webhook information for multiple DocuSign envelopes |
| `retrieve-account-billing-plan` | `docusign.retrieveAccountBillingPlan()` | `--accountId` | 5 | Retrieves detailed billing plan information for a specified DocuSign account |
| `retrieve-account-brand-information` | `docusign.retrieveAccountBrandInformation()` | `--brandId` | 3 | Retrieves detailed information about a specific brand associated with a DocuSign account |
| `retrieve-account-envelope-purge-config` | `docusign.retrieveAccountEnvelopePurgeConfig()` | — | 1 | Retrieves the current envelope purge configuration for a specified DocuSign account |
| `retrieve-account-favorite-templates` | `docusign.retrieveAccountFavoriteTemplates()` | — | 1 | Retrieves the list of favorite templates for a DocuSign account |
| `retrieve-account-information-for-specified-account` | `docusign.retrieveAccountInformationForSpecifiedAccount()` | — | 2 | Retrieves comprehensive information for a specified DocuSign account, including account details, billing information, plan specifics, and optionally detailed account settings |
| `retrieve-account-provisioning-info` | `docusign.retrieveAccountProvisioningInfo()` | — | 1 | Retrieves the account provisioning information for a DocuSign account |
| `retrieve-account-seal-providers` | `docusign.retrieveAccountSealProviders()` | — | 1 | Retrieves electronic seal providers (eSeals) available for a DocuSign account |
| `retrieve-account-settings-information` | `docusign.retrieveAccountSettingsInformation()` | — | 1 | Retrieves the comprehensive account settings information for a specified DocuSign account |
| `retrieve-account-signing-groups` | `docusign.retrieveAccountSigningGroups()` | — | 3 | Retrieves a comprehensive list of all signing groups within a specified DocuSign account |
| `retrieve-account-verification-workflows` | `docusign.retrieveAccountVerificationWorkflows()` | — | 2 | Retrieves a list of Identity Verification workflows available for a DocuSign account |
| `retrieve-all-account-tabs` | `docusign.retrieveAllAccountTabs()` | — | 2 | Retrieves a comprehensive list of all tabs associated with a specified DocuSign account |
| `retrieve-available-account-stamps` | `docusign.retrieveAvailableAccountStamps()` | — | 4 | Retrieves a list of stamps available in a DocuSign account |
| `retrieve-billing-invoice` | `docusign.retrieveBillingInvoice()` | `--invoiceId` | 1 | Retrieves a specific billing invoice for a DocuSign account, providing detailed information about charges and payment details |
| `retrieve-billing-payment-info` | `docusign.retrieveBillingPaymentInfo()` | `--paymentId` | 1 | Retrieves detailed information for a specific billing payment in a DocuSign account |
| `retrieve-chunked-upload-metadata` | `docusign.retrieveChunkedUploadMetadata()` | `--accountId` `--chunkedUploadId` | 1 | Retrieves metadata for a specific chunked upload in DocuSign |
| `retrieve-cloud-storage-provider-configuration` | `docusign.retrieveCloudStorageProviderConfiguration()` | — | 3 | Retrieves the list of cloud storage providers enabled for a specific user in a DocuSign account, along with their configuration information |
| `retrieve-connect-configuration-details` | `docusign.retrieveConnectConfigurationDetails()` | `--connectId` | 1 | Retrieves detailed information for a specific DocuSign Connect configuration |
| `retrieve-connect-configurations` | `docusign.retrieveConnectConfigurations()` | — | 1 | Retrieves all Docusign Custom Connect definitions for a specified account |
| `retrieve-connect-failure-logs` | `docusign.retrieveConnectFailureLogs()` | — | 3 | Retrieves the Connect failure log information for a specified DocuSign account |
| `retrieve-connect-log-entry` | `docusign.retrieveConnectLogEntry()` | `--logId` | 2 | Retrieves a specific Connect log entry for a DocuSign account |
| `retrieve-connect-logs` | `docusign.retrieveConnectLogs()` | — | 3 | Retrieves the 100 most recent Connect log entries for a specified DocuSign account |
| `retrieve-connect-oauth-configuration` | `docusign.retrieveConnectOauthConfiguration()` | — | 1 | Retrieves the Connect OAuth configuration for a specified DocuSign account |
| `retrieve-credit-card-info` | `docusign.retrieveCreditCardInfo()` | — | 1 | This endpoint retrieves detailed credit card information associated with a specific DocuSign account |
| `retrieve-custom-fields-for-envelope` | `docusign.retrieveCustomFieldsForEnvelope()` | `--envelopeId` | 1 | Retrieves custom field metadata for a specified envelope |
| `retrieve-custom-fields-for-template` | `docusign.retrieveCustomFieldsForTemplate()` | `--documentId` `--templateId` | 1 | This endpoint retrieves the custom document fields for an existing template document in DocuSign |
| `retrieve-custom-tab-information` | `docusign.retrieveCustomTabInformation()` | `--customTabId` | 1 | Retrieves detailed information about a specific custom tab associated with a DocuSign account |
| `retrieve-custom-user-settings` | `docusign.retrieveCustomUserSettings()` | — | 2 | Retrieves a list of custom user settings for a single user in DocuSign |
| `retrieve-default-disclosure-for-envelope` | `docusign.retrieveDefaultDisclosureForEnvelope()` | `--envelopeId` `--recipientId` | 2 | Retrieves the default HTML-formatted Electronic Record and Signature Disclosure (ERSD) for a specified envelope in DocuSign |
| `retrieve-envelope-attachment` | `docusign.retrieveEnvelopeAttachment()` | `--attachmentId` `--envelopeId` | 1 | Downloads a developer-only envelope attachment file from a DocuSign envelope |
| `retrieve-envelope-audit-events` | `docusign.retrieveEnvelopeAuditEvents()` | `--envelopeId` | 1 | Retrieves the audit events for a specified envelope in DocuSign |
| `retrieve-envelope-documents` | `docusign.retrieveEnvelopeDocuments()` | `--documentId` `--envelopeId` | 10 | Retrieves one or more documents from a DocuSign envelope |
| `retrieve-envelope-email-overrides` | `docusign.retrieveEnvelopeEmailOverrides()` | `--envelopeId` | 1 | Retrieves custom email settings for a specific DocuSign envelope |
| `retrieve-envelope-html-definition` | `docusign.retrieveEnvelopeHtmlDefinition()` | `--accountId` `--documentId` `--envelopeId` | 0 | Retrieves the original HTML definition used to generate the responsive HTML for a specific document within an envelope in a DocuSign account |
| `retrieve-envelope-notification-details` | `docusign.retrieveEnvelopeNotificationDetails()` | `--envelopeId` | 1 | Retrieves the notification, reminder, and expiration settings for an existing envelope in DocuSign |
| `retrieve-items-in-cloud-storage-folder` | `docusign.retrieveItemsInCloudStorageFolder()` | `--serviceId` `--userId` | 7 | Retrieves a list of items (files and folders) from a specified folder in an integrated cloud storage provider |
| `retrieve-list-of-billing-plans` | `docusign.retrieveListOfBillingPlans()` | — | 0 | Retrieves a comprehensive list of billing plans associated with a distributor in the DocuSign system |
| `retrieve-payment-information-list` | `docusign.retrievePaymentInformationList()` | — | 3 | Retrieves a list of payment information for a specific DocuSign account |
| `retrieve-pdf-from-specified-template` | `docusign.retrievePdfFromSpecifiedTemplate()` | `--documentId` `--templateId` | 4 | Retrieves one or more PDF documents from a specified DocuSign template |
| `retrieve-power-form-data-entries` | `docusign.retrievePowerFormDataEntries()` | `--powerFormId` | 4 | This endpoint retrieves data entries for a specific PowerForm within a DocuSign account |
| `retrieve-properties-about-workspace` | `docusign.retrievePropertiesAboutWorkspace()` | `--workspaceId` | 1 | Retrieves detailed properties and information about a specific DocuSign workspace |
| `retrieve-shared-item-status-for-users` | `docusign.retrieveSharedItemStatusForUsers()` | — | 9 | Retrieves shared item status for one or more users and types of items within a DocuSign account |
| `retrieve-signer-signature-image-information` | `docusign.retrieveSignerSignatureImageInformation()` | `--envelopeId` `--recipientId` | 2 | Retrieves the specified user's signature image from a DocuSign envelope |
| `retrieve-template-custom-fields` | `docusign.retrieveTemplateCustomFields()` | `--templateId` | 1 | Retrieves the custom document field information from an existing template in DocuSign |
| `retrieve-template-document-page-images` | `docusign.retrieveTemplateDocumentPageImages()` | `--documentId` `--templateId` | 8 | Retrieves and returns images of pages from a specified template document in DocuSign |
| `retrieve-template-page-image` | `docusign.retrieveTemplatePageImage()` | `--accountId` `--documentId` `--pageNumber` `--templateId` | 4 | Retrieves a specific page image from a template document for display purposes |
| `retrieve-user-account-settings` | `docusign.retrieveUserAccountSettings()` | — | 2 | Retrieves a comprehensive list of account settings and email notification preferences for a specified user within a DocuSign account |
| `retrieve-user-initials-image-for-envelopes` | `docusign.retrieveUserInitialsImageForEnvelopes()` | `--envelopeId` `--recipientId` | 2 | Retrieves the initials image that a recipient used when signing a DocuSign envelope |
| `retrieve-user-profile-image` | `docusign.retrieveUserProfileImage()` | — | 3 | Retrieves the user profile picture for a specified user within a DocuSign account |
| `retrieve-user-profile-information` | `docusign.retrieveUserProfileInformation()` | — | 2 | This endpoint retrieves comprehensive user profile information for a specified user within a DocuSign account |
| `retrieve-user-signature-definitions` | `docusign.retrieveUserSignatureDefinitions()` | — | 3 | This endpoint retrieves the signature definitions for a specified user within a DocuSign account |
| `retrieve-user-signature-image` | `docusign.retrieveUserSignatureImage()` | `--imageType` `--signatureId` | 3 | Retrieves a specified user's signature or initials image from DocuSign |
| `retrieve-user-signature-information` | `docusign.retrieveUserSignatureInformation()` | `--signatureId` | 2 | This endpoint retrieves the detailed structure and information of a single user signature within a DocuSign account |
| `retrieve-workflow-step-for-template` | `docusign.retrieveWorkflowStepForTemplate()` | `--templateId` `--workflowStepId` | 1 | Retrieves detailed information about a specific workflow step for a DocuSign template |
| `return-all-connect-service-users` | `docusign.returnAllConnectServiceUsers()` | `--connectId` | 7 | Retrieves all users from the configured Connect service for a specific DocuSign account and Connect configuration |
| `return-brand-resource-metadata-for-account` | `docusign.returnBrandResourceMetadataForAccount()` | `--brandId` | 1 | Retrieves metadata about the branding resources associated with a specific DocuSign account and brand |
| `return-envelope-tab-data-for-existing-envelope` | `docusign.returnEnvelopeTabDataForExistingEnvelope()` | `--accountId` `--envelopeId` | 0 | Retrieves detailed form data from a DocuSign envelope, including the current values of form fields, recipient information, and envelope status |
| `return-scheduled-sending-rules-for-envelope` | `docusign.returnScheduledSendingRulesForEnvelope()` | `--envelopeId` | 1 | Get the scheduled sending configuration for a DocuSign envelope |
| `return-template-workflow-definition` | `docusign.returnTemplateWorkflowDefinition()` | `--templateId` | 1 | Retrieves the workflow definition for a specified DocuSign template |
| `return-users-from-connect-service` | `docusign.returnUsersFromConnectService()` | `--connectId` | 4 | Retrieves users associated with a specific DocuSign Connect configuration |
| `returns-document-page-images-based-on-input` | `docusign.returnsDocumentPageImagesBasedOnInput()` | `--documentId` `--envelopeId` | 8 | Retrieves images of document pages from a specific envelope in a DocuSign account |
| `revoke-envelope-correction-url` | `docusign.revokeEnvelopeCorrectionUrl()` | `--envelopeId` | 5 | This endpoint revokes the correction view URL for a specific envelope in DocuSign, effectively disabling the ability to make further corrections to the envelope |
| `rotate-page-image-for-envelope` | `docusign.rotatePageImageForEnvelope()` | `--documentId` `--envelopeId` `--pageNumber` | 3 | This endpoint rotates a page image within a specific document of an envelope in DocuSign |
| `rotate-template-page-image` | `docusign.rotateTemplatePageImage()` | `--documentId` `--pageNumber` `--templateId` | 3 | Rotates a page image within a DocuSign template for display purposes |
| `send-envelope` ·common | `docusign.sendEnvelope()` | `--account-id` `--envelope-id` | 1 | Sends a draft envelope by updating its status to 'sent' |
| `set-envelope-purge-config-for-account` | `docusign.setEnvelopePurgeConfigForAccount()` | — | 5 | Configures automatic envelope purge settings for a DocuSign account |
| `set-initials-image-for-accountless-signer` | `docusign.setInitialsImageForAccountlessSigner()` | `--envelopeId` `--image-file` `--recipientId` | 1 | This endpoint allows you to update the initials image for a signer who does not have a DocuSign account within a specific envelope |
| `set-shared-access-for-users-and-templates` | `docusign.setSharedAccessForUsersAndTemplates()` | — | 13 | This endpoint sets shared access for users and templates in DocuSign |
| `set-signature-image-for-no-account-signer` | `docusign.setSignatureImageForNoAccountSigner()` | `--envelopeId` `--recipientId` `--signature-image` | 1 | This endpoint updates the signature image for an accountless signer in a DocuSign envelope |
| `set-templates-as-account-favorites` | `docusign.setTemplatesAsAccountFavorites()` | — | 5 | This endpoint allows users to set one or more templates as account favorites in DocuSign |
| `set-up-connect-oauth-configuration` | `docusign.setUpConnectOauthConfiguration()` | — | 6 | Sets up Connect OAuth configuration for a specified DocuSign account using a custom authorization server |
| `set-user-signature-image` | `docusign.setUserSignatureImage()` | `--imageType` `--image-file` `--signatureId` | 2 | Sets or updates a user's signature image, initials, or stamp in their DocuSign account |
| `share-template-with-group` | `docusign.shareTemplateWithGroup()` | `--templateId` | 9 | This endpoint allows you to share a DocuSign template with a specified members group |
| `submit-batch-historical-envelopes-to-webhook` | `docusign.submitBatchHistoricalEnvelopesToWebhook()` | — | 47 | This endpoint submits a batch of existing envelopes to a specified webhook for historical publishing |
| `toggle-api-request-logging` | `docusign.toggleApiRequestLogging()` | — | 3 | This endpoint enables or disables API request logging for troubleshooting purposes in DocuSign |
| `update-account-brand-settings` | `docusign.updateAccountBrandSettings()` | `--brandId` | 24 | The UpdateAccountBrandSettings endpoint modifies or replaces an existing brand configuration for a DocuSign account |
| `update-account-custom-field` | `docusign.updateAccountCustomField()` | `--customFieldId` | 9 | This endpoint updates an existing account custom field in DocuSign |
| `update-account-password-rules` | `docusign.updateAccountPasswordRules()` | — | 26 | This endpoint updates the password rules for a DocuSign account |
| `update-account-settings` | `docusign.updateAccountSettings()` | — | 2907 | Updates various settings for a specified DocuSign account |
| `update-account-stamp-by-id` | `docusign.updateAccountStampById()` | `--signatureId` | 21 | This endpoint allows you to update an existing account stamp (signature) in DocuSign |
| `update-account-stamps` | `docusign.updateAccountStamps()` | — | 2 | Update existing account stamps (signatures) in a DocuSign account |
| `update-account-watermark-information` | `docusign.updateAccountWatermarkInformation()` | — | 10 | This endpoint updates the watermark settings for a specified DocuSign account |
| `update-account-watermark-preview` | `docusign.updateAccountWatermarkPreview()` | — | 10 | Updates and previews watermark settings for a DocuSign account before applying them |
| `update-billing-plan-for-account` | `docusign.updateBillingPlanForAccount()` | — | 97 | Updates billing plan information, address, and payment details for a DocuSign account |
| `update-bulk-send-batch-name` | `docusign.updateBulkSendBatchName()` | `--batchName` `--bulkSendBatchId` | 1 | Updates the name of an existing DocuSign bulk send batch |
| `update-connect-configuration` | `docusign.updateConnectConfiguration()` | — | 46 | This endpoint updates an existing DocuSign Connect configuration for a specified account |
| `update-connect-oauth-configuration` | `docusign.updateConnectOauthConfiguration()` | — | 6 | This endpoint updates an existing Connect OAuth Configuration for a DocuSign account |
| `update-contacts-information` | `docusign.updateContactsInformation()` | — | 2 | This endpoint updates one or more contacts associated with a DocuSign account |
| `update-custom-fields-in-envelope-document` | `docusign.updateCustomFieldsInEnvelopeDocument()` | `--documentId` `--envelopeId` | 2 | This endpoint allows you to update existing custom document fields in a specific document within an envelope in DocuSign |
| `update-custom-tab-information-for-account` | `docusign.updateCustomTabInformationForAccount()` | `--customTabId` | 85 | This endpoint updates the information for a custom tab associated with a specific DocuSign account |
| `update-document-visibility-recipients` | `docusign.updateDocumentVisibilityRecipients()` | `--documentVisibility` `--envelopeId` | 1 | Updates document visibility settings for multiple recipients in a DocuSign envelope |
| `update-electronic-record-disclosure` | `docusign.updateElectronicRecordDisclosure()` | `--langCode` | 44 | Updates the Electronic Record and Signature Disclosure (ERSD) for a DocuSign account |
| `update-enote-integration-config` | `docusign.updateEnoteIntegrationConfig()` | — | 7 | Updates the eNote integration configuration for a specific DocuSign account |
| `update-envelope-attachment` | `docusign.updateEnvelopeAttachment()` | `--attachmentId` `--envelopeId` | 7 | Updates an existing attachment for a draft or in-process envelope in DocuSign |
| `update-envelope-custom-fields` | `docusign.updateEnvelopeCustomFields()` | `--envelopeId` | 3 | This endpoint allows users to update custom fields for draft and in-process envelopes in DocuSign |
| `update-envelope-delayed-routing-rules` | `docusign.updateEnvelopeDelayedRoutingRules()` | `--envelopeId` `--workflowStepId` | 4 | Updates the delayed routing rules for a specific workflow step in a DocuSign envelope |
| `update-envelope-doc-gen-form-fields` ·common | `docusign.updateEnvelopeDocGenFormFields()` | `--account-id` `--doc-gen-form-fields` `--envelope-id` | 1 | This method dynamically generates an envelope's documents by populating its sender fields |
| `update-envelope-email-settings` | `docusign.updateEnvelopeEmailSettings()` | `--envelopeId` | 4 | Updates the existing email override settings for a specified envelope in DocuSign |
| `update-envelope-notification-settings` | `docusign.updateEnvelopeNotificationSettings()` | `--envelopeId` | 8 | Updates the notification settings for a specific DocuSign envelope, including reminders and expirations |
| `update-envelope-scheduled-sending-rules` | `docusign.updateEnvelopeScheduledSendingRules()` | `--envelopeId` | 5 | Updates the scheduled sending rules for an envelope's workflow in DocuSign |
| `update-envelope-workflow-definition` | `docusign.updateEnvelopeWorkflowDefinition()` | `--envelopeId` | 9 | Updates the workflow definition for a specified envelope in DocuSign |
| `update-envelope-workflow-step` | `docusign.updateEnvelopeWorkflowStep()` | `--envelopeId` `--workflowStepId` | 11 | Updates a specific workflow step for a DocuSign envelope, allowing for customization of envelope processing, including delayed routing and conditional recipients |
| `update-group-information` | `docusign.updateGroupInformation()` | — | 8 | Updates group information for one or more user groups in a DocuSign account |
| `update-lock-for-envelope` | `docusign.updateLockForEnvelope()` | `--envelopeId` | 6 | Updates lock settings for an already-locked envelope in DocuSign to extend duration or modify the locking application identifier |
| `update-notary-jurisdiction-info` | `docusign.updateNotaryJurisdictionInfo()` | `--jurisdictionId` | 17 | Updates the jurisdiction information for a notary in the DocuSign system |
| `update-permission-profile-settings` | `docusign.updatePermissionProfileSettings()` | `--permissionProfileId` | 321 | This endpoint updates an existing account permission profile in DocuSign |
| `update-recipient-document-visibility` | `docusign.updateRecipientDocumentVisibility()` | `--envelopeId` `--recipientId` | 2 | This endpoint updates the document visibility settings for a specific recipient within a DocuSign envelope |
| `update-signing-group-details` | `docusign.updateSigningGroupDetails()` | `--signingGroupId` | 11 | Updates the details of a specified signing group within a DocuSign account, including the group name, email, and member information |
| `update-signing-group-names` | `docusign.updateSigningGroupNames()` | — | 2 | Updates the names of one or more existing signing groups in DocuSign |
| `update-template-custom-fields` | `docusign.updateTemplateCustomFields()` | `--templateId` | 3 | Updates the custom fields in a DocuSign template |
| `update-template-delayed-routing-rules` | `docusign.updateTemplateDelayedRoutingRules()` | `--templateId` `--workflowStepId` | 4 | This endpoint updates the scheduled sending rules for a specific workflow step in a DocuSign template |
| `update-template-doc-visibility` | `docusign.updateTemplateDocVisibility()` | `--templateId` | 2 | This endpoint updates document visibility settings for one or more recipients in a DocuSign template |
| `update-template-document-custom-fields` | `docusign.updateTemplateDocumentCustomFields()` | `--documentId` `--templateId` | 2 | This endpoint updates existing custom document fields in a specific document within a DocuSign template |
| `update-template-lock-information` | `docusign.updateTemplateLockInformation()` | `--lockToken` `--templateId` | 6 | This endpoint allows you to update the lock information for an already locked template in DocuSign |
| `update-template-notification-settings` | `docusign.updateTemplateNotificationSettings()` | `--templateId` | 8 | This endpoint updates the notification structure for an existing DocuSign template |
| `update-template-recipient-document-visibility` | `docusign.updateTemplateRecipientDocumentVisibility()` | `--recipientId` `--templateId` | 2 | Updates document visibility settings for a specific recipient in a DocuSign template |
| `update-template-scheduled-sending-rules` | `docusign.updateTemplateScheduledSendingRules()` | `--templateId` | 5 | Updates the scheduled sending rules for a DocuSign template, controlling when envelopes created from this template are automatically sent |
| `update-template-workflow-definition` | `docusign.updateTemplateWorkflowDefinition()` | `--templateId` | 9 | Updates the workflow definition for a specified template in DocuSign, allowing for customization of the document signing process |
| `update-user-account-settings` | `docusign.updateUserAccountSettings()` | — | 705 | This endpoint updates the account settings and email notification types for a specified user in DocuSign |
| `update-user-authorization-dates` | `docusign.updateUserAuthorizationDates()` | `--authorizationId` `--userId` | 3 | Updates the start and/or end dates for a specified user authorization in DocuSign |
| `update-user-information-for-specified-user` | `docusign.updateUserInformationForSpecifiedUser()` | — | 771 | The User_PutUser endpoint allows updating user information for a specified user within a DocuSign account |
| `update-user-notary-information` | `docusign.updateUserNotaryInformation()` | — | 772 | The UpdateUserNotaryInformation endpoint modifies a notary's profile and settings in DocuSign |
| `update-user-profile-image` | `docusign.updateUserProfileImage()` | `--image` | 2 | Updates the user's profile image in DocuSign by uploading a new image file |
| `update-user-profile-information` | `docusign.updateUserProfileInformation()` | `--userId` | 792 | Updates a user's profile in DocuSign, including personal details, privacy settings, and user ID card information |
| `update-user-signature-by-id` | `docusign.updateUserSignatureById()` | `--signatureId` | 20 | Updates or creates a user's signature and initials for a specified DocuSign account |
| `update-workflow-step-for-template` | `docusign.updateWorkflowStepForTemplate()` | `--templateId` `--workflowStepId` | 11 | This endpoint updates a specified workflow step for a DocuSign template |
| `update-workspace-information` | `docusign.updateWorkspaceInformation()` | `--workspaceId` | 70 | Updates information about a specific DocuSign workspace |
| `update-workspace-item-metadata` | `docusign.updateWorkspaceItemMetadata()` | `--fileId` `--folderId` `--workspaceId` | 5 | Updates the metadata for a specific file in a DocuSign workspace |

## Docs

- [run CLI](https://docs.boxd.sh/cli/run): Call connected integrations from the shell, connect new ones, and run automations.
- [Quickstart](https://docs.boxd.sh/guides/integrations/quickstart): Connect an integration, call it from the shell, and turn a script into an automation.
- [Connections](https://docs.boxd.sh/guides/integrations/connections): Connect an account once, for yourself or for your whole organization.
- [Scripts](https://docs.boxd.sh/guides/automations/scripts): Typed integrations, triggers, schedules and state in a .run.ts file.
- [Jobs](https://docs.boxd.sh/guides/automations/jobs): How a script becomes a background job: states, retries, sleep and wake.
- [Beyond the catalog](https://docs.boxd.sh/guides/automations/beyond-the-catalog): Reach your own APIs, databases and cloud accounts from a script.