Docusign
Overview
Enum
DOCUSIGN
Description
DocuSign provides eSignature and digital agreement solutions, enabling businesses to send, sign, track, and manage documents electronically
Authentication Details
OAUTH2
Actions
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.
Action Parameters
Action Response
DOCUSIGN_ADD_EMAIL_OVERRIDES_TO_ENVELOPE
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_ADD_FILE_TO_WORKSPACE
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_ADD_OR_UPDATE_ACCOUNT_STAMPS
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_ADD_OR_UPDATE_USER_SIGNATURE
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_APPLY_ACTION_TO_BULK_SEND_ENVELOPES
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.
Action Parameters
Action Response
DOCUSIGN_CHANGE_USERS_IN_ACCOUNT
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.
Action Parameters
Action Response
DOCUSIGN_CLOSE_USERS_IN_ACCOUNT
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_CREATE_BCC_EMAIL_ARCHIVE_CONFIGURATION
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_CREATE_CUSTOM_TAB_WITH_PROPERTIES
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_DOCUMENT_RESPONSIVE_HTML_PREVIEW
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATE
Creates and sends an envelope using a template. allows multiple recipients with different roles and routing orders.
Action Parameters
Action Response
DOCUSIGN_CREATE_GROUPS_FOR_ACCOUNT
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_IDPROOF_RESOURCE_TOKEN_FOR_RECIPIENT
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_NEW_ACCOUNT_PERMISSION_PROFILE
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_NOTARY_JURISDICTION_OBJECT
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_OR_UPDATE_USER_AUTHORIZATIONS
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTML
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTML_IN_ENVELOPE
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_RECIPIENT_MANUAL_REVIEW_LINK
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_RECIPIENT_PREVIEW_FOR_ENVELOPE
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_RECIPIENT_VIEW_URL
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_CREATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDS
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_CREATE_TEMPLATE_RESPONSIVE_HTML_PREVIEW
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_CREATE_URLFOR_TEMPLATE_EDIT_VIEW
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.
Action Parameters
Action Response
DOCUSIGN_CREATE_USER_AUTHORIZATION_FOR_AGENT_USER
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_BRAND_FROM_GROUP
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.
Action Parameters
Action Response
DOCUSIGN_DELETE_BRAND_LOGO_BY_TYPE
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_CONNECT_LOG_ENTRIES
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDS_FROM_TEMPLATE
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_DELAYED_ROUTING_RULE_FOR_ENVELOPE_STEP
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_ENOTE_CONFIGURATION
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.
Action Parameters
Action Response
DOCUSIGN_DELETE_ENVELOPE_CUSTOM_FIELDS
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.
Action Parameters
Action Response
DOCUSIGN_DELETE_ENVELOPE_EMAIL_SETTINGS
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.
Action Parameters
Action Response
DOCUSIGN_DELETE_ENVELOPE_LOCK
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_MULTIPLE_CONTACTS_FROM_ACCOUNT
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_POWER_FORM_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_TEMPLATE_FROM_ENVELOPE_DOCUMENT
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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_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.
Action Parameters
Action Response
DOCUSIGN_DELETE_USERS_FROM_GROUP
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 memberships, such as when employees leave a company or change roles. it returns detailed information about the deleted users and the operation’s success. note that this operation permanently removes users from the specified group and should be used cautiously.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_AUTHORIZATION
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 should be used cautiously. this tool is particularly useful for managing access control and maintaining security by removing outdated or unnecessary user permissions. it does not provide information about existing authorizations or create new ones; it solely focuses on deletion.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_AUTHORIZATIONS
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. it’s particularly useful for managing user access control, updating user roles, or removing outdated permissions. the endpoint requires the account id and user id to be specified, along with a list of authorization ids to be deleted. it returns a detailed response indicating the success or failure of each deletion attempt, including any error messages. this endpoint should be used cautiously as it directly impacts user access within the docusign system.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_AUTH_FOR_CLOUD_STORAGE_PROVIDERS
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.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_CLOUD_STORAGE_AUTHENTICATION
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 storage provider through docusign, they will need to go through the full authentication process again. this endpoint is particularly useful for security purposes, such as when you need to revoke access or troubleshoot authentication issues. it’s important to note that this operation only affects the specified user and cloud storage provider combination, and does not impact other users or other cloud storage integrations for the same user.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_GROUP
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, so use it with caution. this endpoint only deletes the group itself and does not affect the individual users who were members of the group. after deletion, any permissions or settings associated with the group will no longer apply to its former members.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_INITIALS_OR_SIGNATURE_IMAGE
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 image. it’s important to note that this endpoint can only delete one type of image per call - to delete both initials and signature images, the endpoint must be called twice. the endpoint requires user authentication and can only be used to delete the authenticated user’s own images. the response includes detailed information about the user’s signature, including creation date, image uris, and signature properties.
Action Parameters
Action Response
DOCUSIGN_DELETE_USER_PROFILE_IMAGE
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 with admin rights cannot delete another user’s profile image. the endpoint requires both the account id and the user id to be specified, ensuring that the operation is performed on the correct user within the correct account. after successful deletion, the user’s profile will no longer have an associated image. this endpoint does not provide the ability to upload a new image; it only removes the existing one.
Action Parameters
Action Response
DOCUSIGN_DELETE_WORKFLOW_DEFINITION_FOR_TEMPLATE
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 workflow configurations. the operation is idempotent, meaning it will return a successful response even if the template doesn’t have a workflow definition. this feature allows for safe, repeated calls without causing errors.
Action Parameters
Action Response
DOCUSIGN_DELETE_WORKSPACE_FILES_OR_FOLDERS
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 cleaning up multiple items at once. it’s important to note that this action is irreversible, so users should exercise caution when selecting items for deletion. the workspace must have an ‘active’ status for this operation to succeed. this endpoint should not be used for temporary file management or as a means of archiving, as deleted items cannot be recovered through the api.
Action Parameters
Action Response
DOCUSIGN_DEPRECATED_ENDPOINT_FOR_TAB_BLOB
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 and an envelope identifier to target the correct set of tabs for updating. while it can modify tab data, the exact nature of the modifications and the format of the tab blob are not specified in the provided schema. the endpoint returns a simple success response or an error response with details if the operation fails. developers should seek alternative, supported methods for managing tabs in docusign envelopes.
Action Parameters
Action Response
DOCUSIGN_EXPORT_BRAND_TO_XMLFILE
This endpoint exports information about a docusign brand to an xml file. it allows users to retrieve structured brand data for an account, which can be useful for backup, analysis, or integration purposes. the endpoint should be used when there’s a need to extract comprehensive brand information in a standardized format. note that this operation is only available if branding for either signing or sending is enabled for the account (canselfbrandsend or canselfbrandsign must be set to true). the exported xml file contains all relevant brand settings and configurations associated with the specified brand id.
Action Parameters
Action Response
DOCUSIGN_FETCH_RECIPIENT_NAMES_FOR_EMAIL
Retrieves a list of all names associated with a specified email address in docusign. this endpoint is useful for identifying multiple recipients or name variants linked to a single email. it can be used to verify recipient information before sending documents for signature or to manage recipient data in your docusign integration. the endpoint returns not only the names but also indicates if the email is used by multiple users and if new names can be added to it. this information is valuable for maintaining accurate recipient records and ensuring proper document routing in complex signing scenarios.
Action Parameters
Action Response
DOCUSIGN_GENERATE_EDIT_VIEW_URLFOR_ENVELOPE
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 for editing envelope details, recipients, and documents.
Action Parameters
Action Response
DOCUSIGN_GENERATE_ENVELOPE_CORRECTION_URL
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 correction interface, allowing users to modify and update envelope details securely within your application.
Action Parameters
Action Response
DOCUSIGN_GET_ACCOUNT_BILLING_CHARGES_LIST
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 account administrators to analyze current usage, understand the pricing structure, and make informed decisions about service utilization. the response includes data on charges such as envelope usage, seat allocations, and additional services like id checks or in-person signings. note that this endpoint requires account administrator privileges and does not provide historical billing data or future projections.
Action Parameters
Action Response
DOCUSIGN_GET_ACCOUNT_PASSWORD_RULES
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 administrators to review and understand the current security posture of their docusign account. the retrieved information can be used to ensure compliance with organizational security policies or to plan password policy updates. this endpoint does not modify any settings; it is for informational purposes only.
Action Parameters
Action Response
DOCUSIGN_GET_ACCOUNT_STAMP_IMAGE
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 documents or applications. the endpoint returns the actual image file in gif format, not just metadata. it supports retrieving different types of images (stamp, signature, or initials) and offers an option to include or exclude the chrome (frame) around the image.
Action Parameters
Action Response
DOCUSIGN_GET_AGENT_USER_AUTHORIZATIONS
Retrieves user authorizations for a specified agent user within a docusign account. this endpoint allows you to fetch detailed information about the permissions granted to an agent user to act on behalf of other users in the account. it’s particularly useful for managing and auditing user access levels, especially in larger organizations with complex permission structures. the endpoint supports various filtering options and pagination, enabling efficient retrieval of specific authorization data.
Action Parameters
Action Response
DOCUSIGN_GET_API_REQUEST_LOG_SETTINGS
Retrieves the current api request logging settings for the authenticated user in docusign. this endpoint provides information about whether api request logging is enabled, the maximum number of log entries allowed, and the remaining number of entries that can be logged. it is useful for developers and administrators who need to monitor or troubleshoot api usage, manage log storage, or ensure compliance with logging policies. the endpoint should be used when you need to check the current state of api request logging or verify remaining log capacity. it does not modify any settings or create new log entries.
Action Parameters
Action Response
DOCUSIGN_GET_BCCEMAIL_ARCHIVE_HISTORY
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 about each change, including who made the change, when it was made, and the nature of the change. the endpoint supports pagination for efficient retrieval of large result sets.
Action Parameters
Action Response
DOCUSIGN_GET_BCC_EMAIL_ARCHIVE_CONFIGURATIONS
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 comprehensive information about each bcc email archive configuration, including its status, creation date, and associated user details. this tool is useful for auditing or managing bcc email archiving settings within a docusign account.
Action Parameters
Action Response
DOCUSIGN_GET_BRANDS_INFORMATION_FOR_GROUP
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 useful for administrators managing multiple brands across different groups within an organization. the endpoint should be used when there’s a need to review or audit brand assignments, customize group-specific branding, or prepare for brand updates within a group context. it does not modify any brand settings but offers a read-only view of the current brand configuration for the specified group.
Action Parameters
Action Response
DOCUSIGN_GET_BRAND_LOGO_BY_TYPE
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 communications. the endpoint requires branding to be enabled for the account (either for signing, sending, or both). use this when you need to display or verify the current logo for a specific brand and logo type within your docusign integration.
Action Parameters
Action Response
DOCUSIGN_GET_BULK_SEND_BATCH_STATUS
Retrieves the general status of a specific bulk send batch in docusign. this endpoint provides detailed information about the progress and outcomes of a bulk send operation, including the number of successfully sent envelopes, pending envelopes, and any errors encountered. it’s useful for monitoring large-scale document sending operations and identifying issues that may require attention. use this endpoint to track batch progress, verify success rates, or investigate failures in high-volume document workflows.
Action Parameters
Action Response
DOCUSIGN_GET_BULK_SEND_LISTS_INFORMATION
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 operations, allowing users to get an overview of their available bulk send lists. this tool should be used when you need to inventory or manage bulk send lists for high-volume document distribution. it does not provide detailed information about the contents of each list or allow for modification of the lists. the response is limited to basic summary information and does not include the actual recipients or documents associated with each list.
Action Parameters
Action Response
DOCUSIGN_GET_DEFAULT_CONSUMER_DISCLOSURE
Retrieves the default html-formatted electronic record and signature disclosure (ersd) associated with a docusign account. this endpoint is used to obtain the standard disclosure provided by docusign for u.s.-based customers, which is valid only for transactions between u.s.-based parties. it allows retrieval of the disclosure in multiple languages and provides comprehensive details about the ersd, including company information, withdrawal methods, and the full text of the esign agreement.
Action Parameters
Action Response
DOCUSIGN_GET_DOCUSIGN_ACCOUNT_CONTACTS
Retrieves contact information associated with a docusign account. this endpoint allows users to fetch either a specific contact using the contactid or all contacts if the contactid is omitted. it supports retrieving contacts from both the default docusign address book and connected cloud storage providers. the endpoint is particularly useful for accessing detailed contact information, including personal details, phone numbers, email addresses, notary certifications, and signing group associations. it should be used when needing to access or update contact information within a docusign workflow. note that phone numbers for shared contacts may have limited visibility to users other than the contact creator.
Action Parameters
Action Response
DOCUSIGN_GET_DOWNGRADE_PLAN_INFO_FOR_ACCOUNT
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 used when managing account billing changes, specifically when an account holder has initiated or is considering a plan downgrade. the tool is particularly useful for account administrators or billing departments to review and process downgrade requests. note that this endpoint only provides information about existing downgrade requests and does not initiate new downgrades or make changes to the account’s current plan.
Action Parameters
Action Response
DOCUSIGN_GET_ELECTRONIC_DISCLOSURE_FOR_RECIPIENT
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 recipient’s language settings. it is particularly useful when you need to present the exact disclosure that a recipient will see before they sign a document, ensuring compliance with electronic signature regulations and providing transparency in the signing process.
Action Parameters
Action Response
DOCUSIGN_GET_ELECTRONIC_RECORD_AND_SIGNATURE_DISCLOSURE
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 supports multiple languages through the ‘langcode’ parameter, enabling you to retrieve the disclosure in various supported languages or automatically detect the user’s browser language. this tool is particularly useful when setting up new accounts, updating disclosures, or ensuring compliance with multi-language requirements. note that while it retrieves the default english disclosure by default, custom disclosures in different languages can be accessed if they have been created for the account. the response includes comprehensive details about the disclosure, including withdrawal options, company information, and the full html-formatted ersd text.
Action Parameters
Action Response
DOCUSIGN_GET_ENOTE_INTEGRATION_SETTINGS
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 integration for an account. the endpoint returns details such as api key, organization name, and user credentials, which are essential for configuring the enote feature. note that this endpoint is in beta, so its behavior or response structure may change in future updates. it’s important to ensure that the account has the “allow enote for eoriginal” plan item enabled for full functionality.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE
Gets the status and basic information about an envelope from docusign. this action retrieves detailed information about a specific envelope, including: - envelope status (created, sent, delivered, completed, declined, voided) - creation and sent timestamps - subject and message - recipient information and their status - document details - envelope metadata
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_DOCUMENT_FIELDS
Retrieves the custom document field information from an existing envelope document. the documentid must be a positive 32-bit signed integer (1 through 2147483647). typically the first document has id 1, the second document id 2, and so on, but you can use any numbering scheme within the valid range.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_DOC_GEN_FORM_FIELDS
Given an envelopeid, this method returns the sender fields found in that envelope’s documents. after you retrieve the sender fields, you can use the documentgeneration::updateenvelopedocgenformfields method to populate the fields.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_LOCK_INFORMATION
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 envelopes. the caller must be the same user who initially locked the envelope. use this endpoint when you need to verify the lock status of an envelope or retrieve the lock token for subsequent operations. it does not modify the lock itself but provides essential information for lock management.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_NOTIFICATION_DEFAULTS
Retrieves the default email notification settings for envelopes in a docusign account. this endpoint provides a comprehensive overview of the notification preferences for both senders and signers, covering various events in the envelope lifecycle such as envelope completion, delivery failures, and signer changes. it’s particularly useful when setting up a new account or reviewing existing notification configurations to ensure optimal communication with all parties involved in the signing process. the returned settings serve as a template for envelope-specific notifications but can be overridden on a per-envelope basis if needed.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_WORKFLOW_DEFINITION
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 progression of an envelope’s workflow. the endpoint returns a comprehensive workflow object, including the current step, scheduled resume date, and an array of all workflow steps with their respective statuses and configurations.
Action Parameters
Action Response
DOCUSIGN_GET_ENVELOPE_WORKFLOW_DELAYED_ROUTING_DEFINITION
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 settings, scheduled send time, and status of a delayed routing step. the endpoint returns detailed information about the resume date, delay rules, and current status of the delayed routing. it should be used when you need to verify or inspect the delayed routing configuration for a specific envelope and workflow step. note that this endpoint will return a 404 error if the specified workflow step does not have a delayed routing object associated with it.
Action Parameters
Action Response
DOCUSIGN_GET_GROUPS_INFORMATION_FOR_ACCOUNT
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 organize users within their docusign environment. the endpoint supports pagination, filtering by group type, and text-based searching, making it versatile for various group management tasks. note that while it provides group information, it does not directly return the list of users within each group; a separate api call is required for that purpose.
Action Parameters
Action Response
DOCUSIGN_GET_LIST_OF_ACCOUNT_PERMISSION_PROFILES
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 essential for account administrators who need to review, audit, or manage user access levels and capabilities within their docusign environment. it can be used to understand the current permission structure, identify profiles that may need updates, or verify that the appropriate access levels are set for different user groups.
Action Parameters
Action Response
DOCUSIGN_GET_MEMBERS_OF_A_SIGNING_GROUP
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 proper document routing and signing workflows. note that this endpoint only provides information and does not allow group modification.
Action Parameters
Action Response
DOCUSIGN_GET_NOTARY_JURISDICTIONS_FOR_USER
Retrieves a list of notary journals for a user in the docusign system. this endpoint allows users to fetch detailed information about notary sessions, including creation dates, document names, jurisdiction details, and signer information. it’s particularly useful for notaries who need to review their past notarizations or for administrators managing notary activities. the endpoint supports pagination and filtering, making it efficient for handling large sets of journal entries.
Action Parameters
Action Response
DOCUSIGN_GET_NOTARY_JURISDICTION_OBJECT
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 crucial data for notaries to understand their authority and limitations within a particular area. the endpoint can only be accessed by authenticated users who are registered notaries, and the requested jurisdiction must be one that the notary is authorized for. it does not provide information about jurisdictions the notary is not registered for or allow modifications to the jurisdiction data.
Action Parameters
Action Response
DOCUSIGN_GET_NOTARY_USER_SETTINGS
Retrieves the settings and information for the currently authenticated notary user in the docusign system. this endpoint provides comprehensive details about the notary’s account configuration, including personal information, user settings, and optionally, information about supported jurisdictions. it should be used when detailed information about a notary user’s account and capabilities is required, such as during account management or when verifying a notary’s jurisdictional authority. the endpoint is specifically designed for notary users and will not work for regular docusign users. it’s important to note that the response contains sensitive information, so proper authorization and security measures should be in place when using this endpoint.
Action Parameters
Action Response
DOCUSIGN_GET_ORIGINAL_HTML_DEFINITION_FOR_TEMPLATE
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 that control the appearance and behavior of the template during signing. this tool is essential for developers who need to understand or modify the responsive signing experience for a specific template.
Action Parameters
Action Response
DOCUSIGN_GET_PAGE_IMAGE_FROM_ENVELOPE
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 can be customized in terms of resolution and dimensions. this tool is ideal for applications that need to show document previews or allow users to view specific pages of a document without downloading the entire file. it should not be used for document modification or to extract text content from the document.
Action Parameters
Action Response
DOCUSIGN_GET_PDFTRANSCRIPT_OF_ENVELOPE_COMMENTS
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 when a consolidated view of all comments is needed, such as for review, auditing, or record-keeping purposes. the response is a pdf file returned as a byte stream, which can be saved or processed as needed. note that the comments feature must be enabled in the account settings (set ‘enablesigningextensioncomments’ to true in accountsettingsinformation) for this endpoint to function. this tool does not provide individual comments or allow for adding or modifying comments.
Action Parameters
Action Response
DOCUSIGN_GET_PERMISSION_PROFILE_FOR_ACCOUNT
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 role settings, user settings, api access levels, and other configuration options. note that this endpoint is read-only and cannot modify profile settings.
Action Parameters
Action Response
DOCUSIGN_GET_POWER_FORM_SENDERS
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 account details, email, and login status. the response is paginated, allowing for efficient retrieval of large datasets. this tool should be used when you need to audit powerform sender activity or generate reports on powerform usage within an account.
Action Parameters
Action Response
DOCUSIGN_GET_RECIPIENT_DOCUMENT_VISIBILITY
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 configuration for a recipient in an envelope. it’s particularly useful in workflows where different recipients may have varying levels of access to documents within the same envelope. the method returns detailed visibility information but does not modify any settings.
Action Parameters
Action Response
DOCUSIGN_GET_REQUEST_LOGGING_LOG_FILE
Retrieves detailed information for a single api request log entry from docusign’s diagnostics service. this endpoint is crucial for debugging and troubleshooting api interactions. it returns the complete request and response data for a specific api call. the log entry can be retrieved as a base64 encoded string or binary data, controlled by the content-transfer-encoding header. use this endpoint to investigate specific api calls, understand errors, or verify exchanged data during docusign api interactions.
Action Parameters
Action Response
DOCUSIGN_GET_SIGNATURE_INFORMATION_FOR_RECIPIENT
Retrieves detailed signature information for a specific signer or sign-in-person recipient within a docusign envelope. this endpoint provides comprehensive data about the recipient’s signature, including the signature image, adoption date, various properties, and associated metadata. it’s particularly useful when you need to access or verify a recipient’s signature details after they have signed a document or when you want to retrieve the current state of a recipient’s signature within an ongoing envelope process. the endpoint returns a rich set of information, including the base64-encoded signature image, signature type, stamp properties, and related timestamps. this tool should be used when detailed signature information is required for auditing, verification, or display purposes within your application. note that this endpoint focuses solely on signature information and does not provide other envelope or recipient status details.
Action Parameters
Action Response
DOCUSIGN_GET_SIGNING_GROUP_INFORMATION
Retrieves comprehensive information about a specific signing group, including details about its members. this endpoint is essential for managing and auditing signing groups within a docusign account. it provides valuable data such as the group’s creation date, email, name, type, and a list of all members with their respective email addresses and usernames. use this endpoint when you need to inspect the composition and properties of a particular signing group, which is crucial for maintaining accurate records and ensuring proper configuration of e-signature workflows involving group-based signers. the endpoint is particularly useful for administrative tasks, troubleshooting, or when integrating signing group functionality into custom applications. note that this endpoint only returns information for ‘sharedsigninggroup’ types and does not modify any existing data.
Action Parameters
Action Response
DOCUSIGN_GET_SPECIFIC_BRAND_RESOURCE_FILE
Retrieves a specific branding resource file for customizing docusign experiences. this endpoint allows users to access and manage brand resource files that control sending, signing, email, and captive (embedded) signing experiences. it’s particularly useful when you need to retrieve customized branding elements or the master resource file for a specific brand within an account. the endpoint supports localization and can return either the full master resource file or only the modified elements, depending on the parameters used. note that this endpoint requires branding to be enabled for the account (either for sending, signing, or both).
Action Parameters
Action Response
DOCUSIGN_GET_SPECIFIED_ACCOUNT_STAMP_INFO
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 to access or verify the properties of a specific signature within an account. the endpoint provides a wealth of information but requires both the account id and the specific signature id to function.
Action Parameters
Action Response
DOCUSIGN_GET_SUPPORTED_LANGUAGES_FOR_RECIPIENTS
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 useful when implementing localization features or providing language choices to users in multi-lingual environments. the endpoint returns both the human-readable language names and their corresponding language codes, which can be used in subsequent api calls to set recipient languages. note that this only affects docusign’s standard text elements and does not translate custom email content.
Action Parameters
Action Response
DOCUSIGN_GET_TABS_BLOB_FOR_ENVELOPE
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, developers should seek alternative methods for accessing tab information in new implementations. the endpoint requires both an account id and an envelope id to identify the specific envelope and account for which to retrieve the tabs blob. use this endpoint cautiously and only if absolutely necessary for legacy systems, as it may be removed in future api versions.
Action Parameters
Action Response
DOCUSIGN_GET_TAB_SETTINGS_FOR_ACCOUNT
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 for the account. it’s particularly useful for administrators or developers who need to understand the available tab options before creating or modifying documents within the account. the response includes both the enabled/disabled status of each setting and associated metadata, offering insights into compliance requirements and editability of these settings. this tool should be used when there’s a need to audit or verify the account’s tab configuration, especially before implementing new document workflows or integrations that rely on specific tab functionalities.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE
Gets a template definition from the specified account. you can include additional template attributes in the response by using the include parameter: - powerforms: includes information about powerforms - tabs: includes information about tabs - documents: includes information about documents - favorite template status: includes the template favoritedbyme property
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATES_FOR_ENVELOPE_DOCUMENT
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 when you need to retrieve template information for a particular document in an existing envelope, such as for template auditing or document-specific template applications. the endpoint returns detailed information about each associated template, including its id, name, and matching details, but does not provide the actual template content or allow for template modifications.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATES_USED_IN_ENVELOPE
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 envelope or finding matching templates for an existing envelope. it can be used to audit envelope contents, analyze template usage, or prepare for envelope modifications. the response includes an array of template summaries, offering a comprehensive view of how templates are utilized within the specified envelope.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_DELAYED_ROUTING_RULES
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 recipients associated with the workflow step. the endpoint should be used when you need to review or verify the delayed routing settings for a template, particularly in automated document workflows. note that if the specified workflow step does not have a delayed routing object, this method will return a 404 error.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_DOCUMENT_HTML_DEFINITION
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 useful when implementing responsive signing features or when you need to understand the structure and display properties of a template document. the response includes detailed information about html definitions, such as display settings, anchors, and formatting options, which can be used to render the document in a responsive manner across different devices and screen sizes.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_LOCK_INFORMATION
Retrieves general information about a template lock in docusign. this endpoint allows users to obtain details about an existing lock on a specific template, including the lock duration, the user who applied the lock, the expiration date, and the unique lock token. it is particularly useful for recovering lock information when a user needs to manage or update a locked template. the endpoint should be used when a user needs to verify the status of a template lock or retrieve the lock token for subsequent operations. it’s important to note that only the user who initially locked the template can request this information, ensuring security and preventing unauthorized access to lock details. the response includes the x-docusign-edit header, which provides additional context about the lock.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_NOTIFICATION_INFORMATION
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 settings, reminder configurations, and whether account default settings are being used. this tool is useful for reviewing and auditing template notification settings before creating envelopes or when troubleshooting notification-related issues with template-based envelopes. the response includes complex objects for expirations and reminders, giving a comprehensive view of the template’s notification setup.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITY
This endpoint retrieves document visibility information for a specific recipient of a docusign template. it allows users to check which documents within the template are visible to the recipient and what access rights (read-only or editable) they have for each document. this tool is essential for managing document access and permissions in complex signing workflows, ensuring that sensitive information is only shared with the appropriate recipients. the endpoint returns a list of documentvisibility objects, providing detailed information about each document’s visibility and access rights for the specified recipient.
Action Parameters
Action Response
DOCUSIGN_GET_TEMPLATE_SCHEDULED_SENDING_SETTINGS
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 timing of envelope distribution. the endpoint returns detailed information about the scheduled sending rules, including any delays or specific send dates, as well as the current status of the scheduled sending job. it should be used when you need to inspect or verify the scheduled sending configuration of a template, especially in scenarios involving automated or timed document processing. note that this endpoint will return a 404 error if the template’s workflow does not have a scheduled sending object, indicating that no scheduled sending has been configured for the template.
Action Parameters
Action Response
DOCUSIGN_GET_UNSUPPORTED_FILE_TYPES_LIST
Retrieves a comprehensive list of file types (both mime-types and file extensions) that are not supported for upload through the docusign system. this endpoint is crucial for developers and users who need to understand which file formats cannot be processed by docusign, helping to prevent errors and improve the efficiency of document uploads. use this endpoint when you need to validate file types before attempting to upload documents to docusign, or when creating user interfaces that guide users on acceptable file formats. the returned list can be used to implement client-side validation or to provide informative messages to users about unsupported file types. note that this list may change over time as docusign updates its supported file types, so it’s recommended to check periodically for any updates.
Action Parameters
Action Response
DOCUSIGN_GET_URLFOR_EMBEDDING_DOCUSIGN_UI
This endpoint returns a url that enables embedding the docusign ui in your applications, providing seamless integration of electronic signing capabilities. it’s primarily used to generate console views or sender views based on the provided parameters. the endpoint requires an accountid and optionally accepts an envelopeid and returnurl in the request body. when an envelopeid is provided, the behavior varies: 1. for sent envelopes, it returns a url for viewing envelope documents. 2. for draft envelopes, it returns a url for the sender view, with an optional returnurl for redirection. 3. if no envelopeid is specified, it returns a url for the front page of the demo ui. this endpoint provides full access to the sending account, so it should be used cautiously and securely. it’s ideal for scenarios where you need to embed docusign functionality directly within your application’s interface, enhancing user experience and workflow efficiency.
Action Parameters
Action Response
DOCUSIGN_GET_USERS_IN_GROUP
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 large groups efficiently, making it suitable for applications that need to display or process user data in manageable chunks. the endpoint returns comprehensive user information, including account details, email, user status, and membership specifics.
Action Parameters
Action Response
DOCUSIGN_GET_USER_AUTHORIZATIONS_FOR_PRINCIPAL
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, permission levels, and validity periods. use this endpoint when you need to audit user access, manage permissions, or review the authorization history for a specific user. the response includes pagination support for handling large sets of authorizations.
Action Parameters
Action Response
DOCUSIGN_GET_USER_AUTHORIZATION_DETAILS
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 particularly useful for auditing purposes, reviewing access grants, and managing user permissions within the docusign system. the endpoint requires specific identifiers to ensure the correct authorization is accessed and that the requester has the necessary permissions to view the data.
Action Parameters
Action Response
DOCUSIGN_GET_USER_CLOUD_STORAGE_PROVIDER_CONFIGURATION
Retrieves the cloud storage provider configuration for a specific user within a docusign account. this endpoint returns a list of enabled cloud storage providers and their configuration details for the specified user. it’s useful for integrating cloud storage options into docusign workflows or managing user-specific cloud storage settings. the endpoint is designed for individual user access, meaning users can only retrieve their own configuration information, even if they have admin rights. the response includes authentication urls for providers that require user authentication, making it valuable for setting up or updating cloud storage integrations.
Action Parameters
Action Response
DOCUSIGN_GET_USER_INFORMATION_BY_ID
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 configurations. note that users can only access their own information, even with admin rights.
Action Parameters
Action Response
DOCUSIGN_GET_WATERMARK_DETAILS_FOR_ACCOUNT
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 returns comprehensive information about the watermark but does not modify any settings. use this when you need to inspect or audit the current watermark configuration for an account.
Action Parameters
Action Response
DOCUSIGN_GET_WORKFLOW_STEP_FOR_ENVELOPE
Retrieves detailed information about a specific workflow step for a docusign template. this endpoint allows users to fetch comprehensive data about a single step in a template’s workflow, including its action, status, delayed routing settings, and recipient routing rules. it’s particularly useful when you need to examine or troubleshoot the configuration of a specific workflow step within a template. the endpoint provides insights into how the step is triggered, its current status, and any conditional routing or delay rules applied to it. use this when you need to understand the exact behavior and settings of a particular workflow step in your docusign template.
Action Parameters
Action Response
DOCUSIGN_GET_WORKSPACE_FILE
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 endpoint offers options to download the file as an attachment or convert it to pdf format. use this when you need to extract file content from a docusign workspace, either for backup purposes, local editing, or integration with other systems. note that this endpoint retrieves the raw file content and does not provide metadata about the file or its signing status.
Action Parameters
Action Response
DOCUSIGN_GET_WORKSPACE_FOLDER_CONTENTS
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 workspace, allowing for efficient management of documents and folders. the endpoint offers various optional parameters to customize the response, enabling users to include or exclude specific types of information based on their needs.
Action Parameters
Action Response
DOCUSIGN_INITIATE_NEW_CHUNKED_UPLOAD
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 method returns a response with the chunked upload id, uri, and other metadata, which can be used to add more parts to the upload. note that this api is currently in beta status and subject to change.
Action Parameters
Action Response
DOCUSIGN_LIST_ALL_TEMPLATES
Gets the definition of a template or templates in the specified account. note: if the count parameter is not used, listtemplates has a default limit of 2,000 templates. if the account has more than 2,000 templates, listtemplates will return the first 2,000 templates. to retrieve more than 2,000 templates, repeat the api call, specifying start position and count to control the number of templates retrieved.
Action Parameters
Action Response
DOCUSIGN_LIST_BILLING_INVOICES
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 efficient handling of large datasets. use this endpoint to review billing history, verify charges, or gather financial data for accounting purposes. the response includes comprehensive invoice details, making it valuable for financial reconciliation and reporting.
Action Parameters
Action Response
DOCUSIGN_LIST_BRANDS_FOR_ACCOUNT
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 useful for managing and reviewing account-level branding options. the endpoint requires either the ‘canselfbrandsign’ or ‘canselfbrandsend’ setting to be enabled for the account. use this when you need to audit, manage, or implement brand customizations across your docusign account.
Action Parameters
Action Response
DOCUSIGN_LIST_BULK_SEND_BATCH_SUMMARIES
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 operations and managing bulk send workflows. the endpoint supports pagination and various filtering options to customize the result set according to specific needs.
Action Parameters
Action Response
DOCUSIGN_LIST_CLOUD_STORAGE_ITEMS
Retrieves a list of the user’s items (files and folders) from a specified cloud storage provider integrated with docusign. this endpoint allows for filtered and paginated access to cloud storage contents, enabling efficient navigation and search of large storage structures. it’s particularly useful for applications that need to display or process cloud-stored documents within the docusign ecosystem. the endpoint supports various query parameters for customizing the retrieval process, including sorting, limiting results, and searching by text. note that users can only access their own cloud storage items, ensuring data privacy and security.
Action Parameters
Action Response
DOCUSIGN_LIST_ENVELOPE_AND_DOCUMENT_CUSTOM_FIELDS
Retrieves a comprehensive list of envelope and document custom fields associated with a specific docusign account. this endpoint is useful for account administrators who need to review, manage, or analyze the custom fields set up for their organization’s docusign workflows. the returned data includes both list custom fields (with predefined options) and text custom fields (for free-form input), providing a complete overview of all custom data points used in the account’s envelope processes. this tool should be used when you need to audit existing custom fields, prepare for updates to custom field configurations, or gather information for reporting purposes. it does not allow for the creation, modification, or deletion of custom fields; it is strictly for retrieval of existing field data.
Action Parameters
Action Response
DOCUSIGN_LIST_ENVELOPE_ATTACHMENTS_BY_ENVELOPE_ID
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 attachments, which are different from signer attachments (user-visible documents). use this endpoint when you need to manage or review administrative files linked to an envelope. the api is currently in beta status, so it may be subject to changes in future versions. the response includes an array of attachment objects, each containing information like accesscontrol, attachmentid, and attachmenttype. error details are provided for both successful and failed requests.
Action Parameters
Action Response
DOCUSIGN_LIST_PAST_DUE_INVOICES
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, balances, due dates, and itemized charges. use this when you need to review overdue payments, assess the account’s financial status, or determine if immediate action is required for outstanding invoices. the endpoint does not process payments directly but informs if payment through the api is possible. note that this tool requires account administrator privileges to access sensitive billing information.
Action Parameters
Action Response
DOCUSIGN_LIST_PAYMENT_GATEWAY_ACCOUNTS_INFO
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 payment methods. it should be used when you need to manage or review payment gateway configurations within a docusign account. as this is a beta endpoint, be aware that its structure or behavior may change in future updates.
Action Parameters
Action Response
DOCUSIGN_LIST_REGISTERED_NOTARY_JURISDICTIONS
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 and reviewing a notary’s registrations across multiple states. the response includes navigation uris for handling pagination, allowing for efficient retrieval of large result sets. this endpoint should be used when a notary needs to review their registered jurisdictions or when an application needs to display or process a notary’s registration information across multiple states.
Action Parameters
Action Response
DOCUSIGN_LIST_RESOURCES_FOR_RESTVERSION_SPECIFIED
Retrieves the base resources available for the docusign esignature rest api. this endpoint provides developers with a comprehensive list of available api resources and their current configurations without requiring authentication or an integrator key. it’s particularly useful for api discovery, allowing developers to understand the capabilities and structure of the esignature api before implementation. the endpoint returns detailed information about each resource, including names, values, and any associated error details, which can be crucial for diagnosing issues or planning api integrations. while it doesn’t provide access to user-specific data, it serves as an essential tool for api exploration and troubleshooting.
Action Parameters
Action Response
DOCUSIGN_LIST_SIGNATURE_PROVIDERS_FOR_ACCOUNT
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 setting up or managing signature workflows, especially those involving identity verification. the endpoint returns provider names, display names, ids, and any required options, enabling developers to integrate various signature providers into their docusign-based applications or workflows.
Action Parameters
Action Response
DOCUSIGN_LIST_USERS_FOR_ACCOUNT
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 information about the account’s user base. the endpoint supports pagination and filtering, enabling efficient retrieval of specific subsets of users. when called with the ‘additional info’ parameter set to true, it provides comprehensive user data, including granular permissions and custom settings. this makes it valuable for auditing user access levels or preparing for bulk updates to user configurations. keep in mind that the response can be quite large, especially for accounts with many users or when requesting additional info. it’s recommended to use pagination parameters (count and start position) for large accounts to manage response sizes and api performance.
Action Parameters
Action Response
DOCUSIGN_LIST_WORKSPACES
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 particularly useful for applications that need to display or manage multiple workspaces, or for auditing purposes to review workspace configurations and user access. the endpoint provides paginated results, allowing for efficient retrieval of large numbers of workspaces.
Action Parameters
Action Response
DOCUSIGN_LIST_WORKSPACE_FILE_PAGES
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 files as images, such as for preview generation or image-based analysis. the endpoint is particularly useful for viewing documents without downloading the entire file, enabling faster loading and reduced bandwidth usage. note that this method does not provide text extraction or document editing capabilities; it’s purely for image-based representation of file pages.
Action Parameters
Action Response
DOCUSIGN_LOCK_AN_ENVELOPE_FOR_EDITING
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 when you need to make changes to an envelope and want to prevent concurrent edits. the lock has a limited duration and can be extended if needed. it’s particularly useful for complex envelope modifications or when coordinating changes among multiple users. note that template passwords may be required for certain locked envelopes, and there’s a maximum lock duration of 30 minutes.
Action Parameters
Action Response
DOCUSIGN_LOCK_TEMPLATE_FOR_EDITING
This endpoint locks a specified docusign template for editing, preventing other users or recipients from modifying it during the lock period. it returns a locktoken that must be used in subsequent put requests to update the locked template. the method is crucial for maintaining data integrity in collaborative environments where multiple users might attempt to edit the same template simultaneously. use this endpoint before making any changes to a template to ensure exclusive access. note that the lock has an expiration time, and you must provide the locktoken in the x-docusign-edit header for all update operations while the template is locked.
Action Parameters
Action Response
DOCUSIGN_MODIFY_ACCOUNT_NOTIFICATION_SETTINGS
This endpoint updates the default email notification settings for envelope senders and signers in a docusign account. it allows for extensive customization of when and what type of notifications users receive regarding envelope status changes, comments, and other events. the endpoint is useful for tailoring the docusign experience to an organization’s specific needs and communication preferences. it should be used when an account administrator wants to modify the default notification behavior for all users in the account. note that these settings can be overridden at the individual envelope level if needed.
Action Parameters
Action Response
DOCUSIGN_MODIFY_TAB_SETTINGS_FOR_ACCOUNT
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 is primarily used to customize the tab experience for users within an account, affecting how they interact with documents during the signing process.
Action Parameters
Action Response
DOCUSIGN_POST_PAYMENT_TO_INVOICE
Posts a payment to a past due invoice in the docusign system. this endpoint is used to process payments for overdue invoices, but only when the ‘paymentallowed’ value for the invoice is true. it requires account administrator privileges and returns detailed payment information. the endpoint is crucial for managing billing and payments within docusign, ensuring timely settlement of past due accounts. it should be used in conjunction with the ‘list invoices past due’ endpoint to retrieve eligible invoices and their balances before posting payments.
Action Parameters
Action Response
DOCUSIGN_PURCHASE_ADDITIONAL_ENVELOPES
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 the number of available envelopes for document signing within a docusign account. however, it’s important to note that this endpoint is currently limited to docusign internal use only and is not available for public api consumers. the endpoint requires detailed information about the purchase, including the amount, currency, quantity, and app store-related data for tracking and processing the transaction.
Action Parameters
Action Response
DOCUSIGN_QUEUE_DOWNGRADE_BILLING_PLAN_REQUEST
Queues a downgrade request for a docusign account’s billing plan. this endpoint allows you to initiate the process of changing an account to a lower-tier or less expensive plan. it’s used when an account holder wants to reduce their subscription level or change to a more cost-effective plan. the endpoint processes the request and returns information about the downgrade status, including the effective date and new plan details. note that this action queues the request for processing and does not immediately apply the downgrade.
Action Parameters
Action Response
DOCUSIGN_REGISTER_CURRENT_USER_AS_NOTARY
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 certification requirements.
Action Parameters
Action Response
DOCUSIGN_REMOVE_BULK_SEND_LIST
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 to be deleted. upon successful deletion, it returns a summary of the remaining bulk send lists associated with the account. this endpoint should be used with caution as the deletion is irreversible. it’s particularly useful for maintaining a clean and organized set of bulk send lists, especially in environments where list management is crucial for compliance or efficiency reasons. note that this operation does not affect any envelopes that may have already been sent using the deleted list.
Action Parameters
Action Response
DOCUSIGN_REMOVE_GROUP_SHARING_PERMISSIONS_FOR_TEMPLATE
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 certain groups no longer require access to a specific template. the operation affects only the specified template and groups, allowing for granular permission management within the docusign environment.
Action Parameters
Action Response
DOCUSIGN_REMOVE_TEMPLATES_FROM_FAVORITES
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 favorites. the api returns information about the templates that were successfully removed and any errors encountered during the process. this endpoint is particularly useful for maintaining an organized and relevant list of favorite templates, especially when templates are no longer frequently used or needed. note that this api is currently in beta status, which means it may not be fully stable and could be subject to changes in the future.
Action Parameters
Action Response
DOCUSIGN_REMOVE_USER_SIGNATURE_INFORMATION
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 authenticated user’s own signatures and cannot be used to modify other users’ data, even with admin rights. it’s important to note that this action is irreversible, so it should be used with caution. the endpoint accepts either a signature id or a signature name, but using the signature id is recommended to avoid url encoding issues.
Action Parameters
Action Response
DOCUSIGN_REPUBLISH_CONNECT_DATA_FOR_ENVELOPE
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 systems. the function requires account administrator privileges and connect must be enabled on the account. use this when you need to manually trigger a resend of connect data for a specific envelope, typically in response to failed deliveries or system synchronization issues.
Action Parameters
Action Response
DOCUSIGN_REPUBLISH_CONNECT_INFO_FOR_ENVELOPES
Republishes connect information for a specified set of envelopes in docusign. this endpoint is primarily used to retry failed connect post attempts by providing the envelope ids that previously failed to post correctly. it’s designed for account administrators to handle and resolve connect post failures, ensuring that important envelope information is successfully transmitted to integrated systems. the endpoint requires connect to be enabled on the account and returns detailed results of the retry attempts for each envelope.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_BILLING_PLAN
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 account’s billing status, available plan options, and payment details. the endpoint allows customization of the response through optional query parameters, enabling users to include or exclude specific information such as credit card details, downgrade options, metadata, and successor plans. this tool should be used when a detailed view of an account’s billing configuration is required, especially for account management, billing inquiries, or planning potential plan changes.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_BRAND_INFORMATION
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 signing. it should be used when detailed brand information is needed for display, management, or customization purposes. the endpoint requires account branding to be enabled (either for signing, sending, or both) to function properly.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_ENVELOPE_PURGE_CONFIG
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 crucial information for managing document lifecycle, data privacy, and storage optimization within the docusign platform. the configuration includes settings for enabling purging, redacting personally identifiable information (pii), removing associated tabs and attachments, and specifying the retention period in days. this method should be used when auditing or reviewing an account’s document retention policies, or before making changes to the purge configuration. note that this endpoint is in beta status and requires account administrator privileges to access.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_FAVORITE_TEMPLATES
Retrieves the list of favorite templates associated with a specified docusign account. this endpoint allows users to access their saved favorite templates, which can streamline document creation and signing processes. it’s particularly useful for users who frequently work with the same set of templates and want quick access to them. the endpoint is currently in beta, so users should be aware that it may undergo changes or have limitations. it provides template ids, favorited dates, and a count of updated templates, but does not return the full template content.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_INFORMATION_FOR_SPECIFIED_ACCOUNT
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 docusign platform. it’s particularly useful for account management, auditing, or when needing to review or update account settings. the response includes critical information such as the account’s guid, name, creation date, current plan details, and various feature enablements. when account settings are included, it provides a deep dive into the account’s configuration, covering aspects like authentication requirements, branding options, envelope settings, and compliance-related configurations.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_PASSWORD_RULES
Retrieves the current password rules and security settings for a user’s docusign account. this endpoint provides detailed information about password requirements, including expiration policies, complexity rules, lockout settings, and security question configurations. it’s useful for applications that need to display or enforce docusign’s password policies, or for users who want to understand the security requirements for their account. the tool returns a comprehensive set of rules that govern password management, helping to ensure compliance with the account’s security standards. it should be used when detailed password policy information is needed, but not for actually changing or resetting passwords.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_PROVISIONING_INFO
Retrieves the account provisioning information for a docusign account. this endpoint is used to obtain crucial setup details necessary for account management and integration with docusign’s services. it provides information such as default connection and plan ids, distributor codes, password rules, and billing-related details. this tool should be used when setting up a new docusign account or when needing to verify or update existing account provisioning information. the endpoint does not require any input parameters and returns a comprehensive set of account configuration data. note that this endpoint does not modify any account settings; it only retrieves existing information.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_SEAL_PROVIDERS
Retrieves a list of electronic seal providers available for a specific docusign account. this endpoint allows developers to fetch all the seals that can be applied to documents within the specified account. it’s particularly useful when implementing functionality to add electronic seals to documents or when displaying available seal options to users. the endpoint returns both the internal seal name and a user-friendly display name for each available seal. it should be used when an application needs to present seal choices to users or automatically apply seals based on predefined rules. note that this endpoint only retrieves the list of available seals and does not apply seals to documents; separate api calls would be required for seal application.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_SETTINGS_INFORMATION
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-related configurations. it is particularly useful for administrators or integration developers who need to audit, review, or programmatically access the full range of account settings. the retrieved information can be used to understand the current state of the account, verify specific configurations, or as a basis for updating settings through other api calls. note that this endpoint returns a large amount of data and should be used judiciously to avoid unnecessary load on the system. it does not modify any settings; it only retrieves the current configuration.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_SIGNING_GROUPS
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 groups across an organization. the endpoint supports filtering by group type and can include or exclude user information based on your needs. use this when you need to review, manage, or audit the signing groups in your docusign account. note that while it provides extensive group information, it does not modify any group settings or memberships.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ACCOUNT_VERIFICATION_WORKFLOWS
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, deactivated, or all workflows, depending on the query parameter. use this endpoint to understand the available identity verification options for your account, which can help in implementing secure signing processes.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ALL_ACCOUNT_TABS
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 integrating tab information into external systems. can be filtered to return only custom tabs if needed.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_APIREQUEST_LOG_FILES
Retrieves a list of api request log entries from docusign, providing diagnostic information for developers. offers flexible response formats (json, xml, or zip file). returns key data about each api request, including timestamps, endpoints called, and request status. useful for troubleshooting, monitoring, and auditing api usage. note: may not provide real-time logs and time range of returned logs is unspecified.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_AVAILABLE_ACCOUNT_STAMPS
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 available stamps for document signing processes. the endpoint returns comprehensive data including adoption dates, creation dates, image uris, and specific properties of each stamp or signature. use this when you need to present users with stamp options or when managing stamp resources within a docusign integration.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_BILLING_INVOICE
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 reconciliation, audit purposes, or when detailed billing information is required. the endpoint returns comprehensive invoice data, including total amount, balance, due date, and itemized charges, with amounts shown in the account’s set currency.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_BILLING_PAYMENT_INFO
Retrieves detailed information for a specified billing payment within a docusign account. this endpoint is used to fetch comprehensive data about a single payment, including the amount, description, payment date, and payment number. it is designed for account administrators who need to access or review specific payment details, such as for auditing or reconciliation purposes. the endpoint does not modify any payment information and is read-only. it should be used when precise payment data is required, but not for real-time payment processing or for retrieving bulk payment information.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_BILLING_PLAN_DETAILS
Retrieves comprehensive details of a specific docusign billing plan using its unique identifier. this endpoint provides extensive information about the plan, including its name, payment cycle, pricing structure, included features, and potential upgrade options. it’s particularly useful for account administrators and billing managers who need to review or manage subscription details. the response includes the current plan’s specifics such as per-seat pricing, included seats, and support fees, as well as a list of successor plans for potential upgrades. this endpoint should be used when detailed billing plan information is required, such as during account reviews, upgrade considerations, or for generating detailed billing reports. it does not modify any billing information and is intended for read-only operations.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CHUNKED_UPLOAD_METADATA
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 use in other docusign operations, such as adding documents to envelopes. the endpoint does not return the actual content of the upload, only its metadata. it cannot retrieve information about expired, deleted, or already consumed chunked uploads. this tool is essential for managing and troubleshooting large file uploads in docusign, ensuring that all parts are present and the upload is ready for use.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CLOUD_STORAGE_PROVIDER_CONFIGURATION
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. it provides details such as authentication urls and service ids for each enabled provider. use this endpoint when you need to display available cloud storage options to a user or initiate the authentication process for a specific provider. note that users can only access their own cloud storage information, and the endpoint does not modify any existing configurations.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATIONS
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 account is set up to send notifications for various docusign events. this tool is essential for managing and auditing connect integrations, but should only be used by authorized account administrators with connect enabled on their account.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATION_DETAILS
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 existing configurations or gathering information before making updates. the endpoint requires connect to be enabled on the account and is limited to account administrators only.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_FAILURE_LOGS
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 counts, and uris for potential republishing attempts. the endpoint supports optional date range filtering to narrow down the search results. use this method when troubleshooting connect integration issues or when you need to analyze and potentially retry failed envelope postings. note that connect must be enabled on the account for this endpoint to function properly.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_LOGS
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 activities, identify issues, and ensure proper functioning of their connect configurations. the endpoint supports date-based filtering to narrow down the log entries within a specific time range. note that this endpoint requires administrator access and connect must be enabled on the account with logging turned on. log entries are only retained for 15 days.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_LOG_ENTRY
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, auditing connect events, and monitoring the overall health of your connect service. the endpoint requires connect to be enabled on the account and logging to be activated in the connect configuration. only account administrators can access this information.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CONNECT_OAUTH_CONFIGURATION
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 details such as the authorization server url, client id, client secret, and scope settings. this tool should be used when setting up or troubleshooting connect integrations, or when verifying the current oauth configuration for an account. it’s important to note that this endpoint requires account administrator privileges and connect must be enabled on the account to access this information. the tool does not modify any settings; it only retrieves the existing configuration.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CREDIT_CARD_INFO
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 should be used when there’s a need to access or verify the current credit card information for billing purposes within the docusign system. it’s particularly useful for account management, billing inquiries, or updating payment information. however, due to the sensitive nature of the data returned, this endpoint should be used judiciously and with appropriate security measures in place. the tool does not allow for updating or modifying the credit card information; it is read-only. be aware that accessing this information may be subject to strict access controls and compliance requirements due to the sensitive financial data involved.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_ENVELOPE
Retrieves custom field information for a specified envelope in docusign. this endpoint allows users to access both list and text custom fields associated with an envelope, providing valuable metadata for tracking, searching, and managing documents. it’s particularly useful for retrieving envelope-specific custom data that isn’t visible to recipients but is crucial for internal processes and integrations. the endpoint supports salesforce merge fields, enhancing its utility in crm-integrated workflows.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_TEMPLATE
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 added to template documents, which can be used for populating or customizing new envelopes based on the template. it should be used when you need to view or work with the custom fields of a particular document in a docusign template. note that this endpoint only retrieves existing custom fields and does not allow for creation or modification of these fields.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CUSTOM_TAB_INFORMATION
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 when you need to review or verify the configuration of a custom tab within an account. the endpoint requires both the account id and the specific custom tab id to fetch the relevant information. note that this endpoint only retrieves information and does not modify any existing custom tab settings.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_CUSTOM_USER_SETTINGS
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 ability to filter by group using an optional header. use this endpoint when you need to access user-specific configurations, preferences, or any custom data stored for a particular user in your docusign integration. note that users can only access their own custom settings, and this endpoint does not provide access to standard docusign account settings.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_DEFAULT_DISCLOSURE_FOR_ENVELOPE
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 language-specific versions of the disclosure and for ensuring compliance with electronic signature regulations.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_ATTACHMENT
Retrieves a developer-only envelope attachment from a specific envelope in docusign. this endpoint allows you to access files associated with an envelope that are not visible to signers. it should be used when you need to retrieve attachment files that were programmatically added to an envelope. the function returns the attachment as a binary file, which can then be processed or stored as needed. note that this operation is currently in beta status, which means it may undergo changes in the future. it’s important to distinguish this from retrieving signer attachments, which is a separate process.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_AUDIT_EVENTS
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, allowing users to monitor the lifecycle of important documents. the endpoint should be used when detailed information about an envelope’s history is required, such as verifying signatures, tracking changes, or investigating discrepancies. note that this endpoint only provides audit events for a single envelope at a time and does not offer filtering or sorting options for the returned events.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENTS
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 entire envelope contents. the endpoint offers flexibility in document retrieval, supporting features like language customization, watermarking, and data change highlighting. use this when you need to download or access documents after they’ve been processed through docusign’s electronic signature workflow.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENT_FIELDS
Retrieves custom document field information from an existing envelope document in docusign. this endpoint allows users to access name-value pairs of custom data strings associated with a specific document within an envelope. it’s particularly useful for retrieving metadata or additional information attached to documents that are not used in docusign’s standard processing. the function returns both current and original values of these custom fields, enabling tracking of any changes made to the fields over time.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_EMAIL_OVERRIDES
Retrieves the email override settings for a specified envelope in docusign. this endpoint allows users to fetch custom email configurations, including reply-to email address and name overrides, as well as bcc email addresses for archiving purposes. it’s particularly useful when you need to verify or audit the email settings for a specific envelope that may differ from the account-level defaults. the retrieved information is not included in the standard envelope status get request and requires this specific api call.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_HTML_DEFINITION
Retrieves the original html definition used to generate the responsive html for a specific 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 envelope’s documents are formatted and displayed in a responsive manner. the tool returns properties that define the responsive html generation, including display anchors, collapsible sections, and responsive table settings. it should be used when you need to inspect or troubleshoot the html definition of an envelope, particularly for envelopes using smart sections or responsive signing features. this endpoint does not modify any data and is purely for retrieval purposes.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ENVELOPE_NOTIFICATION_DETAILS
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 when you need to verify or audit the notification settings for an envelope, especially in workflows where timely responses are critical. the endpoint does not modify any settings; it only provides read-only access to the current configuration.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_HTMLDEFINITION_FOR_RESPONSIVE_DOCUMENT
This endpoint retrieves the html definition used to generate a dynamically sized responsive document within a docusign envelope. it is specifically designed for documents created as signable html and provides detailed information about responsive signing and smart sections. the endpoint returns properties that define how to generate the responsive-formatted html for the document, including display settings, anchors, and styling options. it’s particularly useful when implementing responsive signing across different devices or customizing the appearance of html documents in the signing process. note that for non-html documents or invalid document ids, the endpoint will return a 200 ok response with an empty json body, rather than an error.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_ITEMS_IN_CLOUD_STORAGE_FOLDER
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 pagination, sorting, and filtering options to efficiently manage large folders. use this endpoint when you need to list, locate, or select files from a user’s cloud storage for docusign operations. note that this endpoint only provides metadata about the items and does not download the actual file contents.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_LIST_OF_BILLING_PLANS
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 administrators or financial teams who need to review or manage billing options for their organization. the endpoint returns all available plans without requiring any input parameters, making it ideal for generating a complete overview of billing options. note that some fields in the response are reserved for docusign internal use and may not be relevant for all users.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_PAYMENT_INFORMATION_LIST
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 returns payment information for the last 365 days, but you can specify a custom date range using query parameters. the response is paginated, allowing you to handle large datasets efficiently. note that this endpoint requires account administrator privileges and should be used cautiously to protect sensitive financial information.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_PDF_FROM_SPECIFIED_TEMPLATE
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 envelopes based on existing templates. the retrieved pdfs can be customized to show recipient changes and can be encrypted for enhanced security. use this endpoint when you need to work with template documents outside of the docusign system or when you want to verify the content of a template before using it.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_POWER_FORM_DATA_ENTRIES
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 by date range. this endpoint is essential for collecting and analyzing form submissions, enabling businesses to efficiently process and manage data gathered through powerforms. it should be used when there’s a need to extract and analyze powerform submission data, but not for real-time form submission tracking. the endpoint provides comprehensive form data, including envelope and recipient details, but does not offer real-time updates or notifications for new submissions.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_PROPERTIES_ABOUT_WORKSPACE
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, such as its current status, description, or associated users. the endpoint requires both an account identifier and the specific workspace id to retrieve the correct information. note that some details, like caller information, are only returned for user-specific get calls. this endpoint should be used when detailed workspace information is needed, but it does not provide document contents or allow modifications to the workspace.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_REST_API_VERSIONS
Retrieves the available rest api versions for docusign’s service. this endpoint provides crucial information about the current state of the api, including available versions, their corresponding urls, and some internal build details. it’s useful for developers who need to check api compatibility, plan for version upgrades, or diagnose potential issues. the endpoint can be accessed on both production and demo systems without requiring authentication or an integration key, making it ideal for quick service checks or initial api exploration. while it offers valuable version and build information, it does not provide details about specific api functionalities or user-related data.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_SIGNER_SIGNATURE_IMAGE_INFORMATION
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 original uploaded format, with an option to include or exclude the chrome (added line and identifier around the initial image). this tool is particularly useful when you need to extract or display a user’s signature from a completed or in-progress docusign transaction. it should be used cautiously, respecting privacy concerns and ensuring proper authorization. note that older envelopes may only have chromed images available, so a fallback strategy might be necessary in some cases.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_TEMPLATE_CUSTOM_FIELDS
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 template, enabling you to understand the additional data that can be collected or pre-filled when using this template to create envelopes. the retrieved information includes details such as field ids, names, required status, and possible values for list fields. this endpoint should be used when you need to inspect or validate the custom fields of a template before using it to create an envelope or when you want to display the available custom fields to users in your application.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_TEMPLATE_DOCUMENT_PAGE_IMAGES
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 content within applications, enabling users to view document layouts and content without needing to download the entire document. the endpoint supports pagination for efficient handling of multi-page documents and offers options for showing changes and bypassing cache for up-to-date results.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_TEMPLATE_PAGE_IMAGE
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 template without retrieving the entire document. the endpoint supports customization of the returned image through resolution (dpi) and dimension parameters, enabling optimized image delivery for various display requirements. it should be used when building interfaces that require visual representation of template pages, such as template preview features or document review systems. note that this endpoint retrieves static images and does not provide interactive elements or real-time template modifications.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_ACCOUNT_SETTINGS
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, and various other user-specific settings. it’s particularly useful for understanding a user’s current configuration or for troubleshooting user-specific issues. the endpoint is limited to retrieving settings for the authenticated user only, even for admin users, ensuring privacy and security of individual user settings. the response includes a wide range of settings, from basic preferences to advanced features like vaulting and template management, offering a complete view of the user’s docusign environment configuration.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_INITIALS_IMAGE_FOR_ENVELOPES
Retrieves the initials image for a specified user within a docusign envelope. this endpoint allows you to fetch the user’s initials image in its original upload format, with an option to include or exclude the chrome (added line and identifier around the image). it’s particularly useful when you need to display or process a recipient’s initials within the context of an envelope. note that for older envelopes, only chromed images might be available, so you may need to implement fallback logic if retrieving a non-chromed image fails. the endpoint requires specific authentication and authorization, ensuring that the requested user id matches the authenticated user and that the user is a member of the account.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_PROFILE_IMAGE
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 pictures within the docusign ecosystem. the endpoint ensures that users can only access their own profile image, maintaining privacy and security. if no profile image exists for the user, the endpoint will indicate this with a 404 not found response.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_PROFILE_INFORMATION
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 configuration within the docusign system, including their authentication methods, email notification settings, and locale preferences. it should be used when detailed user information is required for account management, user customization, or auditing purposes. note that users can only access their own information, and the userid parameter must match the authenticated user’s id. the endpoint does not allow for modification of user settings; it is strictly for retrieval of existing information.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_SIGNATURE_DEFINITIONS
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 manage user signatures within the docusign ecosystem. it supports retrieving different types of signatures based on the optional stamp type parameter. the response includes comprehensive information about each signature, such as creation date, image data, and various properties related to the signature’s appearance and usage.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_SIGNATURE_IMAGE
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. the endpoint requires specific user authentication and is limited to retrieving the authenticated user’s own signature images. it supports various image types including stamps, signatures, and initials, making it versatile for different signature requirements in document workflows.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_USER_SIGNATURE_INFORMATION
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 and review their own signature information, ensuring data privacy and security. it’s particularly useful when users need to verify their signature settings or retrieve signature images for use in other contexts.
Action Parameters
Action Response
DOCUSIGN_RETRIEVE_WORKFLOW_STEP_FOR_TEMPLATE
Retrieves detailed information about a specific workflow step for a docusign envelope. this endpoint allows users to access the configuration and status of a single step within an envelope’s workflow, including delayed routing settings and conditional recipient rules. it’s particularly useful for monitoring the progress of complex, multi-step envelope processes or for troubleshooting issues with specific workflow steps. the endpoint provides read-only access to step details and should be used when you need to inspect or verify the current state and rules of a particular workflow step within an envelope. note that this endpoint does not allow modification of the workflow step; it is for retrieval purposes only.
Action Parameters
Action Response
DOCUSIGN_RETURNS_DOCUMENT_PAGE_IMAGES_BASED_ON_INPUT
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 pages without downloading the entire document. the endpoint supports showing changes made to the document and can bypass caching for the most up-to-date images. it’s ideal for applications that need to render document previews, perform image analysis, or create custom document viewers.
Action Parameters
Action Response
DOCUSIGN_RETURN_ALL_CONNECT_SERVICE_USERS
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, username, and status, as well as pagination for large result sets. this tool should be used when you need to obtain a comprehensive list of users associated with a particular connect configuration, which is useful for auditing, user management, or integration purposes. note that this endpoint requires connect to be enabled on the account and can only be accessed by account administrators.
Action Parameters
Action Response
DOCUSIGN_RETURN_BRAND_RESOURCE_METADATA_FOR_ACCOUNT
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 for developers who need to inspect or manage custom branding elements within a docusign integration. the endpoint should be used when you need to audit brand resources, prepare for updates, or gather information about the current branding configuration. note that this endpoint only returns metadata and uris for the resources, not the actual resource content. also, branding must be enabled for the account (either for signing, sending, or both) for this endpoint to return meaningful data.
Action Parameters
Action Response
DOCUSIGN_RETURN_ENVELOPE_TAB_DATA_FOR_EXISTING_ENVELOPE
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 them. it’s particularly useful for analyzing form submissions, tracking recipient interactions, and integrating docusign data with external systems. the method requires the “allow sender to download form data” setting to be enabled for the account.
Action Parameters
Action Response
DOCUSIGN_RETURN_SCHEDULED_SENDING_RULES_FOR_ENVELOPE
Retrieves the scheduled sending rules for a specific envelope in docusign. this endpoint is used to get information about when and how an envelope is scheduled to be sent, including any delay rules or specific send dates. it’s particularly useful for managing automated or timed document workflows. the endpoint returns details such as the bulk list id (if applicable), the resume date, specific rules for sending, and the current status of the scheduled sending job. note that if the specified envelope or workflow step does not have a scheduled sending object, this method will return a 404 error. this tool should be used when you need to check or verify the scheduled sending settings for a particular envelope in your docusign account.
Action Parameters
Action Response
DOCUSIGN_RETURN_TEMPLATE_WORKFLOW_DEFINITION
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 of a template. the endpoint should be used when you need to examine or troubleshoot a template’s workflow configuration. note that if the specified template does not have a workflow object, this method will return a 404 error. the response includes comprehensive data about the workflow, but does not modify the template or its workflow in any way.
Action Parameters
Action Response
DOCUSIGN_RETURN_USERS_FROM_CONNECT_SERVICE
Retrieves users associated with a specific docusign connect configuration for a given account. this endpoint allows account administrators to list and filter users linked to a custom connect setup, providing detailed user information such as email, account details, and user status. it’s particularly useful for managing integrations and monitoring user access within a connect configuration. the endpoint supports pagination and various filtering options to handle large user lists efficiently.
Action Parameters
Action Response
DOCUSIGN_REVOKE_ENVELOPE_CORRECTION_URL
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 is particularly useful in scenarios where the correction period has ended or when you need to lock an envelope’s content for compliance or business process reasons. the endpoint requires the account id and envelope id to identify the specific envelope for which the correction view should be revoked. it’s important to note that once revoked, the correction view cannot be reinstated without creating a new correction view url. this operation does not affect the envelope’s content or status; it only restricts access to the correction interface.
Action Parameters
Action Response
DOCUSIGN_ROTATE_PAGE_IMAGE_FOR_ENVELOPE
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 uploaded in an incorrect orientation. the rotation is applied only to the display of the image and does not permanently alter the original document. use this endpoint when you need to adjust the viewing angle of a specific page within an envelope, especially before sending it for signatures or during the review process.
Action Parameters
Action Response
DOCUSIGN_ROTATE_TEMPLATE_PAGE_IMAGE
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 that page images are correctly oriented for optimal viewing and signing. this operation only affects the display of the page image and does not alter the actual content of the document. use this endpoint when you need to correct or adjust the orientation of page images in your docusign templates before sending them out for signatures.
Action Parameters
Action Response
DOCUSIGN_SEND_ENVELOPE
Sends a draft envelope by updating its status to ‘sent’. example envelope id format: ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’
Action Parameters
Action Response
DOCUSIGN_SET_ENVELOPE_PURGE_CONFIG_FOR_ACCOUNT
Sets the envelope purge configuration for a specified docusign account, allowing account administrators to define automatic document removal policies for completed and voided envelopes. this endpoint enables configuration of purge settings, including retention period, pii redaction, and removal of associated tabs and attachments. it should be used when setting up or updating document retention and purging policies for an account. the method requires account administrator privileges and is currently in beta status. note that enabling pii redaction requires also enabling the removal of tabs and envelope attachments.
Action Parameters
Action Response
DOCUSIGN_SET_INITIALS_IMAGE_FOR_ACCOUNTLESS_SIGNER
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 formats (gif, png, jpeg, and bmp) with a file size limit of 200k. it’s particularly useful for maintaining brand consistency or adding a personal touch to documents for signers without docusign accounts. note that this operation can only be performed by the envelope sender and is subject to specific account permissions.
Action Parameters
Action Response
DOCUSIGN_SET_SIGNATURE_IMAGE_FOR_NO_ACCOUNT_SIGNER
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, with a file size limit of less than 200k. it’s specifically designed for use with accountless signers or in-person signers, providing a way to personalize their signature appearance. this function is useful when you need to customize the signature image for recipients who are not docusign account holders, such as one-time signers or in-person signing scenarios.
Action Parameters
Action Response
DOCUSIGN_SET_TEMPLATES_AS_ACCOUNT_FAVORITES
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 for users who frequently work with the same set of templates and want to streamline their workflow. note that this is a beta api and may be subject to changes in future versions.
Action Parameters
Action Response
DOCUSIGN_SET_UP_CONNECT_OAUTH_CONFIGURATION
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 with your own authorization server for enhanced security and control over webhook notifications. this tool is essential for account administrators setting up or updating connect oauth configurations, but requires connect to be enabled on the account.
Action Parameters
Action Response
DOCUSIGN_SET_USER_SIGNATURE_IMAGE
Sets or updates a user’s signature image, initials, or stamp in their docusign account. this endpoint allows for customization of various signature elements used in electronic document signing. it supports different image types including full signatures, initials, and stamps, with options for specifying placement and format of date stamps. use this when a user needs to add or modify their signature assets within their docusign account. the endpoint doesn’t handle the actual document signing process but focuses on managing the signature assets used in signing.
Action Parameters
Action Response
DOCUSIGN_SUBMIT_BATCH_HISTORICAL_ENVELOPES_TO_WEBHOOK
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 uses an ad hoc configuration provided in the request, rather than relying on existing connect configurations. unlike regular connect listeners that monitor new activity, this endpoint is specifically designed for publishing historical data on demand. it only supports json format for data transmission and allows fine-grained control over which envelope data and events are included in the webhook payload. the endpoint is particularly useful when you need to backfill data, synchronize systems after downtime, or perform bulk operations on historical envelopes.
Action Parameters
Action Response
DOCUSIGN_TOGGLE_API_REQUEST_LOGGING
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 providing detailed request/response information while ensuring sensitive data is omitted from the logs. it should be used when investigating api-related issues or monitoring api usage patterns. the endpoint has a limit of 50 log entries and automatically disables logging when this limit is reached. only requests from authenticated users are captured, and the logs can be retrieved or cleared using separate api calls.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_BRAND_SETTINGS
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 can update specific fields or replace the entire brand configuration. note that branding must be enabled for the account, and resource file modifications require separate api calls.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_CUSTOM_FIELD
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 custom metadata used for grouping and managing envelopes. use this endpoint when you need to change the configuration or content of an existing account-level custom field. note that this operation affects the custom field at the account level, potentially impacting all envelopes and templates that use this custom field.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_PASSWORD_RULES
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 with organizational policies, or adapt to changing security needs. the endpoint provides extensive customization options, from basic password requirements to complex, multi-factor authentication setups. note that changes made through this endpoint will affect all users within the specified account, so it should be used carefully and in accordance with your organization’s security policies.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_SETTINGS
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 align with organizational needs and policies. note that many settings require administrative privileges, and some may have interdependencies with other features.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_STAMPS
This endpoint allows you to add or update one or more account stamps (signatures) for a docusign account. it provides extensive flexibility in modifying various attributes of signatures, including images, fonts, rights, and stamp details. use this endpoint when you need to create new signatures or modify existing ones for an account, such as updating signature images, changing default settings, or adjusting stamp properties. the endpoint supports batch updates, allowing multiple signatures to be modified in a single request. note that this operation may include handling of image data in multi-part format.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_STAMP_BY_ID
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 permissions. the endpoint is particularly useful for maintaining up-to-date and personalized stamps for document signing. note that this operation will overwrite the existing stamp properties, so ensure all desired properties are included in the request, even if they haven’t changed.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_INFORMATION
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 its appearance on documents. it’s particularly useful for maintaining brand consistency, indicating document status, or adding security features to in-progress documents. the endpoint returns the updated watermark information, allowing immediate confirmation of changes. note that while most properties can be modified, the imagebase64 property is read-only and cannot be set through this call.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_PREVIEW
Updates and previews watermark settings for a docusign account. it customizes watermark appearance, including text, font, color, size, angle, and transparency. use when changing account-wide watermark configurations or previewing new settings. note: many fields require specific values; invalid inputs may default silently. this endpoint sets account watermark configuration, not document-specific application.
Action Parameters
Action Response
DOCUSIGN_UPDATE_BILLING_PLAN_FOR_ACCOUNT
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 configuration changes or plan transitions. exercise caution as it may trigger immediate billing changes.
Action Parameters
Action Response
DOCUSIGN_UPDATE_BULK_SEND_BATCH_NAME
Updates the name of an existing bulk send batch in docusign. this endpoint allows users to rename a specific batch identified by its batch id within a given docusign account. it’s useful for organizing and managing multiple bulk send batches, especially when dealing with large-scale document processing. the operation returns detailed information about the updated batch, including its current status, envelope information, and any potential errors. this endpoint should be used when you need to modify the name of a bulk send batch for better identification or organization purposes. it doesn’t modify any other properties of the batch or its associated envelopes. note that while the operation itself is straightforward, it’s important to ensure the provided batch id is valid and the new name adheres to the 500-character limit.
Action Parameters
Action Response
DOCUSIGN_UPDATE_CONNECT_OAUTH_CONFIGURATION
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 integrated systems. exercise caution when using this endpoint, as incorrect changes may disrupt existing integrations.
Action Parameters
Action Response
DOCUSIGN_UPDATE_CONTACTS_INFORMATION
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 contacts in a single api call. it’s particularly useful for maintaining up-to-date contact records, especially in scenarios involving shared contacts or notary services. the endpoint returns the updated contact details upon successful execution, providing immediate confirmation of the changes made.
Action Parameters
Action Response
DOCUSIGN_UPDATE_CUSTOM_FIELDS_IN_ENVELOPE_DOCUMENT
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 add custom data to a document that is already part of an envelope. it’s important to note that while docusign returns this custom field information in the status, it does not use this data for any internal processes. this endpoint should be used when you need to update or add custom metadata to a document in an existing envelope, but not for modifying the actual content of the document or the envelope’s core properties.
Action Parameters
Action Response
DOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNT
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 characteristics or functionality. it provides granular control over tab settings but requires careful consideration of the numerous optional parameters to avoid unintended changes.
Action Parameters
Action Response
DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_FOR_TEMPLATE_RECIPIENTS
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 restrict access to certain documents for some recipients while maintaining full visibility for others. however, it’s important to note that some recipient types (carbon copy, certified delivery, editor, and agent) will always have full document visibility, and documents with assigned tabs cannot be hidden from their respective recipients.
Action Parameters
Action Response
DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTS
This endpoint updates document visibility settings for one or more recipients within a specific docusign envelope. it allows you to control which documents each recipient can see and whether they have read-only or edit rights. the method is particularly useful for managing complex envelopes with multiple documents and recipients, ensuring that sensitive information is only accessible to intended parties. note that certain recipient types (carbon copy, certified delivery, editor, and agent) always have visibility to all documents, and documents with assigned tabs cannot be hidden from their respective recipients.
Action Parameters
Action Response
DOCUSIGN_UPDATE_DOCUSIGN_CONNECT_CONFIGURATION
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 endpoint when you need to change the behavior of your connect configuration, such as enabling or disabling it, updating the notification url, or modifying the events that trigger updates. it’s particularly useful for adjusting your integration as your application’s needs evolve or when troubleshooting issues with your webhook setup. note that this endpoint requires account administrator privileges and connect must be enabled on the account. be cautious when updating critical settings like ‘requiresacknowledgement’ or ‘usesoapinterface’, as they can significantly impact how your application receives and processes docusign notifications.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ELECTRONIC_RECORD_DISCLOSURE
This endpoint updates the electronic record and signature disclosure (ersd) for a docusign account. it allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. the endpoint is essential for compliance and tailoring the signer experience. only account administrators can use this method, and changes may require unsigned recipients to accept a new disclosure version.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENOTE_INTEGRATION_CONFIG
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 modifying the enote and eoriginal integration for secure electronic document management. the endpoint requires the account to have the ‘allow enote for eoriginal’ plan item enabled. note that this is a beta api and may be subject to changes. ensure that both connect and eoriginal are properly configured for the integration to work correctly.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_ATTACHMENT
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 endpoint when you need to update or replace an attachment that has already been added to an envelope, before it has been sent for signing. note that this endpoint is specifically for envelope attachments (developer-only files) and should not be confused with signer attachments.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_CUSTOM_FIELDS
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 you need to add or modify envelope-specific data that is not captured by standard docusign fields. it should be used when customizing envelopes with additional metadata or when implementing specialized workflows, such as evaulting for eoriginal customers. note that these custom fields are visible to envelope creators and senders in the envelope settings section but are not visible to envelope recipients.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_DELAYED_ROUTING_RULES
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 be sent to the recipients associated with the workflow step, either by specifying a relative delay or an exact future date and time. the endpoint can be used to implement timed workflows, schedule future sendings, or adjust existing delay rules. note that updating an in-progress delay will reset the countdown.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_DOC_GEN_FORM_FIELDS
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 method. for each field, specify the field name and the value to populate. important notes: - if update docgen formfields only is false (the default), the documentid changes after the update. - this endpoint does not validate number, date, or select data field values. the request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_EMAIL_SETTINGS
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 envelope without affecting account-level settings. note that changes only apply to future email communications related to the envelope. this endpoint can also be used to remove individual email override settings by providing an empty string for the value to be deleted.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_NOTIFICATION_SETTINGS
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 account’s default notification settings. the method only updates the settings and does not trigger the sending of any notifications. use this when you need to modify the reminder or expiration behavior for an existing envelope, such as extending the expiration date or adjusting the frequency of reminders.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_SCHEDULED_SENDING_RULES
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 specific timing. the endpoint is particularly useful for automating complex document workflows or coordinating large-scale document distributions.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_DEFINITION
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 workflow processing. the tool supports complex document workflows with timed actions, conditional processing, and staged approvals.
Action Parameters
Action Response
DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_STEP
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 completed). it enables features like scheduled sending and complex routing rules based on recipient actions or document content. the endpoint is particularly useful for implementing advanced document workflows, such as time-based routing or conditional approval processes.
Action Parameters
Action Response
DOCUSIGN_UPDATE_GROUP_INFORMATION
Updates group information and modifies or sets permission profiles for specified groups within a docusign account. this endpoint allows administrators to manage user groups, their names, and associated permissions efficiently. it should be used when there’s a need to change group details or update permission settings for multiple users simultaneously. the endpoint provides a way to streamline user management and access control in docusign, particularly useful for large organizations with complex permission structures.
Action Parameters
Action Response
DOCUSIGN_UPDATE_LOCK_FOR_ENVELOPE
Updates the lock information for a locked envelope in docusign. this endpoint allows you to modify the duration of the lock and the name of the application that locked the envelope. it’s particularly useful when you need to extend the lock time or update the locking application’s identifier. the endpoint requires the x-docusign-edit header for authentication and returns comprehensive information about the updated lock, including its new duration, expiration time, and a unique lock token for future operations. use this when managing long-running operations on envelopes to prevent conflicts from simultaneous edits.
Action Parameters
Action Response
DOCUSIGN_UPDATE_NOTARY_JURISDICTION_INFO
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 expiration date, or seal type. the endpoint requires a full jurisdiction object in the request body, even when updating only specific fields. it’s important to note that this endpoint can only be used by authenticated users who are registered notaries and for jurisdictions they are authorized for.
Action Parameters
Action Response
DOCUSIGN_UPDATE_PERMISSION_PROFILE_SETTINGS
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 access rights, configure notification preferences, and set other account-specific options. it’s particularly useful for maintaining security and tailoring user experiences based on roles or departments within an organization. note that this endpoint requires administrative access and should be used cautiously, as changes can significantly impact user abilities and workflow processes.
Action Parameters
Action Response
DOCUSIGN_UPDATE_RECIPIENT_DOCUMENT_VISIBILITY
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 recipient after an envelope has been created. this is particularly useful for managing complex workflows where different recipients need access to different sets of documents. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types always have full document visibility.
Action Parameters
Action Response
DOCUSIGN_UPDATE_SIGNING_GROUP_DETAILS
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 useful for managing and maintaining up-to-date signing group information, ensuring efficient document routing and signing processes. the endpoint requires the account id and signing group id for identification, and returns comprehensive details about the updated signing group, including creation and modification timestamps. use this when you need to modify signing group properties or adjust its membership, but be aware of the 50-member limit per group.
Action Parameters
Action Response
DOCUSIGN_UPDATE_SIGNING_GROUP_NAMES
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 improve clarity. the endpoint updates only the group names and doesn’t modify other group properties or memberships. use this when you need to maintain accurate and up-to-date naming conventions for your signing groups.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_CUSTOM_FIELDS
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 created from the template. the endpoint supports updating multiple custom fields in a single request, making it efficient for batch updates. however, it does not create new custom fields; it only modifies existing ones.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_DELAYED_ROUTING_RULES
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 workflows, such as sending documents after a specified delay or at a future date. it’s particularly useful for managing complex document processes that require timed releases or staged approvals. the endpoint supports setting either a relative delay or an exact send date, but not both simultaneously. note that the maximum allowed delay is 30 days from the time of the request.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDS
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 document, such as internal reference numbers, project codes, or any other metadata relevant to your document workflow. the endpoint is particularly useful for maintaining up-to-date metadata in frequently used templates without recreating them. note that while docusign stores and returns these custom fields, it does not process or use them for any internal operations. the update is specific to a single document within a template, identified by the documentid parameter.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_LOCK_INFORMATION
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 being edited, ensuring that multiple users don’t make conflicting changes simultaneously. the endpoint requires the x-docusign-edit header for authorization and can update specific lock properties without affecting others. it should be used when you need to extend a lock duration or update the locking application’s identifier, but not for creating new locks or unlocking templates.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_NOTIFICATION_SETTINGS
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 to modify the notification behavior for a frequently used template without changing the template’s core content. it provides granular control over when and how often recipients are reminded about pending signatures, as well as when the envelope will expire. this functionality helps in managing document workflows more efficiently by reducing the need for manual follow-ups and ensuring timely completion of signing processes.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITY
This endpoint updates the document visibility settings for a specific recipient in a docusign template. it allows you to control which documents are visible to particular recipients, enhancing document security and customizing the signing experience. use this when you need to modify document access for a recipient after a template has been created. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types (carbon copy, certified delivery, editor, and agent) will always have visibility to all documents.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_SCHEDULED_SENDING_RULES
Updates the scheduled sending rules for a docusign template, allowing users to configure delayed sending for envelopes. this endpoint enables setting up either a relative delay or a specific future date for sending envelopes based on the template. it can be used to automate timed document delivery or coordinate with bulk send operations. the tool is particularly useful for managing complex document workflows that require precise timing or coordination with other business processes. note that the maximum delay allowed is 30 days from the time of the request.
Action Parameters
Action Response
DOCUSIGN_UPDATE_TEMPLATE_WORKFLOW_DEFINITION
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 particularly useful for complex signing workflows that require precise control over the timing and conditions of each step in the process. the updated workflow can include features such as delayed sending, conditional recipients, and paused steps, providing flexibility in managing the document lifecycle. this tool should be used when there’s a need to modify or refine the existing workflow of a template to accommodate specific business processes or compliance requirements. it’s important to note that this update affects only the workflow definition and does not modify other aspects of the template such as document content or basic recipient information.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_ACCOUNT_SETTINGS
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 capabilities, and template management options. the endpoint is particularly useful when administrators need to modify user settings en masse or when users require specific configuration changes to align with their workflow or organizational requirements. it’s important to note that while this endpoint offers extensive customization, some settings may be restricted based on the user’s permissions or account type. additionally, changes made through this endpoint may have immediate effects on the user’s docusign experience and should be used judiciously.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_AUTHORIZATION_DATES
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 particularly useful for extending or shortening authorization periods, ensuring that access rights are aligned with business needs and security policies. the endpoint returns detailed information about the updated authorization, including user details and permission levels. use this when you need to adjust the timeframe of an existing user authorization without changing other authorization parameters.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_INFORMATION_FOR_SPECIFIED_USER
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 user profiles, adjusting user permissions, or updating user-specific configurations within a docusign account. the operation requires the account id and user id as path parameters, and accepts a complex json object in the request body containing the updated user information. note that users can only access and modify their own information, even if they have administrative privileges. the endpoint returns the updated user information upon successful modification.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_NOTARY_INFORMATION
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 compliance with regulations. note that all required fields must be provided, even for partial updates.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_PROFILE_IMAGE
Updates a user’s profile image in docusign by uploading a new image file. this endpoint allows users to personalize their docusign account by changing their profile picture. the tool supports various image formats (gif, png, jpeg, and bmp) and has specific size and dimension recommendations for optimal display. it’s important to note that users can only update their own profile image, and the actual method of sending the image file is not specified in the schema.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_PROFILE_INFORMATION
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. use for keeping user profiles current and adjusting preferences.
Action Parameters
Action Response
DOCUSIGN_UPDATE_USER_SIGNATURE_BY_ID
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 exist. the endpoint requires the user to be authenticated and a member of the specified account, with the userid matching the authenticated user’s id. it’s particularly useful for personalizing signature appearance or creating new signatures for users within an organization’s docusign account.
Action Parameters
Action Response
DOCUSIGN_UPDATE_WORKFLOW_STEP_FOR_TEMPLATE
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 customization of document workflows within docusign templates. it’s particularly useful for implementing complex routing scenarios, adding delays in document processing, or setting up conditional recipient rules based on form field values or other criteria. this tool should be used when there’s a need to modify existing workflow steps in a template to adjust the document routing process or recipient handling.
Action Parameters
Action Response
DOCUSIGN_UPDATE_WORKSPACE_INFORMATION
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 account id and workspace id to identify the specific workspace to update. you can update multiple properties of the workspace in a single request by including them in the request body. note that this operation may affect all users with access to the workspace, so use it carefully. the endpoint returns the full updated workspace object, allowing you to confirm the changes made.
Action Parameters
Action Response
DOCUSIGN_UPDATE_WORKSPACE_ITEM_METADATA
This endpoint updates the metadata for one or more specific files or folders in a docusign workspace. it allows users to modify information associated with workspace items without changing the actual content of the files. this method is useful for updating properties such as names, permissions, or other metadata attributes of workspace items. it should be used when changes to item details are needed, but not for modifying the file contents themselves. the endpoint requires specific identification of the account, workspace, and item (file or folder) being updated.
Action Parameters
Action Response