> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# API
> API reference for DocuSign: every `docusign.api.*` operation with input and output types.
Every `docusign.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.
**New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
## Add Contacts To Contacts List
### addContactsToContactsList
`addContactsToContactsList`
Adds multiple contacts to a user's contacts list in DocuSign. This endpoint allows for bulk addition of contacts with detailed information, including cloud provider details, phone numbers, email addresses, and notary-specific information. It's particularly useful for populating a user's address book
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addContactsToContactsList({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Email Overrides To Envelope
### addEmailOverridesToEnvelope
`addEmailOverridesToEnvelope`
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. This endpoint should be used when you need to change email settings for an individual envelope, overriding
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addEmailOverridesToEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Envelope Attachments
### addEnvelopeAttachments
`addEnvelopeAttachments`
Adds one or more envelope attachments to a draft or in-process envelope in DocuSign. This endpoint allows developers to include additional files with an envelope that are not converted to PDF and are only accessible through the API. It's useful for attaching supporting documents or metadata files th
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addEnvelopeAttachments({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Existing Brand To Group
### addExistingBrandToGroup
`addExistingBrandToGroup`
This endpoint adds one or more existing brands to a specified group in DocuSign. It allows users to associate multiple brands with a group, enabling customized branding for different groups within an account. The endpoint should be used when there's a need to update the brands associated with a part
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addExistingBrandToGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add File To Workspace
### addFileToWorkspace
`addFileToWorkspace`
This endpoint adds a file to a specific folder within a DocuSign workspace. It allows users to upload and organize files in their DocuSign account, enabling better document management and collaboration. The method should be used when integrating file upload functionality with DocuSign workspaces, su
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addFileToWorkspace({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Members To Signing Group
### addMembersToSigningGroup
`addMembersToSigningGroup`
This endpoint adds one or more new members to a specified signing group within a DocuSign account. Signing groups allow multiple users to act as potential signers for a document, where any member of the group can sign on behalf of the group. This tool should be used when you need to expand or update
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addMembersToSigningGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signingGroupId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add New Users To ASpecified Account
### addNewUsersToASpecifiedAccount
`addNewUsersToASpecifiedAccount`
This endpoint adds new users to a specified DocuSign account, allowing bulk creation of up to 500 users in a single call. It's ideal for quickly setting up multiple users with customized permissions and settings. The endpoint requires at least a username and email for each user, but supports additio
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addNewUsersToASpecifiedAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Or Update Account Stamps
### addOrUpdateAccountStamps
`addOrUpdateAccountStamps`
Add or update account-level stamps (Japanese Hanko-style stamps) in DocuSign. Stamps are pre-configured signature images that can be applied to documents. This action supports creating new stamps or updating existing ones by including the signatureId. \*\*Common use cases:\*\* - Create name stamps (
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addOrUpdateAccountStamps({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `decode_only` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Or Update User Custom Settings
### addOrUpdateUserCustomSettings
`addOrUpdateUserCustomSettings`
Adds or updates custom user settings for a specified DocuSign user. This endpoint allows for flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard DocuSign account settings. It supports grouping of settings using the X-DocuSign-User-S
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addOrUpdateUserCustomSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Or Update User Signature
### addOrUpdateUserSignature
`addOrUpdateUserSignature`
This endpoint allows you to add or update a user's signature in DocuSign. It provides comprehensive management of signature properties, including the signature image, font, initials, and stamp details. Use this endpoint when you need to create a new signature for a user or modify an existing one. Th
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addOrUpdateUserSignature({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Part To Chunked Upload
### addPartToChunkedUpload
`addPartToChunkedUpload`
Adds a chunk or part to an existing chunked upload in DocuSign. This endpoint is used for uploading large files in smaller pieces, allowing for documents that exceed standard file size limits. It should be used after initiating a new chunked upload and uploading the first part. The method is particu
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addPartToChunkedUpload({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `chunkedUploadId` | `string` | Yes | — |
| `chunkedUploadPartSeq` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Step To Envelope Workflow
### addStepToEnvelopeWorkflow
`addStepToEnvelopeWorkflow`
This endpoint adds a new step to an existing envelope's workflow in DocuSign. It allows for the configuration of complex workflow rules, including delayed routing, conditional recipients, and specific actions based on envelope status or recipient actions. Use this endpoint when you need to modify an
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addStepToEnvelopeWorkflow({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Templates To Document In Envelope
### addTemplatesToDocumentInEnvelope
`addTemplatesToDocumentInEnvelope`
This endpoint adds pre-configured templates to a specific document within an existing envelope in DocuSign. It allows you to apply standardized content, such as tabs and anchor text, from templates to documents, streamlining the process of preparing documents for signature. Use this when you need to
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addTemplatesToDocumentInEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `preserve_template_recipient` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Templates To Envelope
### addTemplatesToEnvelope
`addTemplatesToEnvelope`
This endpoint adds templates to an existing DocuSign envelope. It's used to apply pre-defined document templates, including content and settings, to standardize workflows. The operation can affect existing recipients based on the 'preserve\_template\_recipient' parameter. It's suitable for adding co
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addTemplatesToEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `preserve_template_recipient` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add User Signature And Initials Images
### addUserSignatureAndInitialsImages
`addUserSignatureAndInitialsImages`
Add or update a user's signature and initials images in DocuSign. This action creates default signature images based on the user's name and a DocuSign font style. When using JSON content type (as this action does), DocuSign automatically generates signature images based on the signatureName and sign
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addUserSignatureAndInitialsImages({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Add Users To Existing Group
### addUsersToExistingGroup
`addUsersToExistingGroup`
Adds one or more existing DocuSign users to an existing group within a specified account. This endpoint is used to manage group memberships by adding users to a predefined group. It requires the account ID and group ID as path parameters, and accepts a list of user information in the request body. T
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.addUsersToExistingGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Apply Action To Bulk Send Envelopes
### applyActionToBulkSendEnvelopes
`applyActionToBulkSendEnvelopes`
This endpoint allows users to apply specific actions (resend, correct, or void) to all envelopes within a specified DocuSign bulk send batch. It's designed for managing large-scale document signing processes efficiently, enabling users to update the status or take action on multiple envelopes simult
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.applyActionToBulkSendEnvelopes({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendBatchId` | `string` | Yes | — |
| `bulkAction` | `resend \| correct \| void` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Change Users In Account
### changeUsersInAccount
`changeUsersInAccount`
This endpoint allows you to update information for one or more users within a DocuSign account. It is used to modify various user attributes such as personal information, settings, permissions, and notification preferences. The endpoint is particularly useful for account administrators who need to m
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.changeUsersInAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `allow_all_languages` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Close Users In Account
### closeUsersInAccount
`closeUsersInAccount`
Closes one or more users in a DocuSign account, preventing them from accessing account features without permanently deleting them. This endpoint is useful for temporarily disabling user access, such as when an employee is on leave or has changed roles. It allows for easy re-activation of users throu
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.closeUsersInAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `delete` | `string` | No | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
users: {
userId?: string,
userName?: string,
email?: string
}[]
}
```
**Output:** *empty object*
***
## Commit Chunked Upload For Envelopes
### commitChunkedUploadForEnvelopes
`commitChunkedUploadForEnvelopes`
This endpoint commits a chunked upload in DocuSign, finalizing the upload process and preparing the uploaded content for use in other API calls. It should be used after all parts of a large document have been uploaded using the chunked upload method. The endpoint performs integrity checks on the upl
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.commitChunkedUploadForEnvelopes({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `chunkedUploadId` | `string` | Yes | — |
| `action` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Configure Cloud Storage Redirect Url
### configureCloudStorageRedirectUrl
`configureCloudStorageRedirectUrl`
Configures the OAuth redirect URL for one or more cloud storage providers (Box, Dropbox, GoogleDrive, SkyDrive/OneDrive, Salesforce) for a specific user in DocuSign. This action sets up the authentication flow between DocuSign and cloud storage services by specifying where users should be redirected
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.configureCloudStorageRedirectUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Account Custom Field
### createAccountCustomField
`createAccountCustomField`
Creates a new custom field at the account level in DocuSign, making it available for all new envelopes associated with the account. This endpoint enables account administrators to define custom fields for enhanced envelope management and grouping. The created custom field can be of type 'text' or 'l
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createAccountCustomField({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `apply_to_templates` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create ACollaborative Workspace
### createACollaborativeWorkspace
`createACollaborativeWorkspace`
Creates a new collaborative workspace in DocuSign for document management and team collaboration. A workspace provides a centralized area for file sharing and collaborative work on agreements. Use this when setting up a new project or team workspace. The creator becomes the workspace owner automatic
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createACollaborativeWorkspace({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Bcc Email Archive Configuration
### createBccEmailArchiveConfiguration
`createBccEmailArchiveConfiguration`
Creates a BCC email archive configuration for a DocuSign account, enabling automatic archiving of DocuSign-generated emails. This endpoint allows you to set up a BCC email address that will receive copies of all DocuSign notifications for the specified account. It's particularly useful for organizat
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createBccEmailArchiveConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Brand Profiles For Account
### createBrandProfilesForAccount
`createBrandProfilesForAccount`
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. This action allows you to define brand properties such as company name, brand languages, colors for UI elements (buttons, headers), and c
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createBrandProfilesForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Bulk Send Request
### createBulkSendRequest
`createBulkSendRequest`
Initiates a bulk send process in DocuSign to send a single template or envelope to multiple recipients in a single batch operation. This is ideal for large-scale document distribution scenarios such as sending contracts to numerous clients or company-wide notices. \*\*Prerequisites:\*\* 1. Create a
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createBulkSendRequest({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendListId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Bulk Send Test Request
### createBulkSendTestRequest
`createBulkSendTestRequest`
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. It performs comprehensive checks on envelope state, recipients, tabs, and custom fields to ensure a successful bulk send operation. U
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createBulkSendTestRequest({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendListId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Connect Configuration For Account
### createConnectConfigurationForAccount
`createConnectConfigurationForAccount`
This endpoint creates a custom Connect configuration for a specified DocuSign account, enabling webhook notifications for envelope and recipient events. It allows users to set up real-time updates for eSignature workflows without the need for polling. The configuration can be customized for differen
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createConnectConfigurationForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Custom Document Fields In Envelope
### createCustomDocumentFieldsInEnvelope
`createCustomDocumentFieldsInEnvelope`
Creates custom document fields in an existing envelope document within DocuSign. This endpoint allows you to add metadata to specific documents in an envelope, which can be used for tracking, sorting, and reporting purposes. It's particularly useful when you need to associate additional information
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createCustomDocumentFieldsInEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Custom Fields For Envelope
### createCustomFieldsForEnvelope
`createCustomFieldsForEnvelope`
This endpoint allows you to create or update custom fields for a specific DocuSign envelope. It is used to add or modify additional metadata to envelopes, which can be utilized for sorting, organizing, searching, and other downstream processes. The endpoint supports both list-type custom fields (wit
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createCustomFieldsForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Custom Fields In Template Document
### createCustomFieldsInTemplateDocument
`createCustomFieldsInTemplateDocument`
Creates custom document fields in an existing template document within DocuSign. This endpoint allows users to add metadata to specific documents in a template, enhancing document management and workflow customization. It is particularly useful for prepopulating custom data fields that will be appli
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createCustomFieldsInTemplateDocument({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
documentFields: {
name?: string,
value?: string
}[]
}
```
**Output:** *empty object*
***
## Create Custom Tab With Properties
### createCustomTabWithProperties
`createCustomTabWithProperties`
Creates a custom tab with pre-defined properties for use in DocuSign envelopes. This endpoint allows users to define reusable tab types with specific configurations such as font styles, validation patterns, and positioning rules. Custom tabs can be created for various field types including text, che
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createCustomTabWithProperties({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Document Responsive Html Preview
### createDocumentResponsiveHtmlPreview
`createDocumentResponsiveHtmlPreview`
Creates a responsive HTML preview for a specific document in an envelope. Generates a mobile-friendly preview showing how the document renders on different devices. Useful for testing smart sections, collapsible content, and responsive tables before sending. \*\*Requirements:\*\* Envelope and docume
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createDocumentResponsiveHtmlPreview({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Envelope
### createEnvelope
`createEnvelope`
Creates a signing envelope from a pre-existing DocuSign template.
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | No | — |
| `emailSubject` | `string` | Yes | — |
| `status` | `sent \| created` | Yes | — |
| `templateRoles` | `object[]` | No | — |
| `documents` | `object[]` | No | — |
| `recipients` | `object` | No | — |
```ts theme={null}
{
email: string,
name: string,
roleName: string
}[]
```
```ts theme={null}
{
documentId: string,
name: string,
fileExtension?: string,
documentBase64?: string
}[]
```
```ts theme={null}
{
signers?: {
email: string,
name: string,
recipientId: string,
routingOrder?: string
}[]
}
```
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `status` | `string` | Yes | — |
| `statusDateTime` | `string` | No | — |
| `uri` | `string` | No | — |
***
## Create Groups For Account
### createGroupsForAccount
`createGroupsForAccount`
Creates one or more groups for a specified DocuSign account. This endpoint is used for managing user access and permissions by organizing users into groups. Groups can be associated with permission profiles to streamline user management for large numbers of users. The endpoint accepts an array of gr
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createGroupsForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Idproof Resource Token For Recipient
### createIdproofResourceTokenForRecipient
`createIdproofResourceTokenForRecipient`
Generates a 2-minute resource token to access recipient identity verification data via DocuSign's ID Evidence API. \*\*Requirements:\*\* Recipient must have completed identity verification (phone auth, ID scan, etc.) during envelope signing. Fails if envelope is draft or verification incomplete. \*\\
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createIdproofResourceTokenForRecipient({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `token_scopes` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create New Account Permission Profile
### createNewAccountPermissionProfile
`createNewAccountPermissionProfile`
This endpoint creates a new permission profile for a DocuSign account, defining specific sets of permissions for user groups. It allows administrators to establish role-based access control within their DocuSign environment. The profile controls a wide range of user capabilities, from basic envelope
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createNewAccountPermissionProfile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Notary Jurisdiction Object
### createNotaryJurisdictionObject
`createNotaryJurisdictionObject`
Registers a notary jurisdiction for the current DocuSign user, enabling electronic notarizations for a specific U.S. state. A user can only have ONE jurisdiction at a time. Required fields: commissionExpiration (MM/DD/YYYY format), commissionId, registeredName, sealType, and jurisdiction details (ju
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createNotaryJurisdictionObject({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Or Update User Authorizations
### createOrUpdateUserAuthorizations
`createOrUpdateUserAuthorizations`
Creates or updates user authorizations in DocuSign, allowing an agent user to perform actions on behalf of a principal user. Grants permissions like Send, Manage, Sign, or Edit. Requirements: principal must be authenticated user or caller must be admin; agent users must be active; principal and agen
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createOrUpdateUserAuthorizations({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Preview Of Responsive Html
### createPreviewOfResponsiveHtml
`createPreviewOfResponsiveHtml`
Creates a preview of the responsive HTML version of a specific template document in DocuSign. This endpoint allows users to visualize how a PDF document will be converted to responsive HTML across various device types before sending it for signing. It's particularly useful for ensuring that template
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createPreviewOfResponsiveHtml({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Preview Of Responsive Html In Envelope
### createPreviewOfResponsiveHtmlInEnvelope
`createPreviewOfResponsiveHtmlInEnvelope`
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 sending. This endpoint is particularly useful for ensuring document compatibility and readability on vario
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createPreviewOfResponsiveHtmlInEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Recipient Manual Review Link
### createRecipientManualReviewLink
`createRecipientManualReviewLink`
Creates a URL for manually reviewing a recipient's identity in DocuSign. This endpoint is used when automatic identity verification has failed and manual review is required. It returns a URL that allows the sender to access a page for manually verifying the recipient's ID. This method should only be
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createRecipientManualReviewLink({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Recipient Preview For Envelope
### createRecipientPreviewForEnvelope
`createRecipientPreviewForEnvelope`
Creates a URL for previewing the recipient's view of a draft envelope or template. This endpoint allows senders to simulate the recipient's experience by generating an embeddable preview URL. It's useful for verifying the appearance and functionality of an envelope before sending it to recipients. T
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createRecipientPreviewForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Recipient View Url
### createRecipientViewUrl
`createRecipientViewUrl`
Generates a recipient view URL for embedded signing or viewing.
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createRecipientViewUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `userName` | `string` | Yes | — |
| `email` | `string` | Yes | — |
| `returnUrl` | `string` | Yes | — |
| `authenticationMethod` | `string` | No | — |
| `recipientId` | `string` | Yes | — |
| `clientUserId` | `string` | No | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | No | — |
***
## Create Sender View Url For Envelope
### createSenderViewUrlForEnvelope
`createSenderViewUrlForEnvelope`
Creates a URL for the sender view of a DocuSign envelope, enabling the embedding of DocuSign UI within an external application. This endpoint is crucial for integrating envelope sending functionality, allowing users to prepare and send envelopes directly from your application. The returned URL provi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createSenderViewUrlForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Signing Group
### createSigningGroup
`createSigningGroup`
Creates one or more signing groups in a DocuSign account. This endpoint allows account administrators to set up predefined groups of recipients for document signing. Multiple signing groups can be created in a single API call, enhancing efficiency in setting up complex signing workflows. Use this wh
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createSigningGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Template Document Custom Fields
### createTemplateDocumentCustomFields
`createTemplateDocumentCustomFields`
Creates custom fields on a DocuSign template to capture additional metadata. Custom fields allow you to: - Add dropdown lists (listCustomFields) where senders select from predefined options - Add text fields (textCustomFields) where senders enter free-form text - Set default values and mark fields a
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createTemplateDocumentCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Template Recipient Preview Url
### createTemplateRecipientPreviewUrl
`createTemplateRecipientPreviewUrl`
Generate a preview URL showing how a template will appear to recipients. This action creates an embeddable URL that displays a template from the recipient's perspective, allowing senders to verify the signing experience before sending the actual document. This is particularly useful for: - Previewin
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createTemplateRecipientPreviewUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Template Responsive Html Preview
### createTemplateResponsiveHtmlPreview
`createTemplateResponsiveHtmlPreview`
Creates a preview of the responsive HTML versions of all documents associated with a DocuSign template. This endpoint enables users to generate and customize the HTML preview of PDF documents across various device types before sending them for signing. It is particularly useful for ensuring that doc
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createTemplateResponsiveHtmlPreview({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Template Workflow Step
### createTemplateWorkflowStep
`createTemplateWorkflowStep`
Adds a new workflow step to an existing DocuSign template. This action enables sophisticated document routing automation within templates, including: - Pausing workflows before specific routing steps - Implementing delayed sending with scheduled resume dates - Setting up conditional recipient routin
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createTemplateWorkflowStep({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create Urlfor Template Edit View
### createUrlforTemplateEditView
`createUrlforTemplateEditView`
Creates a URL for embedding the DocuSign Template Edit view within an application. This endpoint enables developers to integrate DocuSign's template creation and editing functionality directly into their applications, allowing users to manage templates without leaving the app environment. The genera
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createUrlforTemplateEditView({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Create User Authorization For Agent User
### createUserAuthorizationForAgentUser
`createUserAuthorizationForAgentUser`
Creates a user authorization in DocuSign, enabling an agent user to perform specific actions on behalf of a principal user within the same account. This endpoint is essential for setting up delegated access, allowing users to share envelope management, signing, or sending capabilities. It's particul
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.createUserAuthorizationForAgentUser({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Delete Account Brand
### deleteAccountBrand
`deleteAccountBrand`
This endpoint deletes a specific brand from a DocuSign account. It should be used when you need to permanently remove a brand configuration from an account, such as when a brand is no longer needed or has been replaced. The operation requires that branding for either signing or sending (or both) is
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteAccountBrand({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Account Custom Field
### deleteAccountCustomField
`deleteAccountCustomField`
Deletes an existing account custom field from a DocuSign account. This endpoint should be used when you need to remove a custom field that is no longer required or relevant for your account. It permanently removes the custom field, so use with caution. The deletion can optionally be applied to templ
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteAccountCustomField({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `customFieldId` | `string` | Yes | — |
| `apply_to_templates` | `string` | No | — |
**Output:** *empty object*
***
## Delete Account Permission Profile
### deleteAccountPermissionProfile
`deleteAccountPermissionProfile`
This endpoint deletes a specific permission profile from a DocuSign account. It is used to remove outdated or unnecessary permission profiles, helping to streamline account management. The endpoint requires that the profile being deleted has no associated users, unless they are being reassigned to a
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteAccountPermissionProfile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `permissionProfileId` | `string` | Yes | — |
| `move_users_to` | `string` | No | — |
**Output:** *empty object*
***
## Delete Account Stamp
### deleteAccountStamp
`deleteAccountStamp`
Deletes a specific account stamp (signature) from a DocuSign account. This endpoint should be used when you need to permanently remove a stamp from an account, such as when it's no longer needed or has been replaced. The operation is irreversible, so use it with caution. It's particularly useful for
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteAccountStamp({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signatureId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Bcc Email Archive Configuration
### deleteBccEmailArchiveConfiguration
`deleteBccEmailArchiveConfiguration`
This endpoint deletes a BCC (Blind Carbon Copy) email archive configuration from a specified DocuSign account. When invoked, it changes the status of the targeted configuration to 'closed' and immediately stops the archiving of DocuSign-generated email messages to the associated BCC email address. T
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteBccEmailArchiveConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bccEmailArchiveId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Brand From Group
### deleteBrandFromGroup
`deleteBrandFromGroup`
This endpoint allows users to delete one or more brands from a specified group within a DocuSign account. It is used to manage brand associations with groups, enabling customization of branding for different envelopes and signing experiences. The operation removes the specified brands from the group
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteBrandFromGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Brand Logo By Type
### deleteBrandLogoByType
`deleteBrandLogoByType`
This endpoint deletes a specific logo from an account brand in DocuSign. It allows users to remove primary, secondary, or email logos associated with their brand, helping maintain brand consistency across DocuSign documents. The endpoint should be used when updating or removing branding elements fro
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteBrandLogoByType({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
| `logoType` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Brand Profiles
### deleteBrandProfiles
`deleteBrandProfiles`
This endpoint allows you to delete one or more brand profiles from a DocuSign account. It is used to remove custom branding configurations that are no longer needed. The method requires either the 'canSelfBrandSign' or 'canSelfBrandSend' setting to be enabled for the account. It's important to note
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteBrandProfiles({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Chunked Upload
### deleteChunkedUpload
`deleteChunkedUpload`
Deletes a chunked upload that has been committed but not yet consumed in the DocuSign system. This endpoint is useful for managing large file uploads and maintaining quota efficiency. It should be used when a chunked upload is no longer needed and hasn't been used in other API calls. The endpoint ca
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteChunkedUpload({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `chunkedUploadId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Connect Configuration
### deleteConnectConfiguration
`deleteConnectConfiguration`
Deletes a specified DocuSign Connect configuration from the given account. This endpoint should be used when you need to remove an existing Connect integration setup. It requires account administrator privileges and that Connect is enabled on the account. The operation is irreversible, so use with c
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteConnectConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `connectId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Connect Failure Log Entry
### deleteConnectFailureLogEntry
`deleteConnectFailureLogEntry`
Deletes one or all Connect failure log entries for a specified DocuSign account. This endpoint is used for maintenance and cleanup of Connect integration logs, allowing account administrators to remove specific failure records or clear all failure logs. It should be used when troubleshooting Connect
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteConnectFailureLogEntry({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `failureId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Connect Log Entries
### deleteConnectLogEntries
`deleteConnectLogEntries`
Deletes Connect log entries for a DocuSign account. This endpoint allows account administrators to manage and clean up Connect event logs, which record webhook delivery attempts and outcomes. \*\*Use Case:\*\* Remove Connect log entries for data management, privacy compliance, or housekeeping purpos
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteConnectLogEntries({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Connect Oauth Configuration
### deleteConnectOauthConfiguration
`deleteConnectOauthConfiguration`
Deletes the Connect OAuth configuration for a specified DocuSign account. This endpoint is used to remove the OAuth settings that allow DocuSign Connect to securely integrate with other applications and send webhook notifications. It should be used when you need to disable or reconfigure the Connect
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteConnectOauthConfiguration({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Contact From Account
### deleteContactFromAccount
`deleteContactFromAccount`
Deletes a specific contact from a DocuSign account. This endpoint should be used when you need to remove a contact's information from an account's address book. It requires both the account ID and the specific contact ID to be provided. Upon successful deletion, it returns an updated list of contact
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteContactFromAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `contactId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Custom Document Fields
### deleteCustomDocumentFields
`deleteCustomDocumentFields`
Deletes custom document fields from an existing envelope document in DocuSign. This endpoint allows you to remove specific metadata or custom data strings associated with a document within an envelope. It's useful for updating or cleaning up custom information that is no longer relevant or needed. T
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteCustomDocumentFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Custom Document Fields From Template
### deleteCustomDocumentFieldsFromTemplate
`deleteCustomDocumentFieldsFromTemplate`
Deletes specified custom document fields from an existing template document in DocuSign. This endpoint is useful for maintaining and updating templates by removing unnecessary or outdated custom fields. It should be used when you need to clean up or modify the structure of a template document. The o
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteCustomDocumentFieldsFromTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Custom Fields In Template
### deleteCustomFieldsInTemplate
`deleteCustomFieldsInTemplate`
Deletes specified custom fields from a DocuSign template. This action removes envelope-level custom fields (both list and text types) that are no longer needed. \*\*How it works:\*\* - Specify which custom fields to delete by providing their fieldId values - You can delete multiple list and/or text
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteCustomFieldsInTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Delete Custom Tab Information
### deleteCustomTabInformation
`deleteCustomTabInformation`
Deletes a specified custom tab from a DocuSign account. This endpoint should be used when you need to remove a custom tab that is no longer needed or is obsolete. It permanently removes the custom tab from the account, so it should be used with caution. The operation requires both the account ID and
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteCustomTabInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `customTabId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Custom User Settings
### deleteCustomUserSettings
`deleteCustomUserSettings`
Deletes specified custom user settings for a DocuSign user by their names. Custom user settings allow flexible storage and retrieval of user-specific information within DocuSign (separate from standard account settings). This endpoint removes one or more custom settings by specifying their names in
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteCustomUserSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Delayed Routing Rule For Envelope Step
### deleteDelayedRoutingRuleForEnvelopeStep
`deleteDelayedRoutingRuleForEnvelopeStep`
This endpoint deletes the delayed routing object for a specific envelope's workflow step in DocuSign. It allows users to remove scheduled delays in the routing process of an envelope. The endpoint should be used when you need to cancel a planned delay in the envelope's workflow, but it cannot be cal
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteDelayedRoutingRuleForEnvelopeStep({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Delayed Routing Rules For Template
### deleteDelayedRoutingRulesForTemplate
`deleteDelayedRoutingRulesForTemplate`
Deletes the delayed routing rules for a specific template workflow step in DocuSign. This endpoint should be used when you need to remove timing or conditional routing logic from a template, allowing for immediate progression to the next step in the workflow. It's particularly useful when updating o
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteDelayedRoutingRulesForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Draft Envelope Attachments
### deleteDraftEnvelopeAttachments
`deleteDraftEnvelopeAttachments`
Deletes one or more envelope attachments from a draft envelope in DocuSign. This endpoint allows users to remove attachments that are no longer needed or were added in error before the envelope is sent. It's important to note that this operation only works on draft envelopes and is distinct from man
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteDraftEnvelopeAttachments({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
attachments: {
attachmentId: string
}[]
}
```
**Output:** *empty object*
***
## Delete Enote Configuration
### deleteEnoteConfiguration
`deleteEnoteConfiguration`
Deletes an existing eNote configuration associated with a specific DocuSign account. This endpoint is part of the ENoteConfigurations API and is currently in beta status. It should be used when you need to remove an eNote configuration that is no longer needed or is incorrect. The operation is irrev
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnoteConfiguration({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Envelope Custom Fields
### deleteEnvelopeCustomFields
`deleteEnvelopeCustomFields`
This endpoint deletes envelope custom fields for draft and in-process envelopes in DocuSign. It allows users to remove both list custom fields (predefined options) and text custom fields (free-form text) associated with a specific envelope. The operation requires the account ID and envelope ID to id
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Envelope Email Settings
### deleteEnvelopeEmailSettings
`deleteEnvelopeEmailSettings`
Deletes all existing email override settings for a specific envelope in DocuSign. This endpoint reverts the envelope's email configuration back to the account's default settings, affecting only future email communications. It's useful when you need to remove customized email settings for an envelope
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeEmailSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Envelope Lock
### deleteEnvelopeLock
`deleteEnvelopeLock`
Deletes the lock from a specified envelope, allowing it to be modified again. \*\*Important Requirements:\*\* - Only the user who originally locked the envelope can delete the lock - The lock is automatically released when the lock duration expires - Deleting a lock without the X-DocuSign-Edit heade
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeLock({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `lockToken` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Delete Envelope Scheduled Sending Rules
### deleteEnvelopeScheduledSendingRules
`deleteEnvelopeScheduledSendingRules`
Deletes the scheduled sending rules for a specific envelope's workflow in DocuSign. This endpoint should be used when you need to cancel or remove previously set rules for scheduled sending of an envelope. It's particularly useful for managing automated document workflows where timing adjustments ar
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeScheduledSendingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Envelope Transfer Rule
### deleteEnvelopeTransferRule
`deleteEnvelopeTransferRule`
Deletes a specific envelope transfer rule from a DocuSign account. This endpoint allows account administrators to remove previously created rules that automatically transfer ownership of envelopes between users. It should be used when a transfer rule is no longer needed or requires updating. The ope
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeTransferRule({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeTransferRuleId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Envelope Workflow Definition
### deleteEnvelopeWorkflowDefinition
`deleteEnvelopeWorkflowDefinition`
This endpoint deletes the workflow definition for a specified envelope in DocuSign. It's used to remove any scheduled or automated processes associated with the envelope, such as delayed sending or routing. When called, it cancels any scheduled send and resets the envelope status to 'created'. This
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeWorkflowDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Envelope Workflow Step
### deleteEnvelopeWorkflowStep
`deleteEnvelopeWorkflowStep`
Deletes a specific workflow step from an envelope in DocuSign. This endpoint allows you to remove a single step from an envelope's workflow definition, potentially altering the envelope's processing lifecycle. Use this when you need to modify an envelope's workflow by removing unnecessary or outdate
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteEnvelopeWorkflowStep({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Existing Workspace Logically
### deleteExistingWorkspaceLogically
`deleteExistingWorkspaceLogically`
Marks a DocuSign workspace as deleted by changing its status to "status\_deleted". This is a logical deletion that makes the workspace inaccessible to users but preserves the workspace data in the system. The workspace will no longer appear in active workspace lists and users cannot access its files
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteExistingWorkspaceLogically({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Members From Signing Group
### deleteMembersFromSigningGroup
`deleteMembersFromSigningGroup`
Removes one or more members from a specified DocuSign signing group. This endpoint allows you to manage the composition of your signing groups by deleting users who no longer need access. It should be used when you want to remove specific individuals from a signing group, such as when an employee le
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteMembersFromSigningGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signingGroupId` | `string` | Yes | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
users: {
userName?: string,
email?: string
}[]
}
```
**Output:** *empty object*
***
## Delete Multiple Contacts From Account
### deleteMultipleContactsFromAccount
`deleteMultipleContactsFromAccount`
Deletes multiple contacts associated with a specific DocuSign account. This endpoint allows for bulk removal of contacts from an account's address book, streamlining contact management operations. It's particularly useful for cleaning up outdated or unnecessary contacts, or when reorganizing large c
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteMultipleContactsFromAccount({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Notary Jurisdiction
### deleteNotaryJurisdiction
`deleteNotaryJurisdiction`
Deletes a specified notary jurisdiction from the DocuSign system. This endpoint should be used when you need to remove a notary jurisdiction from your DocuSign account, typically when a notary is no longer active in a particular jurisdiction or when correcting erroneously added jurisdictions. The op
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteNotaryJurisdiction({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `jurisdictionId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete One Or More Signing Groups
### deleteOneOrMoreSigningGroups
`deleteOneOrMoreSigningGroups`
Deletes one or more signing groups from a specified DocuSign account. This endpoint allows for bulk deletion of signing groups, which are collections of users authorized to sign documents on behalf of the group. It should be used when you need to remove outdated or unnecessary signing groups from yo
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteOneOrMoreSigningGroups({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
```ts theme={null}
{
groups: {
signingGroupId?: string
}[]
}
```
**Output:** *empty object*
***
## Delete Page From Document In Envelope
### deletePageFromDocumentInEnvelope
`deletePageFromDocumentInEnvelope`
Deletes a specific page from a document within a DocuSign envelope. This endpoint removes a single page from a document based on its page number. The page is permanently deleted and this operation cannot be undone. \*\*Important Requirements:\*\* - The envelope must be in draft status (not yet sent)
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deletePageFromDocumentInEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Page From Template Document
### deletePageFromTemplateDocument
`deletePageFromTemplateDocument`
Deletes a specific page from a document within a DocuSign template. This endpoint allows you to remove a single page from a template document, which can be useful for updating or refining existing templates. Use this when you need to modify the structure of a template by removing unnecessary or outd
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deletePageFromTemplateDocument({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Power Form By Id
### deletePowerFormById
`deletePowerFormById`
This endpoint deletes a specific PowerForm identified by its unique ID within a DocuSign account. PowerForms are pre-configured document templates that can be accessed via a custom URL, allowing for easy collection of signatures and form data. Use this endpoint when you need to permanently remove a
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deletePowerFormById({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `powerFormId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Request Log Files
### deleteRequestLogFiles
`deleteRequestLogFiles`
Deletes all request log files for the authenticated user in DocuSign. This endpoint clears the diagnostic log buffer by removing all current request/response log entries. API request logging in DocuSign captures up to 50 request/response pairs for troubleshooting purposes. Use this action to clear t
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteRequestLogFiles({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Delete Scheduled Sending Rules
### deleteScheduledSendingRules
`deleteScheduledSendingRules`
Deletes all scheduled sending rules associated with a specific DocuSign template's workflow. This endpoint should be used when you need to remove automated sending schedules for a template, reverting it to manual sending only. It's particularly useful for updating or removing outdated scheduling con
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteScheduledSendingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Signature For Captive Recipients
### deleteSignatureForCaptiveRecipients
`deleteSignatureForCaptiveRecipients`
Deletes the signature for one or more captive (embedded) recipients in DocuSign. This endpoint is primarily used for testing and development purposes to reset signatures associated with embedded recipients (identified by clientUserId). After deletion, a new signature can be created the next time the
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteSignatureForCaptiveRecipients({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `recipientPart` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Specific Connect Log Entry
### deleteSpecificConnectLogEntry
`deleteSpecificConnectLogEntry`
Deletes a specified entry or all entries from the DocuSign Connect log for a given account. This endpoint is crucial for managing and cleaning up Connect logs, which contain records of events and updates in eSignature workflows. It should be used when you need to remove specific log entries, perhaps
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteSpecificConnectLogEntry({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `logId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Specified Account
### deleteSpecifiedAccount
`deleteSpecifiedAccount`
Deletes (closes) a specified DocuSign account. This operation permanently closes the account and can only be performed by an account admin. Once an account is closed, it cannot be reopened by users and must be reactivated by DocuSign support. Use this endpoint with caution as it has significant impl
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteSpecifiedAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `redact_user_data` | `string` | No | — |
**Output:** *empty object*
***
## Delete Stamp Image For Account
### deleteStampImageForAccount
`deleteStampImageForAccount`
This endpoint deletes a specific stamp image associated with an account signature in DocuSign. It is used to remove the visual representation of a stamp from a user's account, which can be useful for updating or removing outdated stamps. The endpoint requires the account ID, the type of image being
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteStampImageForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signatureId` | `string` | Yes | — |
| `imageType` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Template From Envelope Document
### deleteTemplateFromEnvelopeDocument
`deleteTemplateFromEnvelopeDocument`
Deletes a template from a document within an envelope. Removes a previously applied template from a specific document. This is useful when: - Replacing one template with another - Reverting a document to its original state - Correcting template application errors ⚠️ This operation is permanent and c
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteTemplateFromEnvelopeDocument({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Template Lock
### deleteTemplateLock
`deleteTemplateLock`
Deletes the lock from a specified DocuSign template, releasing it for editing by others. \*\*Important Requirements:\*\* - The lock token is required to authenticate ownership of the lock - Only the user/application that created the lock can delete it - The lock is automatically released when the lo
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteTemplateLock({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `lockToken` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Delete Template Workflow Step
### deleteTemplateWorkflowStep
`deleteTemplateWorkflowStep`
Deletes a specific workflow step from a template's workflow definition in DocuSign. This endpoint allows users to customize and refine their document workflows by removing individual steps from existing templates. It should be used when modifying the structure of a template's workflow, such as remov
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteTemplateWorkflowStep({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Auth For Cloud Storage Providers
### deleteUserAuthForCloudStorageProviders
`deleteUserAuthForCloudStorageProviders`
This endpoint deletes the user authentication information for one or more cloud storage providers associated with a specific DocuSign user account. It's used to revoke access to connected cloud storage services, requiring the user to re-authenticate the next time they attempt to access these provide
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserAuthForCloudStorageProviders({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `serviceId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Authorization
### deleteUserAuthorization
`deleteUserAuthorization`
Deletes a specific user authorization within the DocuSign system. This endpoint is used to revoke or remove permissions previously granted to a user. It requires either account administrator privileges or being the principal user of the specified authorization. The operation is irreversible, so it s
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserAuthorization({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `authorizationId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Authorizations
### deleteUserAuthorizations
`deleteUserAuthorizations`
The DeleteUserAuthorizations endpoint is used to remove one or more user authorizations for a specified principal user within a DocuSign account. This tool allows account administrators or the principal user themselves to revoke specific permissions or access rights previously granted to the user. I
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserAuthorizations({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Cloud Storage Authentication
### deleteUserCloudStorageAuthentication
`deleteUserCloudStorageAuthentication`
This endpoint deletes the user authentication information for a specified cloud storage provider in DocuSign. It's used to remove the stored credentials that allow a user to access their cloud storage within the DocuSign platform. After deletion, the next time the user attempts to access this cloud
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserCloudStorageAuthentication({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Group
### deleteUserGroup
`deleteUserGroup`
Deletes one or more existing user groups from a specified DocuSign account. This endpoint should be used when you need to remove user groups that are no longer needed or have become obsolete. It requires the account ID and the group ID(s) of the group(s) to be deleted. The operation is irreversible,
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
```ts theme={null}
{
groups: {
groupId?: string
}[]
}
```
**Output:** *empty object*
***
## Delete User Initials Or Signature Image
### deleteUserInitialsOrSignatureImage
`deleteUserInitialsOrSignatureImage`
This endpoint deletes a specified initials image or signature image for a user in DocuSign. It allows users to remove either their initials image or signature image from their DocuSign account. The endpoint should be used when a user wants to update or remove their existing signature or initials ima
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserInitialsOrSignatureImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
| `imageType` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete User Profile Image
### deleteUserProfileImage
`deleteUserProfileImage`
Deletes the profile image of a specified user within a DocuSign account. This endpoint should be used when a user wants to remove their current profile picture from their DocuSign account. It's important to note that this operation can only be performed by the user on their own profile; even users w
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUserProfileImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Users From Group
### deleteUsersFromGroup
`deleteUsersFromGroup`
Deletes one or more users from a specified group within a DocuSign account. This endpoint allows for bulk removal of users from a group, streamlining group management operations. It requires the account ID, group ID, and a list of users to be deleted. The endpoint is useful for maintaining group mem
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteUsersFromGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
users: {
userId?: string,
userName?: string,
email?: string
}[]
}
```
**Output:** *empty object*
***
## Delete Workflow Definition For Template
### deleteWorkflowDefinitionForTemplate
`deleteWorkflowDefinitionForTemplate`
Deletes the workflow definition associated with a specific template in DocuSign. This endpoint is used to remove any existing workflow settings from a template, such as scheduled sending or delayed routing. It's particularly useful when you need to reset a template's workflow or prepare it for new w
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteWorkflowDefinitionForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Delete Workspace Files Or Folders
### deleteWorkspaceFilesOrFolders
`deleteWorkspaceFilesOrFolders`
This endpoint allows for the deletion of one or more files or sub-folders from a DocuSign workspace folder or root. It's used to remove unwanted or obsolete items from a workspace, helping to maintain organization and manage storage. The operation can handle bulk deletions, making it efficient for c
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.deleteWorkspaceFilesOrFolders({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
**Output:** *empty object*
***
## Deprecated Endpoint For Tab Blob
### deprecatedEndpointForTabBlob
`deprecatedEndpointForTabBlob`
This deprecated endpoint is used to update tab-related data (tab blobs) within a specific envelope in a DocuSign account. It is important to note that this endpoint should not be used in new integrations or applications due to its deprecated status. The endpoint requires both an account identifier a
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.deprecatedEndpointForTabBlob({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Export Brand To Xmlfile
### exportBrandToXmlfile
`exportBrandToXmlfile`
Exports a DocuSign brand's configuration as an XML string. Use this action to retrieve comprehensive brand data including brand ID, name, company name, color scheme (background/text colors), logos (Base64-encoded), language settings, and custom links/landing pages. The XML format makes it suitable f
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.exportBrandToXmlfile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
**Output:** `string`
***
## Fetch Recipient Names For Email
### fetchRecipientNamesForEmail
`fetchRecipientNamesForEmail`
Retrieves the names associated with an email address from all recipient types on an envelope.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.fetchRecipientNamesForEmail({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `email` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |
| `names` | `string[]` | Yes | — |
| `count` | `number` | Yes | — |
***
## Generate Edit View Urlfor Envelope
### generateEditViewUrlforEnvelope
`generateEditViewUrlforEnvelope`
Generates a URL for accessing and editing an existing envelope within the DocuSign UI, allowing for embedded editing functionality in external applications. This endpoint is identical to the createSender endpoint and is recommended to be replaced by it. The generated URL provides a customizable view
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.generateEditViewUrlforEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Generate Envelope Correction Url
### generateEnvelopeCorrectionUrl
`generateEnvelopeCorrectionUrl`
Generates a URL that allows embedding the envelope correction view of the DocuSign UI within an application. This endpoint enables customization of the correction view appearance and functionality through query parameters. The returned URL provides temporary, one-time access to the envelope correcti
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.generateEnvelopeCorrectionUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Generate Recipient Shared View Url
### generateRecipientSharedViewUrl
`generateRecipientSharedViewUrl`
Generates a URL for embedding the DocuSign recipient view of a shared envelope in your application. IMPORTANT: This endpoint requires the envelope to be explicitly shared with users on the same DocuSign account. The envelope must be shared first using DocuSign's envelope sharing feature. Required: e
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.generateRecipientSharedViewUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Get Account Billing Charges List
### getAccountBillingChargesList
`getAccountBillingChargesList`
Retrieves a detailed list of recurring and usage charges for a specified DocuSign account. This endpoint provides comprehensive information about the account's billing structure, including charge names, types, pricing, and usage quantities for various DocuSign services. It's particularly useful for
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getAccountBillingChargesList({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include_charges` | `string` | No | — |
**Output:** *empty object*
***
## Get Account Password Rules
### getAccountPasswordRules
`getAccountPasswordRules`
Retrieves the current password rules and security settings for a specified DocuSign account. This endpoint provides detailed information about password expiration policies, lockout durations, password strength requirements, and security question configurations. It is useful for account administrator
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getAccountPasswordRules({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Account Stamp Image
### getAccountStampImage
`getAccountStampImage`
Retrieves the image file for a specific account stamp, signature, or initials in DocuSign. This endpoint allows users to obtain the visual representation of stamps or signatures associated with their DocuSign account. It's particularly useful when you need to display or embed these images in other d
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getAccountStampImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signatureId` | `string` | Yes | — |
| `imageType` | `string` | Yes | — |
| `include_chrome` | `string` | No | — |
**Output:** `string`
***
## Get Agent User Authorizations
### getAgentUserAuthorizations
`getAgentUserAuthorizations`
Returns the authorizations for which the specified user is the agent user. An agent user can act on behalf of other users (principal users) in the account. This endpoint retrieves the list of principal users and their authorization details, including permissions like Send, Manage, Sign, and Edit. Su
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getAgentUserAuthorizations({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `active_only` | `string` | No | — |
| `count` | `string` | No | — |
| `email_substring` | `string` | No | — |
| `include_closed_users` | `string` | No | — |
| `permissions` | `string` | No | — |
| `start_position` | `string` | No | — |
| `task_source` | `string` | No | — |
| `task_type` | `string` | No | — |
| `user_name_substring` | `string` | No | — |
**Output:** *empty object*
***
## Get Bcc Email Archive Configurations
### getBccEmailArchiveConfigurations
`getBccEmailArchiveConfigurations`
Retrieves a list of BCC (Blind Carbon Copy) email archive configurations associated with a specified DocuSign account. This endpoint allows users to fetch details about email addresses used for archiving DocuSign-generated emails. It supports pagination for large result sets and provides comprehensi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBccEmailArchiveConfigurations({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get Bccemail Archive History
### getBccemailArchiveHistory
`getBccemailArchiveHistory`
Retrieves the history of changes made to a specific BCC email archive configuration for a DocuSign account. This endpoint allows users to track modifications, including creation, updates, and closure of email addresses used for archiving DocuSign-generated emails. It provides detailed information ab
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBccemailArchiveHistory({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bccEmailArchiveId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get Brand Logo By Type
### getBrandLogoByType
`getBrandLogoByType`
Retrieves a specific logo used in a brand for a DocuSign account. This endpoint allows you to fetch the image file for a primary, secondary, or email logo associated with a particular brand in your DocuSign account. It's useful for maintaining consistent branding across DocuSign documents and commun
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBrandLogoByType({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
| `logoType` | `string` | Yes | — |
**Output:** `string`
***
## Get Brands Information For Group
### getBrandsInformationForGroup
`getBrandsInformationForGroup`
Retrieves detailed brand information associated with a specific group within a DocuSign account. This endpoint provides a comprehensive view of the brand settings, including default brands for recipients and senders, as well as a list of all available brands with their properties. It's particularly
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBrandsInformationForGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Bulk Send Batch Status
### getBulkSendBatchStatus
`getBulkSendBatchStatus`
Get the status and progress of a DocuSign bulk send batch operation. This action retrieves comprehensive status information for a bulk send batch, including counts of sent, queued, and failed envelopes. Use this to monitor the progress of large-scale document distribution operations. \*\*Key Respons
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBulkSendBatchStatus({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendBatchId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Bulk Send Lists Information
### getBulkSendListsInformation
`getBulkSendListsInformation`
Retrieves a list of Bulk Send Lists belonging to the current user in a specified DocuSign account. This endpoint provides basic information about each Bulk Send List, including its unique identifier, creator, creation date, and name. It is particularly useful for managing and tracking bulk send oper
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getBulkSendListsInformation({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Docusign Account Contacts
### getDocusignAccountContacts
`getDocusignAccountContacts`
Retrieves detailed information about a specific contact from a DocuSign account's address book. Use this action when you need to look up a contact's details including their name, email addresses, phone numbers, organization, notary certifications, and signing group associations. Requires the contact
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getDocusignAccountContacts({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `contactId` | `string` | Yes | — |
| `cloud_provider` | `string` | No | — |
**Output:** *empty object*
***
## Get Downgrade Plan Info For Account
### getDowngradePlanInfoForAccount
`getDowngradePlanInfoForAccount`
Retrieves detailed billing information related to a downgrade request for a specific DocuSign account. This endpoint provides essential data about the requested downgrade plan, including the new plan details, payment method, effective date, and current status of the downgrade request. It should be u
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getDowngradePlanInfoForAccount({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Electronic Disclosure For Recipient
### getElectronicDisclosureForRecipient
`getElectronicDisclosureForRecipient`
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for a specific envelope recipient in DocuSign. This endpoint allows you to obtain the customized disclosure that may differ from the account-level disclosure based on the signing brand applied to the envelope and the reci
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getElectronicDisclosureForRecipient({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `langCode` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Electronic Record And Signature Disclosure
### getElectronicRecordAndSignatureDisclosure
`getElectronicRecordAndSignatureDisclosure`
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with a specific DocuSign account. This endpoint allows you to fetch the current version of the ERSD, which is crucial for obtaining a consumer's consent to receive notices and disclosures electronically. It sup
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getElectronicRecordAndSignatureDisclosure({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `langCode` | `string` | No | — |
**Output:** *empty object*
***
## Get Enote Integration Settings
### getEnoteIntegrationSettings
`getEnoteIntegrationSettings`
Retrieves the eNote integration settings for a specified DocuSign account. This endpoint provides crucial information about the eNote configuration status, Connect configuration status, and necessary credentials for eNote functionality. It should be used when setting up or verifying the eNote integr
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnoteIntegrationSettings({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Envelope
### getEnvelope
`getEnvelope`
Gets the status and basic information about an envelope from DocuSign.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | No | — |
| `status` | `string` | No | — |
***
## Get Envelope Doc Gen Form Fields
### getEnvelopeDocGenFormFields
`getEnvelopeDocGenFormFields`
Retrieves document generation form fields from an envelope's documents. DocGen form fields are placeholder fields (tags) in template documents that can be dynamically populated with data before sending. This action returns the list of available form fields including their names, types, validation ru
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeDocGenFormFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Envelope Document Fields
### getEnvelopeDocumentFields
`getEnvelopeDocumentFields`
Retrieves custom document fields from a specific document within a DocuSign envelope. Custom document fields are metadata key-value pairs attached to individual documents in an envelope. They are different from: - Envelope custom fields (which apply to the entire envelope) - Tabs/fields (which are f
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeDocumentFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Envelope Lock Information
### getEnvelopeLockInformation
`getEnvelopeLockInformation`
Retrieves general information about an envelope lock in DocuSign. This endpoint is used to obtain details about the lock on a specific envelope, including the lock token, duration, owner, and expiration time. It's particularly useful for recovering lock information when managing concurrent access to
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeLockInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Envelope Notification Defaults
### getEnvelopeNotificationDefaults
`getEnvelopeNotificationDefaults`
Retrieves the default email notification settings for envelopes at the account level. This endpoint returns account-wide defaults for envelope notifications including: - Reminder settings (frequency, email subject/body for reminders) - Expiration settings (days until expiration, warning days) - Deli
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeNotificationDefaults({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Envelope Workflow Definition
### getEnvelopeWorkflowDefinition
`getEnvelopeWorkflowDefinition`
Retrieves the workflow definition for a specified envelope in DocuSign. This endpoint provides detailed information about the envelope's workflow steps, scheduled sending settings, and delayed routing configurations. It is useful for developers who need to understand or analyze the current state and
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeWorkflowDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Envelope Workflow Delayed Routing Definition
### getEnvelopeWorkflowDelayedRoutingDefinition
`getEnvelopeWorkflowDelayedRoutingDefinition`
Retrieves the delayed routing rules for a specific workflow step within a DocuSign envelope. This endpoint allows users to access information about when and how an envelope is scheduled to be sent to recipients associated with a particular workflow step. It's useful for checking the current delay se
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getEnvelopeWorkflowDelayedRoutingDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Groups Information For Account
### getGroupsInformationForAccount
`getGroupsInformationForAccount`
Retrieves detailed information about groups associated with a specific DocuSign account. This endpoint allows users to fetch a list of groups, including their IDs, names, types, and user counts. It's particularly useful for account administrators who need to manage user access, set permissions, or o
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getGroupsInformationForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `string` | No | — |
| `group_type` | `string` | No | — |
| `include_usercount` | `string` | No | — |
| `search_text` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get List Of Account Permission Profiles
### getListOfAccountPermissionProfiles
`getListOfAccountPermissionProfiles`
This endpoint retrieves a comprehensive list of permission profiles associated with a specified DocuSign account. It provides detailed information about each profile, including its unique identifier, name, last modification timestamp, and an extensive set of permission settings. This tool is essenti
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getListOfAccountPermissionProfiles({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include` | `string` | No | — |
**Output:** *empty object*
***
## Get Members Of ASigning Group
### getMembersOfASigningGroup
`getMembersOfASigningGroup`
Retrieves the list of members in a specified DocuSign Signing Group. This endpoint provides detailed information about users in a particular Signing Group, including their email addresses and usernames. Use this tool to audit or manage Signing Group composition, which is crucial for maintaining prop
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getMembersOfASigningGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signingGroupId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Notary Journals
### getNotaryJournals
`getNotaryJournals`
Tool to retrieve notary journal entries for the current user. Use when you need to access a user's notary journal records, which contain information about notarized documents including signer names, document names, jurisdictions, and timestamps.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getNotaryJournals({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `string` | No | — |
| `search_text` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get Notary Jurisdiction Object
### getNotaryJurisdictionObject
`getNotaryJurisdictionObject`
Retrieves detailed information about a specific notary jurisdiction for the authenticated user. This endpoint should be used when a notary needs to access information about their registered jurisdiction, including commission details, seal requirements, and jurisdiction-specific rules. It provides cr
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getNotaryJurisdictionObject({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `jurisdictionId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Notary Jurisdiction Seal
### getNotaryJurisdictionSeal
`getNotaryJurisdictionSeal`
Retrieves the notary seal for a specific jurisdiction registered to the current user.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getNotaryJurisdictionSeal({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `jurisdictionId` | `string` | Yes | — |
**Output:** `string`
***
## Get Notary User Settings
### getNotaryUserSettings
`getNotaryUserSettings`
Retrieves notary settings and configuration for the currently authenticated user. This endpoint returns comprehensive notary account information including personal details (name, email, userId), notary status (enabled/disabled), and optionally jurisdiction details when include\_jurisdictions is set
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getNotaryUserSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include_jurisdictions` | `string` | No | — |
**Output:** *empty object*
***
## Get Original Html Definition For Template
### getOriginalHtmlDefinitionForTemplate
`getOriginalHtmlDefinitionForTemplate`
Retrieves the original HTML definition for a specified DocuSign template. This endpoint is used to obtain the properties that define how to generate the responsive-formatted HTML for the template's documents. It provides detailed information about display settings, anchors, and collapsible sections
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getOriginalHtmlDefinitionForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Page Image From Envelope
### getPageImageFromEnvelope
`getPageImageFromEnvelope`
Retrieves an image of a specific page from a document within a DocuSign envelope. This endpoint is used to fetch a visual representation of a document page, which can be useful for previewing or displaying document contents without accessing the full document. The returned image is in PNG format and
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getPageImageFromEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
| `dpi` | `string` | No | — |
| `max_height` | `string` | No | — |
| `max_width` | `string` | No | — |
| `show_changes` | `string` | No | — |
**Output:** `string`
***
## Get Pdftranscript Of Envelope Comments
### getPdftranscriptOfEnvelopeComments
`getPdftranscriptOfEnvelopeComments`
Retrieves a PDF transcript containing all comments added by senders and recipients to documents within a specific envelope in a DocuSign account. This endpoint is useful for obtaining a comprehensive record of all discussions and annotations related to the documents in an envelope. It should be used
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getPdftranscriptOfEnvelopeComments({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `encoding` | `string` | No | — |
**Output:** `string`
***
## Get Permission Profile For Account
### getPermissionProfileForAccount
`getPermissionProfileForAccount`
This endpoint retrieves detailed information about a specific permission profile in a DocuSign account. It provides a comprehensive view of permissions, settings, and capabilities assigned to a profile. Useful for auditing or reviewing permissions granted to user groups, it returns data on account r
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getPermissionProfileForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `permissionProfileId` | `string` | Yes | — |
| `include` | `string` | No | — |
**Output:** *empty object*
***
## Get Power Form Senders
### getPowerFormSenders
`getPowerFormSenders`
Retrieves a list of users who have sent PowerForms within a specified DocuSign account. This endpoint is useful for monitoring PowerForm usage, tracking sender activity, and gathering insights on user engagement with PowerForms. It returns detailed information about each sender, including their acco
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getPowerFormSenders({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get Recipient Document Visibility
### getRecipientDocumentVisibility
`getRecipientDocumentVisibility`
Retrieves document visibility settings for a specific recipient within a DocuSign envelope. This endpoint allows you to check which documents are visible to a particular recipient and their access rights (editable or read-only). Use this method when you need to verify or audit the document access co
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getRecipientDocumentVisibility({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Request Logging Log File
### getRequestLoggingLogFile
`getRequestLoggingLogFile`
Downloads the complete log file for a specific API request from DocuSign's Diagnostics service. This action is essential for debugging and troubleshooting API interactions by providing detailed request/response information. The log file contains: - Full HTTP request details (method, URL, headers, bo
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getRequestLoggingLogFile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `requestLogId` | `string` | Yes | — |
**Output:** `string`
***
## Get Request Logs
### getRequestLogs
`getRequestLogs`
Retrieves a list of API request log entries as a JSON object. Use when you need to view diagnostic information about API requests made to DocuSign.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getRequestLogs({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `encoding` | `string` | No | — |
**Output:** *empty object*
***
## Get Request Log Settings
### getRequestLogSettings
`getRequestLogSettings`
Tool to retrieve current API request logging settings for the authenticated user. Use when you need to check logging configuration or remaining log entries.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getRequestLogSettings({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Resource Information
### getResourceInformation
`getResourceInformation`
Retrieves the base resources available for the DocuSign eSignature REST API. Use when you need to discover available API endpoints and resources.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getResourceInformation({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Service Information
### getServiceInformation
`getServiceInformation`
Gets the current version and other information about the DocuSign eSignature REST API. Use this to retrieve service information including API versions and build details. This returns the available REST API versions (v1, v2, v2.1) with their endpoint URLs, the current build version string, and linked
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getServiceInformation({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Signature Information For Recipient
### getSignatureInformationForRecipient
`getSignatureInformationForRecipient`
Retrieves signature information for a specific recipient in a DocuSign envelope. Returns signature metadata including: signature ID, name, type, initials, adoption and modification timestamps, signature image URI, base64-encoded image data, and stamp properties if applicable. \*\*Use when you need t
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getSignatureInformationForRecipient({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Signing Group Information
### getSigningGroupInformation
`getSigningGroupInformation`
Retrieves detailed information about a specific signing group in a DocuSign account. Returns comprehensive data including the group's name, type (sharedSigningGroup, privateSigningGroup, or systemSigningGroup), email address, creation/modification timestamps, and a complete list of member users with
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getSigningGroupInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signingGroupId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Specific Brand Resource File
### getSpecificBrandResourceFile
`getSpecificBrandResourceFile`
Retrieves a specific branding resource file (XML format) for customizing DocuSign experiences. Brand resource files control text and visual elements for sending, signing, email, and captive signing experiences. IMPORTANT: Resource files must be pre-configured for the brand. This is an advanced featu
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getSpecificBrandResourceFile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
| `resourceContentType` | `string` | Yes | — |
| `langcode` | `string` | No | — |
| `return_master` | `string` | No | — |
**Output:** `string`
***
## Get Specified Account Stamp Info
### getSpecifiedAccountStampInfo
`getSpecifiedAccountStampInfo`
Retrieves detailed information about a specific account stamp (signature) in DocuSign. This endpoint allows users to fetch comprehensive data about a signature, including its creation and modification dates, image URIs, associated users, and formatting details. It's particularly useful when you need
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getSpecifiedAccountStampInfo({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signatureId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Supported Languages For Recipients
### getSupportedLanguagesForRecipients
`getSupportedLanguagesForRecipients`
Retrieves a comprehensive list of supported languages that can be set for individual recipients when creating a DocuSign envelope. This endpoint allows developers to access the available language options for customizing the standard email format and signing view for each recipient. It's particularly
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getSupportedLanguagesForRecipients({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Tabs Blob For Envelope
### getTabsBlobForEnvelope
`getTabsBlobForEnvelope`
This deprecated endpoint retrieves the tabs blob associated with a specific envelope in DocuSign. It allows developers to access detailed information about the tabs (such as signature fields, text fields, etc.) within a document envelope. However, as this endpoint is no longer recommended for use, d
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTabsBlobForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Tab Settings For Account
### getTabSettingsForAccount
`getTabSettingsForAccount`
Retrieves the current tab settings and functionality enabled for a specific DocuSign account. This endpoint provides detailed information about various tab types (such as checkbox, radio, text) and related features (like tab order, data labels, text formatting) that are currently active or inactive
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTabSettingsForAccount({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Template
### getTemplate
`getTemplate`
Gets a template definition from the specified account.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | No | — |
| `name` | `string` | No | — |
***
## Get Template Delayed Routing Rules
### getTemplateDelayedRoutingRules
`getTemplateDelayedRoutingRules`
Retrieves the delayed routing rules for a specific workflow step within a DocuSign template. This endpoint allows users to fetch the scheduled sending and routing information for a particular step in a template's workflow. It's useful for understanding when and how an envelope will be sent to recipi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateDelayedRoutingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Template Document Html Definition
### getTemplateDocumentHtmlDefinition
`getTemplateDocumentHtmlDefinition`
Retrieves the HTML definition for a specific document within a DocuSign template. This endpoint is used to obtain the properties that define how to generate responsive-formatted HTML for the document, including display anchors, collapsible sections, and other formatting settings. It's particularly u
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateDocumentHtmlDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Template Lock Information
### getTemplateLockInformation
`getTemplateLockInformation`
Retrieves lock information for a DocuSign template. Returns details about an existing template lock including the lock token, duration, expiration time, and information about the user who locked the template. The lock token is required in the X-DocuSign-Edit header for subsequent update operations.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateLockInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Template Notification Information
### getTemplateNotificationInformation
`getTemplateNotificationInformation`
Retrieves the envelope notification, reminders, and expiration information for an existing template in DocuSign. This endpoint allows users to get detailed settings about how notifications are configured for envelopes created from the specified template. It provides information on expiration setting
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateNotificationInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Template Recipient Document Visibility
### getTemplateRecipientDocumentVisibility
`getTemplateRecipientDocumentVisibility`
Retrieves document visibility settings for a specific recipient in a DocuSign template. Returns which documents are visible to a recipient and their access rights (view/edit). Document visibility controls show or hide specific documents from recipients in multi-document templates, ensuring sensitive
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateRecipientDocumentVisibility({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Template Scheduled Sending Settings
### getTemplateScheduledSendingSettings
`getTemplateScheduledSendingSettings`
Retrieves the scheduled sending settings for a specified DocuSign template. This endpoint allows developers to access and review the configuration that determines when and how envelopes based on the template will be sent. It's particularly useful for automating document workflows and managing the ti
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplateScheduledSendingSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Templates For Envelope Document
### getTemplatesForEnvelopeDocument
`getTemplatesForEnvelopeDocument`
Retrieves the templates associated with a specific document within a DocuSign envelope. This endpoint is useful for identifying and managing templates linked to individual documents in an envelope, which can be beneficial for template management and document processing workflows. It should be used w
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplatesForEnvelopeDocument({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `include` | `string` | No | — |
**Output:** *empty object*
***
## Get Templates Used In Envelope
### getTemplatesUsedInEnvelope
`getTemplatesUsedInEnvelope`
This endpoint retrieves a list of server-side templates used in a specific DocuSign envelope. It provides detailed information about each template, including its name, ID, and other relevant attributes. The endpoint is particularly useful for understanding which templates have been applied to an env
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getTemplatesUsedInEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `include` | `string` | No | — |
**Output:** *empty object*
***
## Get Unsupported File Types List
### getUnsupportedFileTypesList
`getUnsupportedFileTypesList`
Retrieves the list of file types (extensions and MIME types) that DocuSign does not support for upload. Use this to validate file types before upload or to display supported formats to users. The list may change as DocuSign updates its supported file types.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUnsupportedFileTypesList({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Urlfor Embedding Docusign Ui
### getUrlforEmbeddingDocusignUi
`getUrlforEmbeddingDocusignUi`
Generate a URL to embed the DocuSign console view within your application. This action creates a URL that provides access to the DocuSign web interface, allowing users to interact with DocuSign features directly from your application without leaving your UI. \*\*Use Cases:\*\* - Display DocuSign con
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.getUrlforEmbeddingDocusignUi({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Get User Authorization Details
### getUserAuthorizationDetails
`getUserAuthorizationDetails`
Retrieves detailed information about a specific user authorization in DocuSign. This endpoint allows account administrators or the principal user to fetch comprehensive data about an authorization, including the agent user, principal user, permission levels, and relevant timestamps. It's particularl
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUserAuthorizationDetails({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `authorizationId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get User Authorizations For Principal
### getUserAuthorizationsForPrincipal
`getUserAuthorizationsForPrincipal`
Retrieves user authorizations for a specified principal user within a DocuSign account. This endpoint allows account administrators or the principal user themselves to view and manage user access and permissions. It provides detailed information about each authorization, including the agent user, pe
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUserAuthorizationsForPrincipal({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `active_only` | `string` | No | — |
| `count` | `string` | No | — |
| `email_substring` | `string` | No | — |
| `include_closed_users` | `string` | No | — |
| `permissions` | `string` | No | — |
| `start_position` | `string` | No | — |
| `task_source` | `string` | No | — |
| `task_type` | `string` | No | — |
| `user_name_substring` | `string` | No | — |
**Output:** *empty object*
***
## Get User Cloud Storage Provider Configuration
### getUserCloudStorageProviderConfiguration
`getUserCloudStorageProviderConfiguration`
Retrieves the cloud storage provider configuration for a specific cloud storage service (identified by serviceId) for a user within a DocuSign account. This endpoint returns configuration details for the specified provider, such as service name and serviceId. Note: This endpoint primarily works with
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUserCloudStorageProviderConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `serviceId` | `string` | Yes | — |
| `redirectUrl` | `string` | No | — |
**Output:** *empty object*
***
## Get User Information By Id
### getUserInformationById
`getUserInformationById`
Retrieves detailed information about a specific user within a DocuSign account. This endpoint provides comprehensive data about the user, including personal details, account settings, and permissions. It's useful for account administrators and system integrations needing to verify or sync user confi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUserInformationById({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `additional_info` | `string` | No | — |
| `email` | `string` | No | — |
| `include_license` | `string` | No | — |
**Output:** *empty object*
***
## Get Users In Group
### getUsersInGroup
`getUsersInGroup`
Retrieves a paginated list of users belonging to a specific group within a DocuSign account. This endpoint is useful for managing and auditing group memberships, allowing administrators to view detailed information about users associated with a particular group. It supports pagination to handle larg
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getUsersInGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `groupId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Get Watermark Details For Account
### getWatermarkDetailsForAccount
`getWatermarkDetailsForAccount`
Retrieves and previews the watermark details for a specific DocuSign account. This endpoint allows users to view the current watermark configuration, including its visual properties and enabled status. It's useful for verifying existing watermark settings or preparing to update them. The endpoint re
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getWatermarkDetailsForAccount({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Get Workflow Step For Envelope
### getWorkflowStepForEnvelope
`getWorkflowStepForEnvelope`
Retrieves detailed information about a specific workflow step for a DocuSign envelope. This endpoint allows you to fetch comprehensive data about a single step in an envelope's workflow, including its action, status, delayed routing settings, and recipient routing rules. It's particularly useful whe
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getWorkflowStepForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Get Workspace File
### getWorkspaceFile
`getWorkspaceFile`
Retrieves a binary version of a file from a DocuSign workspace. This endpoint allows you to access and download files stored within a specific workspace, folder, and account. It's particularly useful for retrieving document content for further processing or viewing outside the DocuSign platform. The
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getWorkspaceFile({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `fileId` | `string` | Yes | — |
| `is_download` | `string` | No | — |
| `pdf_version` | `string` | No | — |
**Output:** `string`
***
## Get Workspace Folder Contents
### getWorkspaceFolderContents
`getWorkspaceFolderContents`
Retrieves the contents of a specific workspace folder in DocuSign, including sub-folders and files. This endpoint provides detailed information about the items within the folder, such as metadata, user permissions, and hierarchical structure. It can be used to navigate and explore the contents of a
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.getWorkspaceFolderContents({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `include_files` | `string` | No | — |
| `include_sub_folders` | `string` | No | — |
| `include_thumbnails` | `string` | No | — |
| `include_user_detail` | `string` | No | — |
| `start_position` | `string` | No | — |
| `workspace_user_id` | `string` | No | — |
**Output:** *empty object*
***
## Initiate New Chunked Upload
### initiateNewChunkedUpload
`initiateNewChunkedUpload`
Initiates a new chunked upload in DocuSign by sending the first part of the content. This endpoint is designed to handle large file uploads by breaking them into smaller, manageable pieces. It's particularly useful for adding documents to envelopes in DocuSign's electronic signature workflow. The me
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.initiateNewChunkedUpload({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## List Billing Invoices
### listBillingInvoices
`listBillingInvoices`
Retrieves a list of billing invoices for a specified DocuSign account. This endpoint allows account administrators to fetch detailed invoice information, including total amounts, due dates, and itemized charges. It supports optional date range filtering and provides a paginated response for efficien
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listBillingInvoices({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `from_date` | `string` | No | — |
| `to_date` | `string` | No | — |
**Output:** *empty object*
***
## List Brands For Account
### listBrandsForAccount
`listBrandsForAccount`
Retrieves a comprehensive list of brands associated with a DocuSign account, including default brand profiles. This endpoint provides detailed information about each brand, such as visual elements, language settings, and resource URLs for customizing various DocuSign experiences. It's particularly u
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listBrandsForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `exclude_distributor_brand` | `string` | No | — |
| `include_logos` | `string` | No | — |
**Output:** *empty object*
***
## List Bulk Send Batch Summaries
### listBulkSendBatchSummaries
`listBulkSendBatchSummaries`
Retrieves a summary of bulk send batches for a DocuSign account. This endpoint allows users to query and filter bulk send batch information, providing details such as batch status, size, and processing information. It's particularly useful for monitoring the progress of large-scale document sending
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listBulkSendBatchSummaries({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `batch_ids` | `string` | No | — |
| `count` | `string` | No | — |
| `from_date` | `string` | No | — |
| `search_text` | `string` | No | — |
| `start_position` | `string` | No | — |
| `status` | `string` | No | — |
| `to_date` | `string` | No | — |
| `user_id` | `string` | No | — |
**Output:** *empty object*
***
## List Cloud Storage Items
### listCloudStorageItems
`listCloudStorageItems`
Retrieves a list of items (files and folders) from a specific folder in a cloud storage provider integrated with DocuSign. This endpoint enables browsing and searching cloud storage contents directly within DocuSign, making it easier to select documents for signing workflows. Prerequisites: - The cl
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listCloudStorageItems({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `serviceId` | `string` | Yes | — |
| `cloud_storage_folder_path` | `string` | No | — |
| `count` | `string` | No | — |
| `order` | `string` | No | — |
| `order_by` | `string` | No | — |
| `search_text` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## List Envelope And Document Custom Fields
### listEnvelopeAndDocumentCustomFields
`listEnvelopeAndDocumentCustomFields`
Retrieves all account-level custom fields defined for a DocuSign account. Account custom fields are envelope custom fields that can be applied across multiple envelopes, enabling account administrators to group, track, and manage envelopes consistently. The response includes two types of custom fiel
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listEnvelopeAndDocumentCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## List Envelope Attachments By Envelope Id
### listEnvelopeAttachmentsByEnvelopeId
`listEnvelopeAttachmentsByEnvelopeId`
Retrieves a list of envelope attachments associated with a specified envelope in DocuSign. This endpoint is used to fetch developer-only files attached to an envelope, providing details such as attachment IDs, types, and access controls. It's important to note that this operation returns envelope at
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listEnvelopeAttachmentsByEnvelopeId({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## List Notary Journals
### listNotaryJournals
`listNotaryJournals`
Gets notary journals for the current user. Use when you need to retrieve notary journal data.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listNotaryJournals({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `string` | No | — |
| `search_text` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## List OAuth User Info
### listOAuthUserInfo
`listOAuthUserInfo`
Retrieves the authenticated user's account information from DocuSign OAuth, including user ID, name, email, accounts, base URIs, and account IDs.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listOAuthUserInfo({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `authServer` | `string` | No | — |
**Output:** *empty object*
***
## List Past Due Invoices
### listPastDueInvoices
`listPastDueInvoices`
Retrieves a list of past due invoices for a specified DocuSign account and indicates if payment can be made through the REST API. This endpoint is designed for account administrators to manage outstanding financial obligations. It provides comprehensive invoice details including total amounts, balan
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listPastDueInvoices({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## List Payment Gateway Accounts Info
### listPaymentGatewayAccountsInfo
`listPaymentGatewayAccountsInfo`
Retrieves a list of all payment gateway accounts associated with a specific DocuSign account, along with detailed information about each account. This endpoint is useful for obtaining an overview of the payment gateways configured for an account, including their status, supported currencies, and pay
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listPaymentGatewayAccountsInfo({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## List Registered Notary Jurisdictions
### listRegisteredNotaryJurisdictions
`listRegisteredNotaryJurisdictions`
Retrieves a paginated list of registered notary jurisdictions for the current user, who must be a notary. This endpoint provides detailed information about each jurisdiction where the notary is registered, including commission details, seal settings, and supported features. It is useful for managing
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listRegisteredNotaryJurisdictions({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## List Signature Providers For Account
### listSignatureProvidersForAccount
`listSignatureProvidersForAccount`
Retrieves a list of signature providers available for a specified DocuSign account. This endpoint allows users to obtain detailed information about electronic and digital signature providers, including standards-based signatures, that can be used within the account. It's particularly useful when set
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listSignatureProvidersForAccount({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## List Templates
### listTemplates
`listTemplates`
Gets the definition of templates in the specified account.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listTemplates({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | No | — |
| `startPosition` | `number` | No | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeTemplates` | `object[]` | No | — |
```ts theme={null}
{
}[]
```
***
## List Users For Account
### listUsersForAccount
`listUsersForAccount`
Retrieves a list of users for a specified DocuSign account. This endpoint allows for detailed querying of user information, including their account status, email addresses, and various account settings. It's particularly useful for account administrators who need to manage users or gather informatio
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listUsersForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `additional_info` | `string` | No | — |
| `alternate_admins_only` | `string` | No | — |
| `count` | `string` | No | — |
| `domain_users_only` | `string` | No | — |
| `email` | `string` | No | — |
| `email_substring` | `string` | No | — |
| `group_id` | `string` | No | — |
| `include_license` | `string` | No | — |
| `include_usersettings_for_csv` | `string` | No | — |
| `login_status` | `string` | No | — |
| `not_group_id` | `string` | No | — |
| `start_position` | `string` | No | — |
| `status` | `string` | No | — |
| `user_name_substring` | `string` | No | — |
**Output:** *empty object*
***
## List Workspace File Pages
### listWorkspaceFilePages
`listWorkspaceFilePages`
Retrieves a workspace file as rasterized pages from a DocuSign workspace. This endpoint allows users to fetch file pages as images with customizable resolution and dimensions. It supports pagination for handling large files efficiently. Use this method when you need to view or process workspace file
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listWorkspaceFilePages({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `fileId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `dpi` | `string` | No | — |
| `max_height` | `string` | No | — |
| `max_width` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## List Workspaces
### listWorkspaces
`listWorkspaces`
Retrieves a list of DocuSign workspaces and their associated information for a specified account. This endpoint allows users to get a comprehensive view of all workspaces they have access to, including details such as workspace IDs, names, descriptions, creation dates, and user information. It's par
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.listWorkspaces({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Lock An Envelope For Editing
### lockAnEnvelopeForEditing
`lockAnEnvelopeForEditing`
This endpoint locks an envelope for editing, preventing other users or recipients from changing it. It's used to ensure exclusive access to an envelope during updates. The method returns a lock token that must be included in subsequent PUT requests to modify the locked envelope. Use this endpoint wh
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.lockAnEnvelopeForEditing({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Lock Template For Editing
### lockTemplateForEditing
`lockTemplateForEditing`
Locks a specified DocuSign template for editing to prevent concurrent modifications. This endpoint acquires an exclusive lock on a template, ensuring that only the lock holder can make changes during the lock period. The response includes a lockToken that must be included in the X-DocuSign-Edit head
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.lockTemplateForEditing({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Modify Account Notification Settings
### modifyAccountNotificationSettings
`modifyAccountNotificationSettings`
Updates the default email notification settings for envelope senders and signers in a DocuSign account. This endpoint allows customization of when and what type of notifications users receive regarding envelope status changes (e.g., signed, declined, completed), comments, and other events. Use this
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.modifyAccountNotificationSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Modify Tab Settings For Account
### modifyTabSettingsForAccount
`modifyTabSettingsForAccount`
This endpoint modifies the tab types and tab functionality that are enabled for a DocuSign account. It allows administrators to configure various tab-related settings, such as enabling or disabling specific tab types, controlling tab order, and managing compliance with FDA regulations. The endpoint
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.modifyTabSettingsForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Post Payment To Invoice
### postPaymentToInvoice
`postPaymentToInvoice`
Posts a payment to past due invoices for a DocuSign account. This action applies a payment amount to settle outstanding invoice balances and creates a payment transaction record. Before using this action, retrieve past due invoice information using the 'List Past Due Invoices' action to get the tota
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.postPaymentToInvoice({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Purchase Additional Envelopes
### purchaseAdditionalEnvelopes
`purchaseAdditionalEnvelopes`
This endpoint completes the purchase of additional envelopes for a DocuSign account through an internal workflow interaction with an envelope vendor. It is designed to handle the financial transaction and update the account's envelope quota. This tool should be used when there's a need to increase t
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.purchaseAdditionalEnvelopes({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Queue Downgrade Billing Plan Request
### queueDowngradeBillingPlanRequest
`queueDowngradeBillingPlanRequest`
Queues a downgrade request for a DocuSign account's billing plan. This action initiates the process of changing an account to a lower-tier or less expensive billing plan without immediately applying the change. Use this action when an account administrator needs to: - Downgrade from a paid plan to a
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.queueDowngradeBillingPlanRequest({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Register Current User As Notary
### registerCurrentUserAsNotary
`registerCurrentUserAsNotary`
This endpoint registers the current user as a notary in DocuSign, enabling remote online notarization capabilities. It configures the user's notary profile, settings, and permissions. Use this when setting up a new notary within the DocuSign system. Note that this does not replace legal notary certi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.registerCurrentUserAsNotary({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Remove Bulk Send List
### removeBulkSendList
`removeBulkSendList`
This endpoint deletes a specific bulk send list from a DocuSign account. It is used to permanently remove a bulk send list that is no longer needed or was created in error. The operation requires both the account identifier and the specific bulk send list ID to ensure precise targeting of the list t
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.removeBulkSendList({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendListId` | `string` | Yes | — |
**Output:** *empty object*
***
## Remove Group Sharing Permissions For Template
### removeGroupSharingPermissionsForTemplate
`removeGroupSharingPermissionsForTemplate`
Removes sharing permissions for specified member groups from a DocuSign template. This endpoint is used to revoke access to a template for one or more groups, enhancing template security and access control. It's particularly useful when reorganizing team structures, updating project access, or when
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.removeGroupSharingPermissionsForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `templatePart` | `string` | Yes | — |
**Output:** *empty object*
***
## Remove Templates From Favorites
### removeTemplatesFromFavorites
`removeTemplatesFromFavorites`
Removes one or more templates from an account's list of favorite templates in DocuSign. This endpoint allows users to manage their favorite templates by specifying which templates should no longer be marked as favorites. It accepts an account identifier and a list of template IDs to be removed from
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.removeTemplatesFromFavorites({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Remove User Signature Information
### removeUserSignatureInformation
`removeUserSignatureInformation`
Removes the signature information for a specific user in DocuSign. This endpoint should be used when a user wants to delete their existing signature from their DocuSign account. It's particularly useful for updating or refreshing signature information. The operation is restricted to the authenticate
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.removeUserSignatureInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
**Output:** *empty object*
***
## Republish Connect Data For Envelope
### republishConnectDataForEnvelope
`republishConnectDataForEnvelope`
Republishes Connect information for a specified envelope in DocuSign. This endpoint is used to retry sending Connect event data that may have failed to deliver previously. It's particularly useful for ensuring that all relevant updates about an envelope are successfully communicated to integrated sy
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.republishConnectDataForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Republish Connect Info For Envelopes
### republishConnectInfoForEnvelopes
`republishConnectInfoForEnvelopes`
Republishes Connect webhook information for multiple DocuSign envelopes. Queues envelopes for Connect webhook republishing to retry failed webhook deliveries. When DocuSign Connect fails to deliver webhook events to your endpoint, envelopes are added to a failure queue. This action manually triggers
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.republishConnectInfoForEnvelopes({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Retrieve Account Billing Plan
### retrieveAccountBillingPlan
`retrieveAccountBillingPlan`
Retrieves detailed billing plan information for a specified DocuSign account. This endpoint provides comprehensive data about the current billing plan, successor plans, billing address, and credit card information associated with the account. It is particularly useful for obtaining an overview of an
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountBillingPlan({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include_credit_card_information` | `string` | No | — |
| `include_downgrade_information` | `string` | No | — |
| `include_metadata` | `string` | No | — |
| `include_successor_plans` | `string` | No | — |
| `include_tax_exempt_id` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Account Brand Information
### retrieveAccountBrandInformation
`retrieveAccountBrandInformation`
Retrieves detailed information about a specific brand associated with a DocuSign account. This endpoint allows users to access comprehensive brand settings, including company name, languages, colors, logos, and resource URLs for customizing various DocuSign experiences such as email, sending, and si
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountBrandInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
| `include_external_references` | `string` | No | — |
| `include_logos` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Account Envelope Purge Config
### retrieveAccountEnvelopePurgeConfig
`retrieveAccountEnvelopePurgeConfig`
Retrieves the current envelope purge configuration for a specified DocuSign account. This endpoint allows account administrators to view the settings that control how and when documents are permanently removed from completed and voided envelopes after a specified retention period. It provides crucia
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountEnvelopePurgeConfig({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Account Favorite Templates
### retrieveAccountFavoriteTemplates
`retrieveAccountFavoriteTemplates`
Retrieves the list of favorite templates for a DocuSign account. Returns an array of template IDs and the dates they were marked as favorites. This is useful for identifying which templates a user has marked for quick access. Note: This endpoint only returns template IDs and favorited dates, not the
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountFavoriteTemplates({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Account Information For Specified Account
### retrieveAccountInformationForSpecifiedAccount
`retrieveAccountInformationForSpecifiedAccount`
Retrieves comprehensive information for a specified DocuSign account, including account details, billing information, plan specifics, and optionally detailed account settings. This endpoint is used to gather extensive data about an account's configuration, status, and capabilities within the DocuSig
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountInformationForSpecifiedAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `include_account_settings` | `string` | No | — |
| `include_trial_eligibility` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Account Provisioning Info
### retrieveAccountProvisioningInfo
`retrieveAccountProvisioningInfo`
Retrieves the account provisioning information for a DocuSign account. This endpoint returns crucial setup and configuration details including default connection IDs, billing plan identifiers, distributor codes, password policy rules, and promotional information. Use this action when you need to: -
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountProvisioningInfo({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Account Seal Providers
### retrieveAccountSealProviders
`retrieveAccountSealProviders`
Retrieves electronic seal providers (eSeals) available for a DocuSign account. Electronic seals certify document origin and integrity using a legal entity identity rather than an individual signature. Returns seal identifiers and names for all configured seals in the account. Use this to display ava
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountSealProviders({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Account Settings Information
### retrieveAccountSettingsInformation
`retrieveAccountSettingsInformation`
Retrieves the comprehensive account settings information for a specified DocuSign account. This endpoint provides a detailed view of the account's configuration, including access code formats, account-wide preferences, feature toggles, security settings, UI customization options, and compliance-rela
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountSettingsInformation({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Account Signing Groups
### retrieveAccountSigningGroups
`retrieveAccountSigningGroups`
Retrieves a comprehensive list of all signing groups within a specified DocuSign account. This endpoint allows you to obtain detailed information about each signing group, including group names, types, IDs, and optionally, member details. It's particularly useful for managing and auditing signing gr
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountSigningGroups({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `group_type` | `string` | No | — |
| `include_users` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Account Verification Workflows
### retrieveAccountVerificationWorkflows
`retrieveAccountVerificationWorkflows`
Retrieves a list of Identity Verification workflows available for a DocuSign account. This endpoint allows account administrators or senders to fetch details about the verification methods that can be applied to signers during the document signing process. It provides information about active, deact
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAccountVerificationWorkflows({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `identity_verification_workflow_status` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve All Account Tabs
### retrieveAllAccountTabs
`retrieveAllAccountTabs`
Retrieves a comprehensive list of all tabs associated with a specified DocuSign account. It returns detailed information about each tab, including type, label, validation rules, and formatting settings. Use this endpoint for auditing tab configurations, managing account-wide tab settings, or integra
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAllAccountTabs({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `custom_tab_only` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Available Account Stamps
### retrieveAvailableAccountStamps
`retrieveAvailableAccountStamps`
Retrieves a list of stamps available in a DocuSign account. This endpoint allows users to fetch detailed information about various types of stamps, signatures, and related properties associated with the specified account. It's particularly useful for applications that need to display or manage avail
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveAvailableAccountStamps({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `stamp_format` | `string` | No | — |
| `stamp_name` | `string` | No | — |
| `stamp_type` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Billing Invoice
### retrieveBillingInvoice
`retrieveBillingInvoice`
Retrieves a specific billing invoice for a DocuSign account, providing detailed information about charges and payment details. This endpoint allows account administrators to access invoice data in both JSON format and, when available, as a downloadable PDF. It's particularly useful for financial rec
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveBillingInvoice({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `invoiceId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Billing Payment Info
### retrieveBillingPaymentInfo
`retrieveBillingPaymentInfo`
Retrieves detailed information for a specific billing payment in a DocuSign account. Returns payment details including ID, number, amount, description, and date. Useful for auditing, reconciliation, and reviewing payment records. \*\*Production Account Required:\*\* This endpoint ONLY works with pro
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveBillingPaymentInfo({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `paymentId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Chunked Upload Metadata
### retrieveChunkedUploadMetadata
`retrieveChunkedUploadMetadata`
Retrieves metadata for a specific chunked upload in DocuSign. This endpoint allows users to check the status, parts, and other details of a large file upload that has been split into chunks. It's particularly useful for verifying the integrity and completeness of an upload before committing it for u
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveChunkedUploadMetadata({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `chunkedUploadId` | `string` | Yes | — |
| `include` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Cloud Storage Provider Configuration
### retrieveCloudStorageProviderConfiguration
`retrieveCloudStorageProviderConfiguration`
Retrieves the list of cloud storage providers enabled for a specific user in a DocuSign account, along with their configuration information. This endpoint is essential for integrating external cloud storage services with DocuSign, allowing users to access and manage documents from various providers.
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCloudStorageProviderConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `redirectUrl` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Connect Configuration Details
### retrieveConnectConfigurationDetails
`retrieveConnectConfigurationDetails`
Retrieves detailed information for a specific DocuSign Connect configuration. This endpoint allows account administrators to access and review the settings of a custom Connect configuration, including event triggers, delivery modes, and integration details. It's particularly useful for auditing exis
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectConfigurationDetails({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `connectId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Connect Configurations
### retrieveConnectConfigurations
`retrieveConnectConfigurations`
Retrieves all Docusign Custom Connect definitions for a specified account. This endpoint allows account administrators to fetch detailed information about existing Connect configurations, including webhook settings, event triggers, and delivery modes. It provides a comprehensive view of how the acco
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectConfigurations({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Connect Failure Logs
### retrieveConnectFailureLogs
`retrieveConnectFailureLogs`
Retrieves the Connect failure log information for a specified DocuSign account. This endpoint is specifically designed for account administrators to identify which envelopes failed to post during Connect events. It provides detailed information about each failure, including error messages, retry cou
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectFailureLogs({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `from_date` | `string` | No | — |
| `to_date` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Connect Log Entry
### retrieveConnectLogEntry
`retrieveConnectLogEntry`
Retrieves a specific Connect log entry for a DocuSign account. This endpoint provides detailed information about a Connect event, including account details, configuration information, envelope data, and potential error details. It is particularly useful for troubleshooting Connect integrations, audi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectLogEntry({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `logId` | `string` | Yes | — |
| `additional_info` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Connect Logs
### retrieveConnectLogs
`retrieveConnectLogs`
Retrieves the 100 most recent Connect log entries for a specified DocuSign account. This endpoint is essential for monitoring and troubleshooting DocuSign Connect integrations, providing detailed information about both successful and failed Connect events. It allows administrators to review recent a
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectLogs({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `from_date` | `string` | No | — |
| `to_date` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Connect Oauth Configuration
### retrieveConnectOauthConfiguration
`retrieveConnectOauthConfiguration`
Retrieves the Connect OAuth configuration for a specified DocuSign account. This endpoint allows account administrators to access the OAuth settings used for DocuSign Connect, which is crucial for webhook integrations and automated notifications. The retrieved configuration includes essential detail
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveConnectOauthConfiguration({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Credit Card Info
### retrieveCreditCardInfo
`retrieveCreditCardInfo`
This endpoint retrieves detailed credit card information associated with a specific DocuSign account. It provides comprehensive details about the credit card on file, including the card number (partially masked), type, expiration date, cardholder name, and associated billing address. This tool shoul
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCreditCardInfo({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Custom Fields For Envelope
### retrieveCustomFieldsForEnvelope
`retrieveCustomFieldsForEnvelope`
Retrieves custom field metadata for a specified envelope. Custom fields are additional data points attached to envelopes that are NOT visible to document recipients. They're used for: - Organizing and categorizing envelopes internally - Tracking workflow stages or approval statuses - Storing referen
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCustomFieldsForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Custom Fields For Template
### retrieveCustomFieldsForTemplate
`retrieveCustomFieldsForTemplate`
This endpoint retrieves the custom document fields for an existing template document in DocuSign. It allows users to access name-value pairs of custom data strings associated with a specific document within a template. This tool is useful for retrieving metadata or custom information that has been a
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCustomFieldsForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Custom Tab Information
### retrieveCustomTabInformation
`retrieveCustomTabInformation`
Retrieves detailed information about a specific custom tab associated with a DocuSign account. This endpoint allows users to access the properties and settings of a custom tab, including its anchor information, formatting options, merge field details, and locale settings. It is particularly useful w
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCustomTabInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `customTabId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Custom User Settings
### retrieveCustomUserSettings
`retrieveCustomUserSettings`
Retrieves a list of custom user settings for a single user in DocuSign. This endpoint allows flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard user account settings. It supports both grouped and ungrouped custom settings, with the
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveCustomUserSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Default Disclosure For Envelope
### retrieveDefaultDisclosureForEnvelope
`retrieveDefaultDisclosureForEnvelope`
Retrieves the default HTML-formatted Electronic Record and Signature Disclosure (ERSD) for a specified envelope in DocuSign. This endpoint is used to obtain the standard disclosure text that recipients must agree to before signing documents electronically. It is particularly useful for retrieving la
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveDefaultDisclosureForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `langCode` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Envelope Attachment
### retrieveEnvelopeAttachment
`retrieveEnvelopeAttachment`
Downloads a developer-only envelope attachment file from a DocuSign envelope. This retrieves attachments that were added programmatically to an envelope (not signer attachments). These are files associated with the envelope that are only accessible via the API and not visible to signers in the DocuS
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeAttachment({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `attachmentId` | `string` | Yes | — |
**Output:** `string`
***
## Retrieve Envelope Audit Events
### retrieveEnvelopeAuditEvents
`retrieveEnvelopeAuditEvents`
Retrieves the audit events for a specified envelope in DocuSign. This endpoint allows users to access a detailed history of all actions and changes made to a particular envelope, providing a comprehensive audit trail. It is particularly useful for compliance, security, and tracking purposes, allowin
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeAuditEvents({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `locale` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Envelope Documents
### retrieveEnvelopeDocuments
`retrieveEnvelopeDocuments`
Retrieves one or more documents from a DocuSign envelope. This endpoint allows users to fetch a single document, all documents combined, or specific document sets in various formats (PDF, ZIP, PDF portfolio). It's particularly useful for accessing signed documents, certificates of completion, or ent
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeDocuments({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documents_by_userid` | `string` | No | — |
| `include_agreement_type` | `string` | No | — |
| `include_docgen_formfields` | `string` | No | — |
| `include_is_edited` | `string` | No | — |
| `include_metadata` | `string` | No | — |
| `include_tabs` | `string` | No | — |
| `recipient_id` | `string` | No | — |
| `shared_user_id` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Envelope Email Overrides
### retrieveEnvelopeEmailOverrides
`retrieveEnvelopeEmailOverrides`
Retrieves custom email settings for a specific DocuSign envelope. Use this action to get the envelope-specific email configuration overrides including: - Reply-to email address and display name - BCC email addresses for archiving (up to 5 addresses) These settings override the account-level defaults
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeEmailOverrides({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Envelope Html Definition
### retrieveEnvelopeHtmlDefinition
`retrieveEnvelopeHtmlDefinition`
Retrieves the original HTML definition used to generate the responsive HTML for a specific document within an envelope in a DocuSign account. This endpoint is crucial for developers working with DocuSign's responsive signing feature, as it provides detailed information about how the document is form
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeHtmlDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Envelope Notification Details
### retrieveEnvelopeNotificationDetails
`retrieveEnvelopeNotificationDetails`
Retrieves the notification, reminder, and expiration settings for an existing envelope in DocuSign. This endpoint allows developers to access and review the current notification configuration for a specific envelope, including expiration timelines and reminder schedules. It's particularly useful whe
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveEnvelopeNotificationDetails({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Items In Cloud Storage Folder
### retrieveItemsInCloudStorageFolder
`retrieveItemsInCloudStorageFolder`
Retrieves a list of items (files and folders) from a specified folder in an integrated cloud storage provider. This endpoint allows users to browse and search their cloud storage contents directly within the DocuSign application, facilitating document selection for e-signature workflows. It supports
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveItemsInCloudStorageFolder({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `serviceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `cloud_storage_folder_path` | `string` | No | — |
| `cloud_storage_folderid_plain` | `string` | No | — |
| `count` | `string` | No | — |
| `order` | `string` | No | — |
| `order_by` | `string` | No | — |
| `search_text` | `string` | No | — |
| `sky_drive_skip_token` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve List Of Billing Plans
### retrieveListOfBillingPlans
`retrieveListOfBillingPlans`
Retrieves a comprehensive list of billing plans associated with a distributor in the DocuSign system. This endpoint provides detailed information about each billing plan, including plan names, IDs, payment cycles, methods, and pricing details in various currencies. It is particularly useful for admi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveListOfBillingPlans({});
```
**Input:** *empty object*
**Output:** *empty object*
***
## Retrieve Payment Information List
### retrievePaymentInformationList
`retrievePaymentInformationList`
Retrieves a list of payment information for a specific DocuSign account. This endpoint allows you to fetch detailed payment data, including amounts, descriptions, payment dates, and IDs. It's particularly useful for accounting purposes, reconciliation, or generating financial reports. By default, it
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrievePaymentInformationList({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `from_date` | `string` | No | — |
| `to_date` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Pdf From Specified Template
### retrievePdfFromSpecifiedTemplate
`retrievePdfFromSpecifiedTemplate`
Retrieves one or more PDF documents from a specified DocuSign template. This endpoint allows you to fetch individual documents or combine all documents in the template into a single PDF file. It's particularly useful when you need to access template documents for review, processing, or to create new
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrievePdfFromSpecifiedTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `encrypt` | `string` | No | — |
| `file_type` | `string` | No | — |
| `show_changes` | `string` | No | — |
**Output:** `string`
***
## Retrieve Power Form Data Entries
### retrievePowerFormDataEntries
`retrievePowerFormDataEntries`
This endpoint retrieves data entries for a specific PowerForm within a DocuSign account. It allows PowerForm Administrators or the PowerForm sender to download the information entered by recipients into a PowerForm. The data can be retrieved in various formats (JSON, XML, or CSV) and can be filtered
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrievePowerFormDataEntries({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `powerFormId` | `string` | Yes | — |
| `data_layout` | `string` | No | — |
| `from_date` | `string` | No | — |
| `to_date` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Properties About Workspace
### retrievePropertiesAboutWorkspace
`retrievePropertiesAboutWorkspace`
Retrieves detailed properties and information about a specific DocuSign workspace. This endpoint allows you to fetch comprehensive data about a workspace, including its settings, user details, and various metadata. It's particularly useful when you need to access or verify workspace information, suc
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrievePropertiesAboutWorkspace({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Shared Item Status For Users
### retrieveSharedItemStatusForUsers
`retrieveSharedItemStatusForUsers`
Retrieves shared item status for one or more users and types of items within a DocuSign account. This endpoint provides detailed information about how envelopes, templates, and folders are shared among users and groups. It can be used to audit sharing permissions, track shared resources, or gather i
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveSharedItemStatusForUsers({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `string` | No | — |
| `envelopes_not_shared_user_status` | `string` | No | — |
| `folder_ids` | `string` | No | — |
| `item_type` | `string` | No | — |
| `search_text` | `string` | No | — |
| `shared` | `string` | No | — |
| `start_position` | `string` | No | — |
| `user_ids` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve Signer Signature Image Information
### retrieveSignerSignatureImageInformation
`retrieveSignerSignatureImageInformation`
Retrieves the specified user's signature image from a DocuSign envelope. This endpoint allows developers to access the electronic signature image of a specific recipient within an envelope, which can be useful for verification, display, or record-keeping purposes. The image is returned in its origin
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveSignerSignatureImageInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `include_chrome` | `string` | No | — |
**Output:** `string`
***
## Retrieve Template Custom Fields
### retrieveTemplateCustomFields
`retrieveTemplateCustomFields`
Retrieves the custom document field information from an existing template in DocuSign. This endpoint allows users to fetch both list and text custom fields associated with a specific template. It's particularly useful when you need to view or work with the custom fields that have been set up for a t
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveTemplateCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Template Document Page Images
### retrieveTemplateDocumentPageImages
`retrieveTemplateDocumentPageImages`
Retrieves and returns images of pages from a specified template document in DocuSign. This endpoint allows users to fetch visual representations of template pages with customizable image properties such as resolution and dimensions. It's particularly useful for previewing or displaying template cont
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveTemplateDocumentPageImages({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
| `dpi` | `string` | No | — |
| `max_height` | `string` | No | — |
| `max_width` | `string` | No | — |
| `show_changes` | `string` | No | — |
**Output:** `string`
***
## Retrieve Template Page Image
### retrieveTemplatePageImage
`retrieveTemplatePageImage`
Retrieves a specific page image from a template document for display purposes. This endpoint is part of the DocuSign Templates API and allows developers to fetch and display individual pages from template documents. It's particularly useful when you need to preview or display a specific page of a te
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveTemplatePageImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `dpi` | `string` | No | — |
| `max_height` | `string` | No | — |
| `max_width` | `string` | No | — |
| `nocache` | `string` | No | — |
| `show_changes` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve User Account Settings
### retrieveUserAccountSettings
`retrieveUserAccountSettings`
Retrieves a comprehensive list of account settings and email notification preferences for a specified user within a DocuSign account. This endpoint provides detailed information about the user's configuration, including locale settings, email notification preferences, account management capabilities
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserAccountSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve User Initials Image For Envelopes
### retrieveUserInitialsImageForEnvelopes
`retrieveUserInitialsImageForEnvelopes`
Retrieves the initials image that a recipient used when signing a DocuSign envelope. This endpoint allows you to fetch the recipient's initials image in its original format (GIF, PNG, JPEG, or BMP), with an option to include or exclude the chrome (added line and identifier around the image). The ini
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserInitialsImageForEnvelopes({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `include_chrome` | `string` | No | — |
**Output:** `string`
***
## Retrieve User Profile Image
### retrieveUserProfileImage
`retrieveUserProfileImage`
Retrieves the user profile picture for a specified user within a DocuSign account. This endpoint allows users to fetch their own profile image, which is returned in the same format as it was originally uploaded. It's particularly useful for applications that need to display user avatars or profile p
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserProfileImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `encoding` | `string` | No | — |
**Output:** `string`
***
## Retrieve User Profile Information
### retrieveUserProfileInformation
`retrieveUserProfileInformation`
This endpoint retrieves comprehensive user profile information for a specified user within a DocuSign account. It provides detailed data about the user's personal information, settings, preferences, and permissions. The endpoint is particularly useful for obtaining an in-depth view of a user's confi
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserProfileInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve User Signature Definitions
### retrieveUserSignatureDefinitions
`retrieveUserSignatureDefinitions`
This endpoint retrieves the signature definitions for a specified user within a DocuSign account. It allows users to access their own signature information, including details about signature images, stamps, and associated metadata. The endpoint is useful for applications that need to display or mana
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserSignatureDefinitions({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `stamp_type` | `string` | No | — |
**Output:** *empty object*
***
## Retrieve User Signature Image
### retrieveUserSignatureImage
`retrieveUserSignatureImage`
Retrieves a specified user's signature or initials image from DocuSign. This endpoint allows you to fetch the image in its original upload format, with an option to include or exclude the chrome (frame) around the image. It's useful for applications that need to display or process user signatures. T
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserSignatureImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
| `imageType` | `string` | Yes | — |
| `include_chrome` | `string` | No | — |
**Output:** `string`
***
## Retrieve User Signature Information
### retrieveUserSignatureInformation
`retrieveUserSignatureInformation`
This endpoint retrieves the detailed structure and information of a single user signature within a DocuSign account. It provides comprehensive details about the signature, including its creation date, image URIs, stamp properties, and associated rights. The endpoint is designed for users to access a
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveUserSignatureInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
**Output:** *empty object*
***
## Retrieve Workflow Step For Template
### retrieveWorkflowStepForTemplate
`retrieveWorkflowStepForTemplate`
Retrieves detailed information about a specific workflow step for a DocuSign template. This endpoint allows users to access the configuration and status of a single step within a template's workflow, including delayed routing settings and conditional recipient rules. It's particularly useful for mon
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.retrieveWorkflowStepForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
**Output:** *empty object*
***
## Return All Connect Service Users
### returnAllConnectServiceUsers
`returnAllConnectServiceUsers`
Retrieves all users from the configured Connect service for a specific DocuSign account and Connect configuration. This endpoint allows account administrators to fetch user information, including email addresses, user IDs, and inclusion status in the Connect service. It supports filtering by email,
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnAllConnectServiceUsers({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `connectId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `domain_users_only` | `string` | No | — |
| `email_substring` | `string` | No | — |
| `start_position` | `string` | No | — |
| `status` | `string` | No | — |
| `user_name_substring` | `string` | No | — |
**Output:** *empty object*
***
## Return Brand Resource Metadata For Account
### returnBrandResourceMetadataForAccount
`returnBrandResourceMetadataForAccount`
Retrieves metadata about the branding resources associated with a specific DocuSign account and brand. This endpoint returns detailed information about various brand resource types, including those used for sending, signing, email, and captive (embedded) signing experiences. It's particularly useful
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnBrandResourceMetadataForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
**Output:** *empty object*
***
## Return Envelope Tab Data For Existing Envelope
### returnEnvelopeTabDataForExistingEnvelope
`returnEnvelopeTabDataForExistingEnvelope`
Retrieves detailed form data from a DocuSign envelope, including the current values of form fields, recipient information, and envelope status. This endpoint is used to download envelope and tab data from in-process, completed, or canceled envelopes that the user has sent or that are shared with the
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnEnvelopeTabDataForExistingEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Return Scheduled Sending Rules For Envelope
### returnScheduledSendingRulesForEnvelope
`returnScheduledSendingRulesForEnvelope`
Get the scheduled sending configuration for a DocuSign envelope. Returns when and how an envelope is scheduled to be sent, including: - Send date/time (resumeDate): When the envelope will be sent - Delay rules: Time to wait before sending (format: d.hh:mm:ss) - Status: Whether sending is pending, st
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnScheduledSendingRulesForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Returns Document Page Images Based On Input
### returnsDocumentPageImagesBasedOnInput
`returnsDocumentPageImagesBasedOnInput`
Retrieves images of document pages from a specific envelope in a DocuSign account. This endpoint allows users to fetch page images with customizable parameters such as resolution (DPI), image dimensions, and pagination options. It's particularly useful when you need to display or process document pa
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnsDocumentPageImagesBasedOnInput({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `dpi` | `string` | No | — |
| `max_height` | `string` | No | — |
| `max_width` | `string` | No | — |
| `nocache` | `string` | No | — |
| `show_changes` | `string` | No | — |
| `start_position` | `string` | No | — |
**Output:** *empty object*
***
## Return Template Workflow Definition
### returnTemplateWorkflowDefinition
`returnTemplateWorkflowDefinition`
Retrieves the workflow definition for a specified DocuSign template. This endpoint returns detailed information about the template's workflow, including scheduled sending settings, workflow status, and individual workflow steps. It's useful for understanding and managing the automated process flow o
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnTemplateWorkflowDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
**Output:** *empty object*
***
## Return Users From Connect Service
### returnUsersFromConnectService
`returnUsersFromConnectService`
Retrieves users associated with a specific DocuSign Connect configuration. This endpoint returns information about which users are linked to a Connect configuration, indicating either that all users are selected (allUsersSelected) or providing a list of specific users. Connect configurations define
**Risk:** `read`
```ts theme={null}
await corsair.docusign.api.returnUsersFromConnectService({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `connectId` | `string` | Yes | — |
| `count` | `string` | No | — |
| `email_substring` | `string` | No | — |
| `list_included_users` | `string` | No | — |
| `start_position` | `string` | No | — |
| `status` | `string` | No | — |
| `user_name_substring` | `string` | No | — |
**Output:** *empty object*
***
## Revoke Envelope Correction Url
### revokeEnvelopeCorrectionUrl
`revokeEnvelopeCorrectionUrl`
This endpoint revokes the correction view URL for a specific envelope in DocuSign, effectively disabling the ability to make further corrections to the envelope. It should be used when you want to prevent any additional modifications to an envelope that was previously available for correction. This
**Risk:** `destructive`
```ts theme={null}
await corsair.docusign.api.revokeEnvelopeCorrectionUrl({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output:** *empty object*
***
## Rotate Page Image For Envelope
### rotatePageImageForEnvelope
`rotatePageImageForEnvelope`
This endpoint rotates a page image within a specific document of an envelope in DocuSign. It allows users to change the orientation of a page to either left or right for improved display and readability. This function is particularly useful when dealing with documents that may have been scanned or u
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.rotatePageImageForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Rotate Template Page Image
### rotateTemplatePageImage
`rotateTemplatePageImage`
Rotates a page image within a DocuSign template for display purposes. This endpoint allows users to adjust the orientation of a specific page image to either the left or right within a template. It is particularly useful when preparing templates for use in electronic signature processes, ensuring th
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.rotateTemplatePageImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `pageNumber` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Send Envelope
### sendEnvelope
`sendEnvelope`
Sends a draft envelope by updating its status to sent.
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.sendEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
**Output**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | No | — |
| `status` | `string` | No | — |
***
## Set Envelope Purge Config For Account
### setEnvelopePurgeConfigForAccount
`setEnvelopePurgeConfigForAccount`
Configures automatic envelope purge settings for a DocuSign account. This action allows account administrators to set up policies for automatically removing envelope documents after a specified retention period. The configuration includes options for: - Enabling/disabling automatic purging - Setting
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setEnvelopePurgeConfigForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Set Initials Image For Accountless Signer
### setInitialsImageForAccountlessSigner
`setInitialsImageForAccountlessSigner`
This endpoint allows you to update the initials image for a signer who does not have a DocuSign account within a specific envelope. It's used to customize the appearance of a signer's initials on documents, enhancing the personalization of the signing process. The endpoint supports various image for
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setInitialsImageForAccountlessSigner({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `imageBase64` | `string` | Yes | — |
| `contentType` | `image/gif \| image/png \| image/jpeg \| image/bmp` | Yes | — |
**Output:** *empty object*
***
## Set Shared Access For Users And Templates
### setSharedAccessForUsersAndTemplates
`setSharedAccessForUsersAndTemplates`
This endpoint sets shared access for users and templates in DocuSign. It manages collaboration and access control within an organization for envelopes, templates, and folders. Only users with admin privileges can set envelope access, while template access requires ownership or admin rights. Changes
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setSharedAccessForUsersAndTemplates({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `item_type` | `string` | No | — |
| `preserve_existing_shared_access` | `string` | No | — |
| `user_ids` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Set Signature Image For No Account Signer
### setSignatureImageForNoAccountSigner
`setSignatureImageForNoAccountSigner`
This endpoint updates the signature image for an accountless signer in a DocuSign envelope. It allows you to set a custom signature image for recipients who don't have a DocuSign account, enhancing the flexibility of the signing process. The endpoint supports gif, png, jpeg, and bmp image formats, w
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setSignatureImageForNoAccountSigner({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `imageBase64` | `string` | Yes | — |
| `contentType` | `image/gif \| image/png \| image/jpeg \| image/bmp` | Yes | — |
**Output:** *empty object*
***
## Set Templates As Account Favorites
### setTemplatesAsAccountFavorites
`setTemplatesAsAccountFavorites`
This endpoint allows users to set one or more templates as account favorites in DocuSign. It's used to mark specific templates for quick access within a user's account. The endpoint can handle multiple templates in a single request, making it efficient for bulk operations. It's particularly useful f
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setTemplatesAsAccountFavorites({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Set Up Connect Oauth Configuration
### setUpConnectOauthConfiguration
`setUpConnectOauthConfiguration`
Sets up Connect OAuth configuration for a specified DocuSign account using a custom authorization server. This endpoint enables secure, OAuth-based communication for DocuSign Connect, allowing real-time notifications about envelope status changes. It should be used when integrating DocuSign Connect
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setUpConnectOauthConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Set User Signature Image
### setUserSignatureImage
`setUserSignatureImage`
Sets or updates a user's signature image, initials, or stamp in their DocuSign account. This endpoint uploads an image file to replace or create a signature element. Use this action to: - Upload a signature image for electronic document signing - Set initials image for a user - Add custom stamp imag
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.setUserSignatureImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
| `imageType` | `string` | Yes | — |
| `transparent_png` | `string` | No | — |
| `imageBase64` | `string` | Yes | — |
| `contentType` | `image/gif \| image/png \| image/jpeg \| image/bmp` | Yes | — |
**Output:** *empty object*
***
## Share Template With Group
### shareTemplateWithGroup
`shareTemplateWithGroup`
This endpoint allows you to share a DocuSign template with a specified members group. It's used to grant access to templates for collaboration and reuse within an organization. Note that this endpoint is deprecated, and for newer functionality, it's recommended to use the 'Accounts: Update Shared Ac
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.shareTemplateWithGroup({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `templatePart` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Submit Batch Historical Envelopes To Webhook
### submitBatchHistoricalEnvelopesToWebhook
`submitBatchHistoricalEnvelopesToWebhook`
This endpoint submits a batch of existing envelopes to a specified webhook for historical publishing. It allows you to retroactively send envelope data to your systems for completed transactions, which is useful for data synchronization, auditing, or recovering missed notifications. The endpoint use
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.submitBatchHistoricalEnvelopesToWebhook({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Toggle Api Request Logging
### toggleApiRequestLogging
`toggleApiRequestLogging`
This endpoint enables or disables API request logging for troubleshooting purposes in DocuSign. It allows users to toggle the logging of REST API requests and responses, set the maximum number of log entries, and view the remaining log capacity. The tool is crucial for debugging API integrations by
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.toggleApiRequestLogging({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Brand Settings
### updateAccountBrandSettings
`updateAccountBrandSettings`
The UpdateAccountBrandSettings endpoint modifies or replaces an existing brand configuration for a DocuSign account. It customizes various brand aspects like company name, languages, colors, and landing pages. Use this tool to update branding elements for consistency across DocuSign interactions. It
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountBrandSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `brandId` | `string` | Yes | — |
| `replace_brand` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Custom Field
### updateAccountCustomField
`updateAccountCustomField`
This endpoint updates an existing account custom field in DocuSign. It allows you to modify the properties of a custom field, such as its name, type, required status, visibility, and value. The endpoint supports both list and text custom fields, enabling account administrators to refine and adjust c
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountCustomField({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `customFieldId` | `string` | Yes | — |
| `apply_to_templates` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Password Rules
### updateAccountPasswordRules
`updateAccountPasswordRules`
This endpoint updates the password rules for a DocuSign account. It allows account administrators to modify various password policy settings, including expiration, complexity requirements, lockout durations, and security question requirements. Use this endpoint to enhance account security, comply wi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountPasswordRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Settings
### updateAccountSettings
`updateAccountSettings`
Updates various settings for a specified DocuSign account. This endpoint allows administrators to configure a wide range of account-level options, including security settings, compliance features, and user interface preferences. Use this when you need to modify your DocuSign account configuration to
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Stamp By Id
### updateAccountStampById
`updateAccountStampById`
This endpoint allows you to update an existing account stamp (signature) in DocuSign. It provides extensive customization options for the stamp's appearance, associated users, and properties. Use this when you need to modify an existing stamp's details, such as its image, font, size, or user permiss
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountStampById({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signatureId` | `string` | Yes | — |
| `close_existing_signature` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Stamps
### updateAccountStamps
`updateAccountStamps`
Update existing account stamps (signatures) in a DocuSign account. Modifies properties of existing stamps by referencing their signatureId. Supports updating names, sizes, formats (NameHanko/NameDateHanko), resize permissions, phonetic names, and external IDs. Supports batch updates of multiple stam
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountStamps({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Watermark Information
### updateAccountWatermarkInformation
`updateAccountWatermarkInformation`
This endpoint updates the watermark settings for a specified DocuSign account. It allows customization of various watermark properties such as display angle, font, color, size, and transparency. The endpoint can be used to enable or disable the watermark feature, change the watermark text, or modify
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountWatermarkInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Account Watermark Preview
### updateAccountWatermarkPreview
`updateAccountWatermarkPreview`
Updates and previews watermark settings for a DocuSign account before applying them. This endpoint allows you to test watermark appearance settings including text, font, color, size, display angle, and transparency without permanently saving the configuration. Use this action when you want to previe
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateAccountWatermarkPreview({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Billing Plan For Account
### updateBillingPlanForAccount
`updateBillingPlanForAccount`
Updates billing plan information, address, and payment details for a DocuSign account. Allows comprehensive modifications to billing setup, including payment methods, plan features, and promotional offers. Offers a preview mode for reviewing changes before applying. Use for significant billing confi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateBillingPlanForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `preview_billing_plan` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Bulk Send Batch Name
### updateBulkSendBatchName
`updateBulkSendBatchName`
Updates the name of an existing DocuSign bulk send batch. This action allows you to rename a specific bulk send batch for better organization and identification. Use this when you need to update the batch name after creation, for example to reflect the batch purpose or processing status. Key points:
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateBulkSendBatchName({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `bulkSendBatchId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Connect Oauth Configuration
### updateConnectOauthConfiguration
`updateConnectOauthConfiguration`
This endpoint updates an existing Connect OAuth Configuration for a DocuSign account. Use it to modify OAuth settings for DocuSign Connect integrations, such as updating authorization URLs, client credentials, or scopes. It's crucial for maintaining secure data exchange between DocuSign and integrat
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateConnectOauthConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Contacts Information
### updateContactsInformation
`updateContactsInformation`
This endpoint updates one or more contacts associated with a DocuSign account. It allows for comprehensive modifications to contact information, including personal details, communication methods, and notary-specific data. The endpoint supports bulk updates, enabling efficient management of multiple
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateContactsInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Custom Fields In Envelope Document
### updateCustomFieldsInEnvelopeDocument
`updateCustomFieldsInEnvelopeDocument`
This endpoint allows you to update existing custom document fields in a specific document within an envelope in DocuSign. Custom document fields are name-value pairs that can be used to store additional metadata or information about the document. This function is useful when you need to modify or ad
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateCustomFieldsInEnvelopeDocument({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Custom Tab Information For Account
### updateCustomTabInformationForAccount
`updateCustomTabInformationForAccount`
This endpoint updates the information for a custom tab associated with a specific DocuSign account. It allows for extensive customization of tab properties, including appearance, behavior, and positioning within documents. The endpoint is used when modifying existing custom tabs to change their char
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateCustomTabInformationForAccount({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `customTabId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Document Visibility Recipients
### updateDocumentVisibilityRecipients
`updateDocumentVisibilityRecipients`
Updates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateDocumentVisibilityRecipients({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Docusign Connect Configuration
### updateDocusignConnectConfiguration
`updateDocusignConnectConfiguration`
This endpoint updates an existing DocuSign Connect configuration for a specified account. It allows you to modify various settings such as the events that trigger notifications, the endpoint URL for receiving webhooks, data format preferences, and integration details with Salesforce. Use this endpoi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateDocusignConnectConfiguration({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Electronic Record Disclosure
### updateElectronicRecordDisclosure
`updateElectronicRecordDisclosure`
Updates the Electronic Record and Signature Disclosure (ERSD) for a DocuSign account. Allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. Only account administrators can use this method. Changes may require u
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateElectronicRecordDisclosure({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `langCode` | `string` | Yes | — |
| `include_metadata` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Enote Integration Config
### updateEnoteIntegrationConfig
`updateEnoteIntegrationConfig`
Updates the eNote integration configuration for a specific DocuSign account. This endpoint allows users to modify settings related to eNote functionality, including API key, Connect configuration, eNote configuration, organization details, and user credentials. It should be used when setting up or m
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnoteIntegrationConfig({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Attachment
### updateEnvelopeAttachment
`updateEnvelopeAttachment`
Updates an existing attachment for a draft or in-process envelope in DocuSign. This endpoint allows you to modify attachment properties such as access control, type, content, label, and name. It supports file attachments up to 50 MB and provides options for chunked uploads of large files. Use this e
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeAttachment({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `attachmentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Custom Fields
### updateEnvelopeCustomFields
`updateEnvelopeCustomFields`
This endpoint allows users to update custom fields for draft and in-process envelopes in DocuSign. It enables the modification of both list-based and text-based custom fields, which can be used for sorting, organizing, searching, and other downstream processes. This tool is particularly useful when
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Delayed Routing Rules
### updateEnvelopeDelayedRoutingRules
`updateEnvelopeDelayedRoutingRules`
Updates the delayed routing rules for a specific workflow step in a DocuSign envelope. This endpoint allows you to add or modify delayed routing settings for both draft and sent envelopes, as long as the previous workflow step has not been completed. It enables you to control when the envelope will
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeDelayedRoutingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Doc Gen Form Fields
### updateEnvelopeDocGenFormFields
`updateEnvelopeDocGenFormFields`
This method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state. Use the DocumentGeneration::getEnvelopeDocGenFormFields response to retrieve the list of sender fields for your envelope. Use that list to build the request for this meth
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeDocGenFormFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `update_docgen_formfields_only` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Email Settings
### updateEnvelopeEmailSettings
`updateEnvelopeEmailSettings`
Updates the existing email override settings for a specified envelope in DocuSign. This endpoint allows customization of the Reply To email address and name, as well as BCC email addresses for a specific envelope. It's particularly useful when you need to modify email settings for an individual enve
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeEmailSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Notification Settings
### updateEnvelopeNotificationSettings
`updateEnvelopeNotificationSettings`
Updates the notification settings for a specific DocuSign envelope, including reminders and expirations. This endpoint allows you to customize when and how often recipients receive reminder emails, as well as set the expiration period for the envelope. It can either apply custom settings or use the
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeNotificationSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Scheduled Sending Rules
### updateEnvelopeScheduledSendingRules
`updateEnvelopeScheduledSendingRules`
Updates the scheduled sending rules for an envelope's workflow in DocuSign. This endpoint allows users to set or modify when an envelope will be sent, providing precise control over document delivery timing. It can be used to delay sending, schedule future sends, or manage bulk send operations with
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeScheduledSendingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Workflow Definition
### updateEnvelopeWorkflowDefinition
`updateEnvelopeWorkflowDefinition`
Updates the workflow definition for a specified envelope in DocuSign. It allows modification of scheduled sending, delayed routing, and conditional recipient rules. Use this endpoint to add or update scheduling for draft or in-progress envelopes, or to add delayed routing to envelopes not yet in wor
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeWorkflowDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Envelope Workflow Step
### updateEnvelopeWorkflowStep
`updateEnvelopeWorkflowStep`
Updates a specific workflow step for a DocuSign envelope, allowing for customization of envelope processing, including delayed routing and conditional recipients. This endpoint can be used to modify workflow steps for both draft envelopes and sent envelopes (as long as the previous step hasn't been
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateEnvelopeWorkflowStep({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Group Information
### updateGroupInformation
`updateGroupInformation`
Updates group information for one or more user groups in a DocuSign account. This action allows you to modify group properties such as group name and permission profile assignments. \*\*Required Parameters:\*\* - groups: A list of group objects to update. Each group must include: - groupId: The Docu
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateGroupInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Lock For Envelope
### updateLockForEnvelope
`updateLockForEnvelope`
Updates lock settings for an already-locked envelope in DocuSign to extend duration or modify the locking application identifier. Use this to extend lock time during long editing sessions (max 1800 seconds/30 minutes) or update the lockedByApp identifier. Returns updated lock information including t
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateLockForEnvelope({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `lockToken` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Notary Jurisdiction Info
### updateNotaryJurisdictionInfo
`updateNotaryJurisdictionInfo`
Updates the jurisdiction information for a notary in the DocuSign system. This endpoint allows for modification of various details related to a notary's commission and jurisdiction settings. It should be used when there are changes to a notary's information, such as their registered name, commission
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateNotaryJurisdictionInfo({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `jurisdictionId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Permission Profile Settings
### updatePermissionProfileSettings
`updatePermissionProfileSettings`
This endpoint updates an existing account permission profile in DocuSign. It allows administrators to modify various settings and permissions for users associated with the profile, providing granular control over user capabilities within the DocuSign platform. The endpoint is used to customize user
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updatePermissionProfileSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `permissionProfileId` | `string` | Yes | — |
| `include` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Recipient Document Visibility
### updateRecipientDocumentVisibility
`updateRecipientDocumentVisibility`
This endpoint updates the document visibility settings for a specific recipient within a DocuSign envelope. It allows fine-grained control over which documents a recipient can see and whether they have read-only or edit access. Use this when you need to modify document access for a particular recipi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateRecipientDocumentVisibility({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `body` | `object` | Yes | — |
```ts theme={null}
{
documentVisibility: {
recipientId?: string,
documentId?: string,
visible?: string
}[]
}
```
**Output:** *empty object*
***
## Update Signing Group Details
### updateSigningGroupDetails
`updateSigningGroupDetails`
Updates the details of a specified signing group within a DocuSign account, including the group name, email, and member information. This endpoint allows for modifying existing group data and adding new members to the signing group, with a maximum limit of 50 members per group. It's particularly use
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateSigningGroupDetails({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `signingGroupId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Signing Group Names
### updateSigningGroupNames
`updateSigningGroupNames`
Updates the names of one or more existing signing groups in DocuSign. This endpoint allows you to modify the names of signing groups, which are collections of users grouped together for document signing purposes. It's useful when you need to rename signing groups to reflect organizational changes or
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateSigningGroupNames({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Custom Fields
### updateTemplateCustomFields
`updateTemplateCustomFields`
Updates the custom fields in a DocuSign template. This endpoint allows you to modify both list and text custom fields associated with a specific template, ensuring each field has a unique name. It's used to customize templates for specific use cases, enabling prepopulation of metadata for envelopes
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Delayed Routing Rules
### updateTemplateDelayedRoutingRules
`updateTemplateDelayedRoutingRules`
This endpoint updates the scheduled sending rules for a specific workflow step in a DocuSign template. It allows users to set up delayed routing for envelopes, controlling when documents are sent to recipients associated with the workflow step. The function can be used to implement time-based workfl
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateDelayedRoutingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Document Custom Fields
### updateTemplateDocumentCustomFields
`updateTemplateDocumentCustomFields`
This endpoint updates existing custom document fields in a specific document within a DocuSign template. It allows you to modify metadata associated with a template document without changing the document's content or structure. Use this when you need to update or add custom information to a template
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateDocumentCustomFields({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `documentId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Doc Visibility
### updateTemplateDocVisibility
`updateTemplateDocVisibility`
This endpoint updates document visibility settings for one or more recipients in a DocuSign template. It allows fine-grained control over which documents are visible to specific recipients, enhancing document security and workflow customization. The method is particularly useful when you need to res
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateDocVisibility({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Lock Information
### updateTemplateLockInformation
`updateTemplateLockInformation`
This endpoint allows you to update the lock information for an already locked template in DocuSign. It is used to modify the duration of an existing lock or change the name of the application that has locked the template. This operation is crucial for managing access to templates that are currently
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateLockInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `lockToken` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Notification Settings
### updateTemplateNotificationSettings
`updateTemplateNotificationSettings`
This endpoint updates the notification structure for an existing DocuSign template. It allows users to customize reminder and expiration notifications for a specific template, which can then be used to create envelopes with these predefined settings. The endpoint is particularly useful when you need
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateNotificationSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Recipient Document Visibility
### updateTemplateRecipientDocumentVisibility
`updateTemplateRecipientDocumentVisibility`
Updates document visibility settings for a specific recipient in a DocuSign template. This endpoint allows you to control which documents a particular recipient can see in a template with multiple documents. Use this when you need to: - Restrict certain documents from specific recipients for securit
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateRecipientDocumentVisibility({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `recipientId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Scheduled Sending Rules
### updateTemplateScheduledSendingRules
`updateTemplateScheduledSendingRules`
Updates the scheduled sending rules for a DocuSign template, controlling when envelopes created from this template are automatically sent. Use this to set up either a relative delay (e.g., send 2 days after creation) or an absolute future date/time. This is useful for: - Automating timed document de
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateScheduledSendingRules({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Template Workflow Definition
### updateTemplateWorkflowDefinition
`updateTemplateWorkflowDefinition`
Updates the workflow definition for a specified template in DocuSign, allowing for customization of the document signing process. This endpoint enables users to modify the sequence of steps, set up conditional routing, schedule envelope sending, and define recipient rules for a template. It's partic
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateTemplateWorkflowDefinition({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Account Settings
### updateUserAccountSettings
`updateUserAccountSettings`
This endpoint updates the account settings and email notification types for a specified user in DocuSign. It allows for comprehensive customization of a user's experience within the DocuSign platform, including locale preferences, timezone settings, email notifications, account management capabiliti
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserAccountSettings({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `allow_all_languages` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Authorization Dates
### updateUserAuthorizationDates
`updateUserAuthorizationDates`
Updates the start and/or end dates for a specified user authorization in DocuSign. This endpoint allows account administrators or the principal user to modify the duration of an existing authorization, enabling precise control over when an agent can act on behalf of the principal user. It's particul
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserAuthorizationDates({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `authorizationId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Information For Specified User
### updateUserInformationForSpecifiedUser
`updateUserInformationForSpecifiedUser`
The User\_PutUser endpoint allows updating user information for a specified user within a DocuSign account. It provides comprehensive control over user settings, including personal information, permissions, notification preferences, and locale settings. This endpoint should be used when modifying us
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserInformationForSpecifiedUser({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `allow_all_languages` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Notary Information
### updateUserNotaryInformation
`updateUserNotaryInformation`
The UpdateUserNotaryInformation endpoint modifies a notary's profile and settings in DocuSign. It manages account details, preferences, and operational parameters. Use this to update a notary's visibility, capabilities, or personal settings. It's crucial for maintaining accurate records and ensuring
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserNotaryInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Profile Image
### updateUserProfileImage
`updateUserProfileImage`
Updates the user's profile image in DocuSign by uploading a new image file. This action allows users to personalize their DocuSign account by uploading a profile picture. Supported formats include GIF, PNG, JPEG, and BMP. The image file must be less than 200KB, and for optimal display, DocuSign reco
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserProfileImage({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `imageBase64` | `string` | Yes | — |
| `contentType` | `image/gif \| image/png \| image/jpeg \| image/bmp` | Yes | — |
**Output:** *empty object*
***
## Update User Profile Information
### updateUserProfileInformation
`updateUserProfileInformation`
Updates a user's profile in DocuSign, including personal details, privacy settings, and user ID card information. It allows modifications to name, address, locale preferences, and various account settings. Users can only update their own information. Some settings may require admin rights to modify.
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserProfileInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update User Signature By Id
### updateUserSignatureById
`updateUserSignatureById`
Updates or creates a user's signature and initials for a specified DocuSign account. This endpoint allows for customization of signature appearance, including font, stamp format, and date stamp properties. It can be used to modify an existing signature or create a default signature if one doesn't ex
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateUserSignatureById({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `userId` | `string` | Yes | — |
| `signatureId` | `string` | Yes | — |
| `close_existing_signature` | `string` | No | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Workflow Step For Template
### updateWorkflowStepForTemplate
`updateWorkflowStepForTemplate`
This endpoint updates a specified workflow step for a DocuSign template. It allows users to modify various aspects of the workflow step, including delayed routing settings, recipient routing rules, and conditional recipient configurations. The endpoint is used to fine-tune the automation and customi
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateWorkflowStepForTemplate({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `templateId` | `string` | Yes | — |
| `workflowStepId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Workspace Information
### updateWorkspaceInformation
`updateWorkspaceInformation`
Updates information about a specific DocuSign workspace. This endpoint allows you to modify various aspects of a workspace, including its name, description, settings, and status. It's used when you need to change workspace details or adjust collaboration settings. The endpoint requires both the acco
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateWorkspaceInformation({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
## Update Workspace Item Metadata
### updateWorkspaceItemMetadata
`updateWorkspaceItemMetadata`
Updates the metadata for a specific file in a DocuSign workspace. This endpoint allows you to modify file properties such as name, content type, extension, and visibility settings without changing the actual file content. Use this action when you need to rename a file, update its MIME type, or chang
**Risk:** `write`
```ts theme={null}
await corsair.docusign.api.updateWorkspaceItemMetadata({});
```
**Input**
| Name | Type | Required | Description |
| - | - | - | - |
| `workspaceId` | `string` | Yes | — |
| `folderId` | `string` | Yes | — |
| `fileId` | `string` | Yes | — |
| `body` | `object` | No | — |
```ts theme={null}
{
}
```
**Output:** *empty object*
***
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.