Beyond-Bot.ai Logo+Docusign Logo

Beyond-Bot.ai + Docusign

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

What You Can Do with this Integration

Automate Data Entry

Automatically sync new contacts or deals from Beyond-Bot.ai to Docusign.

Enrich Customer Profiles

Use Beyond-Bot.ai to find and add new information to your records in Docusign.

Trigger Workflows

Start automated workflows in Docusign based on conversations with your virtual expert.

Available Actions

Here are the specific actions your virtual expert can perform within Docusign.

Add Contacts To Contacts List

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 efficiently or synchronizing contacts from external sources. the endpoint supports various contact types, including regular contacts, shared contacts, and signing groups. use this when you need to add or update multiple contacts simultaneously in a docusign account. note that while it can handle a variety of contact information, it does not provide functionality for removing or deactivating contacts.

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 the account-level configurations. it's particularly useful for setting up specialized archiving or customizing the reply-to information for specific envelopes. note that these changes only affect email communications that occur after the addition is made, and the bcc feature is limited to users with appropriate permissions. for security reasons, additional signer authentication is recommended when using the bcc for email archive feature.

Add Envelope Attachments

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 that should not be part of the main signing process. the endpoint supports up to 12 attachments per envelope, with a maximum file size of 50 mb each. note that these attachments are not visible in the docusign web application and are intended for programmatic use only.

Add Existing Brand To Group

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 particular group, such as when reorganizing branding strategies or expanding brand options for specific user groups. it's important to note that this endpoint only adds existing brands to a group and does not create new brands or modify brand details.

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, such as when adding new documents to a project or sharing files with team members. it's important to note that this endpoint only handles the file addition process and does not provide functions for file modification or deletion.

Add Members To Signing Group

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 the membership of an existing signing group. the endpoint allows you to add up to 50 members to a signing group, which is the maximum limit. when adding members, you must provide their email addresses and usernames. it's important to note that docusign recommends separating signer recipients and non-signer recipients (such as carbon copy recipients) into different signing groups to maintain clarity in the signing process.

Add New Users To A Specified Account

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 additional configuration options. it returns detailed information about created users, including ids and status.

Addorupdateaccountstamps

This endpoint allows you to add or update one or more account stamps in a docusign account. it provides a comprehensive way to manage signature and stamp settings, including image properties, user associations, and stamp-specific details. use this endpoint when you need to create new stamps or modify existing ones for an account. it's particularly useful for bulk operations on multiple stamps. note that this endpoint doesn't handle the actual process of signing documents, but rather manages the stamps available for use in the signing process.

Add Or Update User Custom Settings

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-settings-key header for more organized management. the endpoint has a 4,000 character limit for all custom settings per user, including xml and json structure.

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. the endpoint supports various signature types (standard signatures, initials, and stamps) and allows for detailed customization of signature appearance and behavior. it's particularly useful for maintaining up-to-date and personalized signature information for docusign users. note that users can only manage their own signatures; even users with admin rights cannot modify another user's signature settings.

Add Part To Chunked Upload

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 particularly useful for handling large pdfs and other documents. it's important to note that parts should ideally be uploaded in sequential order, and the entire chunked upload must be completed and used within 20 minutes of initialization. this endpoint cannot replace already received parts or add to committed uploads.

Add Step To Envelope Workflow

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 envelope's workflow by adding additional steps or rules after the envelope has been created. this is particularly useful for implementing advanced routing logic or adding pauses in the signing process. the endpoint does not modify existing steps in the workflow; it only adds new ones.

Add Templates To Document In Envelope

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 modify an existing envelope by incorporating template content into its documents. the endpoint is particularly useful for maintaining consistency across documents and automating the addition of necessary fields. note that applying templates may affect envelope recipients, depending on the template content and the 'preserve template recipient' parameter setting. this endpoint does not create new envelopes or documents; it only modifies existing ones.

Add Templates To Envelope

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 comprehensive template changes to an envelope, not for creating new envelopes or minor modifications.

Add User Signature And Initials Images

This endpoint allows you to add or update a user's signature and/or initials images in the docusign system. it supports both creating default signatures based on the user's name and uploading custom signature images. the endpoint can be used with either json or multipart form data, depending on whether you're creating a default signature or uploading custom images. it's particularly useful when setting up new users or updating existing user signatures. note that each update may generate a new signatureid, so applications should rely on the signature name for consistent identification.

Add Users To Existing Group

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. the operation returns detailed information about the added users and the result set. use this endpoint when you need to update group memberships or organize users into specific groups for access control or administrative purposes. note that this endpoint only adds existing users to a group; it does not create new users or groups.

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 simultaneously. this tool is particularly useful when you need to resend failed envelopes, correct errors in a batch of envelopes, or void an entire batch of envelopes. it should be used carefully, as the actions applied will affect all envelopes in the specified batch.

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 manage multiple users or update specific user settings en masse. it can handle updates for a single user or batch updates for multiple users in one request. the endpoint provides granular control over user settings, allowing for detailed customization of user profiles and permissions within the docusign environment. however, it's important to note that some settings may be limited by the account's plan or the user's role within the organization.

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 through the users:update method. the operation affects multiple users in a single request, streamlining bulk user management tasks.

Commit Chunked Upload For Envelopes

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 uploaded content and, if successful, marks the chunked upload as ready for use. it's crucial to note that once committed, no additional parts can be added to the upload. this method is particularly useful when dealing with large documents that exceed standard upload size limits, allowing for more efficient handling of sizeable files in the docusign workflow.

Configure Cloud Storage Redirect Url

This endpoint configures the redirect url information for one or more cloud storage providers associated with a specific user in docusign. it allows setting up the authentication flow between docusign and various cloud storage services, enabling secure access to documents stored in these cloud providers. the endpoint should be used when integrating cloud storage services with docusign for a user, ensuring proper authentication and redirection after the cloud storage provider authenticates the user. it's important to note that the redirect url must be within the docusign.com or docusign.net domains for security reasons. the endpoint returns the configured storage providers with their respective authentication urls, which are crucial for completing the authentication process.

Create Account Custom Field

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 'list', and can be set as required or optional. it's particularly useful for standardizing data collection across all envelopes within an account and can optionally be applied to existing templates.

Create A Collaborative Workspace

This endpoint creates a new collaborative workspace in docusign, providing a shared area for document management and workflow collaboration. it should be used when setting up a new project or team that requires a centralized space for file sharing and collaborative work. the workspace creation process includes specifying workspace details, settings, and initial user information. note that this endpoint only creates the workspace; adding members and files are separate operations.

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 organizations that need to maintain comprehensive email records for compliance or auditing purposes. the method supports adding one bcc email address at a time, with a limit of up to five active and pending email archive addresses per account.

Create Brand Profiles For Account

This endpoint creates brand profile files for a docusign account, customizing visual and textual elements. it allows setting company name, languages, colors, and landing pages. use it for new branding or major changes. requires 'canselfbrandsign' or 'canselfbrandsend' enabled. logos must be added separately. supports multiple brands and locales.

Create Bulk Send Request

This endpoint initiates a bulk send process for docusign, allowing users to send a single envelope or template to multiple recipients efficiently. it uses an existing bulk send list and a specified envelope or template to create a batch of envelopes for distribution. the endpoint is ideal for scenarios requiring large-scale document distribution, such as sending contracts to numerous clients or distributing company-wide notices. it's recommended to test the compatibility of the bulk send list with the envelope using the createbulksendtestrequest method before actual sending. upon successful queuing, a batchid is provided for tracking the status of the bulk send operation. note that this process is asynchronous, and the entire batch is queued for processing rather than individual envelopes.

Create Bulk Send Test Request

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. use this endpoint before initiating an actual bulk send to identify and resolve any potential issues. the test returns a boolean indicating whether the send can proceed, along with detailed validation error information if applicable. this endpoint is essential for maintaining the integrity and efficiency of bulk sending processes in docusign.

Create Connect Configuration For Account

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 different delivery modes, data formats, and event triggers, providing flexibility in how and when notifications are received.

Create Custom Document Fields In Envelope

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 with a document that isn't captured by standard docusign fields. the custom fields are not used by docusign for processing but are returned in the envelope status. this endpoint should be used after an envelope has been created and when you need to add or update custom metadata for a specific document within that envelope.

Create Custom Fields For Envelope

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 (with predefined options) and text-type custom fields (for free-form entry). this operation is applicable to draft and in-process envelopes only and should not be used for completed envelopes. custom fields added through this endpoint will be visible in the envelope settings section of the docusign console but will not be visible to envelope recipients.

Create Custom Fields In Template Document

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 applied to all new envelopes created using this template. the endpoint requires the account id, document id, and template id to identify the exact document within a specific template. custom fields are added as name-value pairs, allowing for flexible metadata structuring within the constraints of docusign's field limitations.

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, checkboxes, radio buttons, and signature fields. this tool is particularly useful for standardizing frequently used tab configurations across multiple documents and improving efficiency in envelope creation.

Createdocumentresponsivehtmlpreview

Creates a preview of the responsive html version of a specific document within a docusign envelope. this endpoint allows users to visualize how a pdf document will appear as responsive html across various device types before sending it for signature. it's particularly useful for ensuring optimal document presentation and user experience across different screen sizes and devices. the preview can help identify any formatting issues or display problems that may occur during the conversion process, allowing for adjustments before the document is finalized and sent to recipients.

Create Envelope From Template

Creates and sends an envelope using a template. allows multiple recipients with different roles and routing orders.

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 group objects, each containing a group name and optionally a permission profile id. it's particularly useful for setting up new organizational structures, managing template access, or preparing for bulk user management. note that only the 'groupname' and 'permissionprofileid' properties are used in the request; all other properties in the group objects are ignored. to associate permission profiles with groups, you need to first obtain the permission profile ids using the accountpermissionprofiles: list endpoint.

Createidproofresourcetokenforrecipient

Creates a resource token that allows a sender to retrieve identification data for a specific recipient using docusign's id evidence api. this endpoint is part of the envelope recipient management process and is specifically designed for identity verification purposes. it should be used when a sender needs to access and verify a recipient's identification information securely. the generated token provides a controlled and time-limited access to the recipient's id data, enhancing security in the document signing process. this api is currently in beta, which means it may undergo changes and its usage might be subject to limitations or additional scrutiny. the endpoint does not directly provide the identification data but instead returns the necessary credentials (resource token and base uri) to access it through the id evidence api.

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 sending to advanced account management functions. use this endpoint when setting up new roles or modifying existing permission structures. note that creating a profile doesn't automatically assign users to it; separate actions are required for user assignment.

Createnotaryjurisdictionobject

Creates a new notary jurisdiction object in the docusign system. this endpoint is used to register or update information about a notary's commission, including their jurisdiction, seal type, and specific details required by different states. it supports multiple us jurisdictions and allows for detailed configuration of notary seals and commission information. the created object serves as a record of the notary's authority and defines how they can operate within the docusign platform for electronic notarization. this endpoint should be used when onboarding new notaries or updating existing notary information in the system. it's important to note that the jurisdiction object is read-only once created, so accurate information should be provided during the initial creation.

Createorupdateuserauthorizations

Creates or updates multiple user authorizations in docusign, allowing an agent user to perform specific actions on behalf of a principal user. this endpoint enables bulk management of user permissions, including sending, managing, signing, or editing documents. it's particularly useful for setting up or modifying access rights across multiple users efficiently. the endpoint requires account administrator privileges or must be called by the principal user themselves. note that for signing permissions, the account must have the 'allowdelegationsigning' setting enabled, and each principal user can only share signing permission with one agent user.

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 documents are properly formatted for responsive signing, enhancing the signing experience across different devices. the preview can be customized using various display settings and anchors, enabling users to create collapsible sections, responsive tables, and other interactive elements in the signing document.

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 various screen sizes and devices, enhancing the signing experience for recipients. it leverages smart sections and display anchors to customize document appearance and behavior, including collapsible sections and responsive tables.

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 used for recipients in workflows that support manual review and whose automatic verification has failed with a specific status code. the returned url is essential for completing the identity verification process in cases where automatic methods were insufficient.

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. the preview can help identify any issues with document layout, field placements, or signing order, ensuring a smooth signing experience for the recipients.

Createrecipientviewurl

Creates a url for embedding the docusign recipient view ui within an application, allowing users to sign documents directly in the app. this endpoint is specifically used for envelopes in the 'sent' status and generates a temporary url that expires after 5 minutes. it provides a seamless way to integrate electronic signature capabilities into your workflow, ensuring a secure and legally binding signing process. the method requires proper authentication of the recipient's identity and offers various customization options for the embedded experience.

Create Sender View Url For Envelope

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 provides a customizable sender view for an envelope in the 'created' state, with options to tailor the user interface and behavior. it's important to note that the url must be used immediately after generation and is valid for only one use. the endpoint offers extensive customization options through the 'settings' object, allowing control over ui elements, button behaviors, and access levels. for mobile integrations, especially ios devices, it's recommended to use a webview instead of an iframe due to screen space limitations.

Create Signing Group

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 when you need to establish teams or departments that can collectively receive and sign documents, with any member able to sign on behalf of the group.

Createtemplatedocumentcustomfields

This endpoint creates custom document fields in an existing docusign template. it allows users to add both list-type and text-type custom fields to enhance template functionality and capture additional data during the envelope creation and sending process. the endpoint is useful for customizing templates with specific metadata requirements or for integrating with external systems like salesforce. it should be used when templates need to be enhanced with custom data entry options or when preparing templates for specific workflows that require additional information.

Create Template Recipient Preview Url

This endpoint generates a url that allows senders to preview the experience of a specific recipient for a docusign template. it's useful for checking how the template will appear to the recipient before actually sending it. the preview url can be embedded in your application, enabling a seamless workflow for template creation and verification. this tool should be used when you need to validate the recipient's view of a template or when you want to provide a preview feature in your template management interface. note that this is specifically for templates and not for regular documents or envelopes.

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 documents are easily readable and signable on different screen sizes and devices. the preview allows for fine-tuning of display settings, anchors, and other responsive elements to optimize the signing experience.

Create Template Workflow Step

This endpoint adds a new workflow step to an existing docusign template. it allows users to define complex routing and conditional recipient rules within the template's workflow. the endpoint is used to create automated processes for document routing, including actions like pausing the workflow, implementing delayed sending, and setting up conditional recipient routing based on specific criteria. it's particularly useful for templates that require sophisticated, multi-stage approval or review processes. the created workflow step can control the timing and conditions under which documents are sent to different recipients, enhancing the flexibility and automation of the document signing process. however, users should be aware that the complexity of the workflow increases with each added step, and careful planning is required to ensure the desired document flow is achieved.

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 generated url provides access to the docusign template ui, where users can create, modify, and save templates. this method is particularly useful for applications that need to offer template management capabilities while maintaining a seamless user experience. it's important to note that this endpoint focuses solely on generating the url for template editing and does not handle the actual template modifications.

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 particularly useful for streamlining workflow processes in scenarios where one user needs to act on behalf of another, such as an assistant managing documents for an executive. the authorization can be time-bound and is subject to account-level permissions. note that only account administrators or the principal user can create these authorizations, and each principal can only share signing permission with one agent user at a time.

Delete Account Brand

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 enabled for the account. this is indicated by the account settings 'canselfbrandsend' or 'canselfbrandsign' being set to true. the deletion is irreversible, so it should be used with caution. if successful, the brand will be completely removed from the account and can no longer be applied to documents or emails. this endpoint does not return the deleted brand details; it only confirms the successful deletion or returns an error if the operation fails.

Delete Account Custom Field

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 templates as well. this operation is part of the account management functionality and affects how custom metadata can be used in future envelope creations.

Delete Account Permission Profile

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 new profile. it's particularly useful when restructuring account permissions or during account cleanup processes. the method will fail if there are associated users and no reassignment is specified. it's important to note that this action is irreversible, so caution should be exercised when using this endpoint. this endpoint should not be used for temporary permission changes; instead, it's meant for permanent removal of a permission profile.

Delete Account Stamp

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 maintaining account hygiene by removing outdated or unused stamps. note that this endpoint only deletes the stamp; it does not affect any documents that may have already been signed using this stamp.

Delete Bcc Email Archive Configuration

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. this operation is useful for managing email archiving settings, particularly when an archiving configuration is no longer needed or needs to be replaced. it's important to note that this action is irreversible, and once deleted, the specific configuration cannot be reactivated – a new one would need to be created if archiving is required again in the future. this endpoint should be used cautiously, as it will impact the email archiving process for the account.

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, updating the group's brand configurations. use this endpoint when you need to disassociate brands from a particular group, such as during reorganization or brand consolidation processes. note that this action does not delete the brands from the account entirely, but only removes their association with the specified group.

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 from a docusign account. note that branding for either signing or sending must be enabled for the account (canselfbrandsend, canselfbrandsign, or both must be true) for this endpoint to function properly. this operation is irreversible, so caution should be exercised when using it.

Delete Brand Profiles

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 that this operation is irreversible, so care should be taken when using this endpoint. the response provides detailed information about the deleted brands, including their ids, names, and associated resources.

Delete Chunked Upload

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 cannot delete chunked uploads that have already been consumed or those that have expired. it's recommended to explicitly delete unused chunked uploads rather than waiting for automatic expiration to manage your quota effectively. note that this api is currently in beta status and may be subject to changes.

Delete Connect Configuration

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 caution. this endpoint doesn't return the deleted configuration details; it only confirms successful deletion or returns an error.

Delete Connect Failure Log Entry

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 integration issues or performing routine log management. the endpoint requires account administrator privileges and connect must be enabled on the account. it's important to note that this operation is irreversible, so care should be taken when deleting log entries, especially when using the 'all' option.

Deleteconnectlogentries

Deletes a specified list of connect log entries for a docusign account. this endpoint is designed for account administrators to manage and clean up connect event logs. it should be used when you need to remove specific log entries, potentially for data management, privacy, or housekeeping purposes. the operation requires that connect be enabled on the account and that the user has account administrator privileges. it's important to note that this action is irreversible and will permanently remove the selected log entries, so it should be used with caution. the endpoint does not provide a way to retrieve or view the log entries before deletion, so ensure you have identified the correct entries to be deleted before using this function.

Delete Connect Oauth Configuration

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 oauth integration for an account. this operation is irreversible and will immediately stop any active connect oauth-based integrations for the specified account. only account administrators can perform this action, and connect must be enabled on the account for this endpoint to work. it's important to note that this deletion only affects the oauth configuration for connect and does not impact other docusign integrations or the account itself.

Delete Contact From Account

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 contacts for the account. this operation is irreversible, so it should be used with caution. the endpoint does not provide any confirmation or undo functionality, so ensure the correct contact id is specified before making the call.

Delete Custom Document Fields

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. the operation is performed on a specific document within a specific envelope, identified by their respective ids. use this endpoint when you need to manage or update the custom fields of a document, ensuring that only necessary and current information is retained.

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 operation is irreversible, so caution should be exercised when using it. this endpoint only removes custom fields and does not affect other aspects of the template or document.

Delete Custom Fields In Template

This endpoint deletes specified custom fields from a docusign template. it allows users to remove both list and text custom fields that are no longer needed or relevant for the template. the operation is performed on a specific template identified by the templateid within a given docusign account specified by the accountid. users can selectively delete custom fields by providing arrays of listcustomfields and/or textcustomfields in the request body. if successful, the response will contain information about the remaining custom fields in the template. this endpoint is useful for maintaining and updating templates by removing outdated or unnecessary custom fields, thereby streamlining the document creation process.

Delete Custom Tab Information

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 the specific custom tab id to ensure precise deletion. this endpoint is particularly useful for maintaining a clean and relevant set of custom tabs in your docusign account, especially when managing large numbers of custom fields. note that this operation cannot be undone, so it's advisable to confirm the deletion with the user before proceeding.

Delete Custom User Settings

Deletes specified custom user settings for a single docusign user. this endpoint allows for the removal of both grouped and ungrouped custom settings, providing flexibility in managing user preferences. it's particularly useful for cleaning up or resetting user-specific configurations within a docusign account. the operation requires careful use of parameters to ensure only intended settings are deleted, and it's important to note that users can only modify their own settings.

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 called once the delay is already in progress. after deletion, the workflow step will still contain a 'pause before' action, requiring manual unpausing of the envelope when the step is reached. for complete removal of the step, use the deleteenvelopeworkflowstepdefinition endpoint instead. this tool is crucial for managing and adjusting envelope workflows in docusign, particularly when dealing with time-sensitive documents or when workflow changes are necessary.

Delete Delayed Routing Rules For Template

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 or simplifying complex template workflows. use with caution as this operation is irreversible and may impact the behavior of documents generated from this template in the future. this endpoint does not affect already sent envelopes or documents.

Delete Draft Envelope Attachments

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 managing signer attachments. the endpoint supports deleting multiple attachments in a single request, making it efficient for bulk operations. as this is a beta api, it may be subject to changes in future versions.

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 irreversible, so caution should be exercised before deletion. this endpoint only deletes the configuration; it does not affect any existing enotes or other account settings. be aware that as this is a beta api, it may be subject to changes or instability. always test thoroughly in a non-production environment before using in critical systems.

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 identify the target envelope. after deletion, the endpoint returns the updated custom fields structure, reflecting the changes made. this functionality is useful for managing and updating envelope metadata, particularly for sorting, organizing, and searching envelopes or integrating with external systems like salesforce.

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, such as reply-to address overrides or bcc recipients. the deletion is permanent and cannot be undone, so use with caution. this operation requires appropriate account permissions and should be used when standardizing email communications for an envelope or removing outdated customizations.

Deleteenvelopelock

The deleteenvelopelock endpoint removes the lock from a specified envelope in docusign, allowing it to be modified again. this operation is crucial for managing document workflows where temporary locks are used to prevent concurrent edits. the endpoint requires the x-docusign-edit header for authentication and can optionally save or discard changes made during the lock period. it's important to note that only the user who initially locked the envelope can delete the lock, ensuring security and consistency in the document management process.

Delete Envelope Scheduled Sending Rules

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 are necessary. the operation is irreversible and should be used with caution. importantly, this endpoint cannot be called once the scheduled sending countdown has begun, limiting its use to the period before the scheduled send time approaches. this tool helps in maintaining flexibility in document scheduling within the docusign system.

Delete Envelope Transfer Rule

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 operation is permanent and cannot be undone, so caution should be exercised. this endpoint requires administrator privileges and the "transfer custody" feature to be enabled for the account. it will not provide information about the deleted rule or affect existing transferred envelopes.

Delete Envelope Workflow Definition

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 is useful for modifying envelopes that were set up with automated workflows but now require changes. after deletion, to send the envelope, you must update its status to 'sent' using a separate envelopes::update method. use this endpoint cautiously, as it will remove all workflow settings for the envelope and cannot be undone.

Delete Envelope Workflow Step

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 outdated steps. it's particularly useful for simplifying complex workflows or correcting mistakenly added steps. be cautious when using this endpoint, as deleting a workflow step is irreversible and may impact the envelope's processing sequence. ensure you have the correct workflowstepid before proceeding with the deletion to avoid unintended consequences.

Delete Existing Workspace Logically

Logically deletes an existing workspace in docusign. this endpoint should be used when you need to remove a workspace from active use without permanently erasing its data. the deletion is logical, meaning the workspace is marked as deleted but can potentially be recovered if needed. this operation requires specific identification of the account and workspace, and returns detailed information about the deleted workspace upon success. use this endpoint with caution, as it will make the workspace inaccessible to users.

Delete Members From Signing Group

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 leaves the organization or changes roles. the endpoint requires the account id and signing group id to identify the correct group, and accepts a list of users to be removed. it's important to note that this operation is irreversible, so care should be taken to ensure the correct users are being removed. this endpoint does not provide the ability to add new members or modify existing member information.

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 contact lists. the endpoint accepts a list of contact ids and returns details of the deleted contacts or error information if the deletion was unsuccessful for any contact. note that this operation is irreversible, so it should be used with caution. it's recommended to verify the contacts to be deleted before making the api call.

Delete Notary Jurisdiction

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 operation is irreversible, so it should be used with caution. it's important to note that this endpoint only deletes the jurisdiction and does not affect the notary's overall status or their ability to operate in other jurisdictions. the endpoint supports a limited set of jurisdictions, primarily u.s. states, and will return an error if an unsupported jurisdiction id is provided. after successful deletion, any attempts to use the deleted jurisdiction for notary activities will fail.

Delete One Or More Signing Groups

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 your account. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this action does not delete the individual users within the groups, only the group associations.

Delete Page From Document In Envelope

Deletes a specific page from a document within an envelope in docusign. this endpoint allows you to remove a single page from a document based on its page number. it's useful for modifying documents after they've been added to an envelope but before the envelope has been sent for signing. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires specific identification of the account, envelope, document, and page number to ensure precise targeting of the deletion operation.

Delete Page From Template Document

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 outdated pages. note that this operation is irreversible, so ensure you have a backup or are certain about deleting the page. this tool only deletes a single page at a time and does not provide options for bulk page deletion or document replacement.

Delete Powerform By Id

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 powerform from your account, such as when it's no longer needed or has been replaced by a new version. be cautious when using this endpoint, as the deletion is irreversible and will remove all associated data and access to the powerform. ensure you have the correct powerform id and account context before proceeding with the deletion to avoid unintended data loss. this operation is typically used for maintenance, compliance, or organizational purposes within your docusign account management workflow.

Delete Request Log Files

Deletes all request log files associated with the docusign api. this endpoint is part of the diagnostics service and is used for maintenance and troubleshooting purposes. it should be used when you need to clean up or remove accumulated request logs, which can help in managing storage and maintaining system performance. the operation does not require any parameters and will delete all available request logs. use this endpoint with caution, as deleted logs cannot be recovered. it's recommended to backup any critical log data before performing this operation.

Delete Scheduled Sending Rules

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 configurations. be cautious when using this endpoint, as it permanently removes all scheduled sending rules for the specified template, and this action cannot be undone. ensure that you have the correct template id and that removing the scheduled sending is indeed the intended action, as it may impact automated document workflows within your organization.

Delete Signature For Captive Recipients

This endpoint deletes the signature for one or more captive (embedded) recipient records in docusign. it is primarily designed for testing purposes, allowing developers to reset the signature associated with a client user id. this enables the creation of a new signature the next time the client user id is used. the endpoint should be used when testing signature workflows or when it's necessary to clear existing signatures for embedded recipients. it's important to note that this operation is not intended for regular production use and should be employed cautiously, as it permanently removes signature data. the endpoint requires specifying the account id and confirming that the operation is for the 'signature' part of the recipient information. the request body should include details of the captive recipients whose signatures are to be deleted, primarily identified by their clientuserid.

Delete Specific Connect Log Entry

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 for data management or privacy reasons, or when you want to clear all logs for an account. the operation requires account administrator privileges and the connect feature must be enabled on the account. it's important to note that this action is irreversible, so use it with caution, especially when deleting all logs.

Delete Specified Account

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 implications for access to documents and user data associated with the account. the optional redact user data parameter allows for additional data privacy measures during deletion. this endpoint should be used when an organization needs to completely shut down their docusign account, such as when ceasing operations or consolidating multiple accounts.

Delete Stamp Image For Account

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 deleted (stamp, signature, or initials), and the specific signature id. it's important to note that this action is irreversible, so it should be used with caution. the endpoint will return detailed information about the signature after deletion, including any remaining associated images and properties. this tool should be used when a user needs to remove a stamp image from their account, but not when they want to modify or update an existing stamp image.

Deletetemplatefromenvelopedocument

This endpoint deletes a specified template from a document within an existing envelope in docusign. it allows users to remove a template that has been previously applied to a document, providing flexibility in managing document content and structure. this operation is useful when you need to update or modify the document by removing a specific template, perhaps to replace it with a different one or to revert the document to its original state. it's important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly valuable in workflows where document templates need to be dynamically managed or updated based on changing requirements or corrections.

Delete Template Lock

Deletes the lock from a specified template in docusign. this endpoint allows users to remove a lock they previously placed on a template, with the option to save or discard changes made during the lock period. it should be used when a user wants to release their lock on a template, either after making changes or deciding to abandon modifications. the endpoint requires the user deleting the lock to be the same user who initially locked the template, ensuring security and preventing unauthorized lock removals. it's important to note that this operation requires the x-docusign-edit header for authentication.

Delete Template Workflow Step

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 removing an unnecessary approval step or simplifying the signing process. the operation is permanent and cannot be undone, so users should exercise caution when deleting workflow steps. this endpoint is particularly useful for maintaining and optimizing document workflows in response to changing business processes or requirements.

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 providers through docusign. this operation is particularly useful for managing security, updating integrations, or removing unused cloud storage connections. the endpoint requires specific account and user identifiers and accepts a list of storage providers to be affected. it's important to note that this action only removes the authentication link within docusign and does not affect the user's actual account with the cloud storage provider.