Skip to main content
DocuSign logo
  • Category: signatures
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 338
  • Triggers: 20
  • Slug: DOCUSIGN
  • Version: 20261101_00

Frequently Asked Questions

Create and configure your own DocuSign OAuth app when you want to use your own DocuSign credentials with Composio. For the setup steps, see How to create OAuth credentials for DocuSign.

Tools

Slug: DOCUSIGN_ADD_CONTACTS_TO_CONTACTS_LISTAdds 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.

Input Parameters

string
The DocuSign account ID (GUID format) or external account number. Use ‘auto’ to automatically use the authenticated account.
array
Array of contact objects to add to the account’s contact list. Each contact must include at least an email address. Contacts with multiple emails will be split into separate entries by DocuSign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_EMAIL_OVERRIDES_TO_ENVELOPEAdds 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account number (integer) or the account ID GUID. It is required to specify which account the envelope belongs to. Format: string.
string
required
The unique identifier for the specific envelope to which the email settings will be applied. This is a GUID (Globally Unique Identifier) that uniquely identifies the envelope within the DocuSign system. Format: string. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
array
An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. While this property is an array, note that it takes only a single email address. Note: Only users with the canManageAccount setting set to true can use this option. Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. Example: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.
string
The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.
string
The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_ENVELOPE_ATTACHMENTSAdds 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.

Input Parameters

string
The DocuSign account ID (GUID format). This parameter is automatically populated by the system from your authenticated account, so you typically don’t need to provide it. If provided explicitly, it must match your authenticated account ID.
string
required
The unique identifier for the envelope to which attachments will be added. This is a required parameter in the format of a GUID (Globally Unique Identifier). Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It specifies the exact envelope that will receive the new attachments.
array
A list of attachment objects to add to the envelope. Each attachment should include a name and either base64-encoded data or a remoteUrl.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_EXISTING_BRAND_TO_GROUPThis 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.

Input Parameters

array
required
A list of brand objects to add to the group. Each object must contain a valid brandId. This replaces any existing brand assignments for the group, so include all brands that should be associated with the group, not just new ones. An empty list will remove all brand associations from the group.
string
required
The ID of the group being accessed. This is a required parameter that specifies which group will have brands added to it. The groupId must be a valid, existing group within the specified account. It is typically a string of characters that uniquely identifies the group in the DocuSign system.
string
The external account number (int) or account ID GUID. This parameter is automatically populated by the DocuSign base action from your authenticated session. It identifies the DocuSign account for which the group brand association is being updated. You typically do not need to provide this value manually as it will be injected automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_FILE_TO_WORKSPACEThis 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.

Input Parameters

object
required
The file to upload to the workspace folder. The file content will be uploaded to the specified workspace folder.
string
required
The unique identifier of the folder within the workspace where the file will be added. This parameter is required and must be a valid string representation of the folder ID. The folderId is typically a GUID, for example: “f1o2l3d4-e5r6-i7d8-9a0b-c1d2e3f4g5h6”. Use “root” as a special value to add the file to the root folder of the workspace.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account where the file will be added. This parameter is required and must be a valid string representation of either an integer or a GUID. For example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier of the workspace where the file will be added. This parameter is required and must be a valid string representation of the workspace ID. The workspaceId is typically a GUID, for example: “w1x2y3z4-a1b2-c3d4-e5f6-g7h8i9j0k1l2”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_MEMBERS_TO_SIGNING_GROUPThis 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.

Input Parameters

array
List of users to add to the signing group. Each user must have an email address and userName. You can add up to 50 members in a single request. Each member should have a valid email address and a display name (userName) with a maximum length of 100 characters.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account the signing group belongs to.
string
required
The unique identifier of the signing group to which members will be added. This parameter is required and must be provided in the path of the API request. It should be a string value that corresponds to an existing signing group within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_NEW_USERS_TO_A_SPECIFIED_ACCOUNTAdds one or more users to the connected DocuSign account, with optional permissions and settings. Returns user details such as IDs and status.

Input Parameters

array
A list of one or more new users.
string
The external account number (int) or account ID GUID for the DocuSign account where new users will be added. This parameter is required and must be provided in the path of the API request. It uniquely identifies the account in which the operation will be performed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_OR_UPDATE_ACCOUNT_STAMPSAdd or update account-level stamps (Japanese Hanko-style stamps) in DocuSign. Stamps are pre-configured signature images that can be applied to documents. This action supports creating new stamps or updating existing ones by including the signatureId. Common use cases: - Create name stamps (NameHanko format) for quick document signing - Create name+date stamps (NameDateHanko format) for timestamped signatures - Update stamp properties like size, format, or resize permissions - Manage multiple stamps in bulk operations Required fields for creating stamps: - signatureName: Display name for the stamp - stampType: Must be ‘stamp’ (not ‘signature’) - stampFormat: Either ‘NameHanko’ or ‘NameDateHanko’ To update existing stamps: Include the signatureId along with updated fields. Note: This manages stamp definitions only, not the actual signing of documents.

Input Parameters

string
The DocuSign account ID (GUID format). If not provided, it will be automatically populated from the authentication context. Example: ‘00000000-0000-0000-0000-000000000000’
string
Reserved query parameter. When provided, may affect request processing behavior. Generally not needed for normal operations.
array
Array of stamps/signatures to create or update. To create a new stamp, provide signatureName, stampType=‘stamp’, and stampFormat. To update, include the signatureId. Required fields for stamps: signatureName, stampType, stampFormat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_OR_UPDATE_USER_CUSTOM_SETTINGSAdds or updates custom settings for a specified DocuSign user. These name-value settings can store user-specific information separate from standard account settings, with a 4,000-character limit per user including structure.

Input Parameters

string
required
The unique identifier of the user whose custom settings are being added or updated. Must be a valid DocuSign user ID in GUID format (e.g., ‘36b1ef9f-8ab7-426c-898b-951c08c74bdd’). Can be obtained from the List Users for Account action or from the OAuth userinfo endpoint. Required parameter.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from the OAuth token’s userinfo endpoint and does not need to be provided manually.
array
A list of name-value pairs representing the custom settings to add or update. Each setting consists of a ‘name’ (the setting key) and ‘value’ (the setting data). If a setting with the same name already exists, it will be updated; otherwise, it will be added. The total size of all custom settings per user is limited to 4,000 characters including structure. Optional parameter - if omitted, no settings will be modified. Supports Unicode characters, JSON strings, and various data types stored as strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_OR_UPDATE_USER_SIGNATUREThis 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.

Input Parameters

string
required
The unique identifier of the user whose signature is being added or updated. Users can only modify their own signatures, even if they have administrative rights. This is typically extracted automatically from the authentication token.
string
The account ID GUID that identifies the DocuSign account. If not provided, it will be automatically extracted from the authentication token.
array
An array of signature objects to create or update. Each object can specify the signature name, initials, font, and other properties. You can include multiple signatures in a single request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_PART_TO_CHUNKED_UPLOADAdds 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.

Input Parameters

string
A base64-encoded representation of the content that is used to upload the file. Maximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account associated with the chunked upload. This parameter is required and must be provided in the path of the API request. It”s used to ensure that the chunked upload is associated with the correct account.
string
required
The unique identifier for the chunked upload. This ID is generated when the chunked upload is initiated and must be included in the path for all subsequent part uploads. It”s a required parameter that links all parts of the chunked upload together.
string
required
The sequence or order of the part in the chunked upload. This is a required parameter in the path. By default, the sequence of the first part (uploaded during creation) is “0”. Subsequent parts should be numbered sequentially (1, 2, 3, etc.). While parts can be added out of order, the upload must consist of a contiguous series of parts before it can be successfully committed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_STEP_TO_ENVELOPE_WORKFLOWThis 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.

Input Parameters

string
Indicates the action to perform. Valid values: - pause_before: The workflow should pause before the trigger described by triggerOnItem is reached.
string
The identifier of the item that triggers this workflow step. When triggerOnItem is set to routing_order, this should be the routing order number (as a string) where the workflow step action should occur. For example, setting itemId to “2” with action as “pause_before” will pause the envelope before it reaches routing order 2.
string
The status of the step. Valid values: - inactive - in_progress - paused - pending - completed This property is read-only.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API call. It is used to specify which account the envelope belongs to.
string
required
The unique identifier for the envelope to which the workflow step will be added. This parameter is required and must be provided in the path of the API call. It should be a valid GUID (Globally Unique Identifier) format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
The timestamp of when the workflow step transitioned to completed status. This property is read-only.
string
The type of item that triggers this workflow step. Valid values: * routing_order
string
The timestamp of when the workflow step transitioned to in_progress status. This property is read-only.
string
A unique identifier for this workflow step. This property is read-only.
array
User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
array
An array of conditional recipient configurations for advanced recipient routing. Conditional recipients allow you to control envelope flow by specifying different recipients based on conditions such as tab values or recipient actions. Each conditional recipient definition includes conditions that determine when the recipients should be used, along with the recipient group details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_TEMPLATES_TO_DOCUMENT_IN_ENVELOPEThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a string value representing either a numeric account number or a GUID format for the account ID.
string
required
The unique identifier for the document within the envelope. This parameter is required and must be specified in the path. Unlike other IDs in the eSignature API, you define this ID yourself. Typically, the first document has ID “1”, the second “2”, and so on, but you can use any numbering scheme within the range of a 32-bit signed integer (1 to 2147483647). This ID is crucial for identifying which document in the envelope will receive the template.
string
required
The unique identifier (GUID) for the envelope. This parameter is required and must be provided in the path. It should be a string in the format of a GUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ID specifies which envelope contains the document to be modified with the template.
array
List of templates to apply to the document. Each template must include at minimum a templateId. You can optionally specify documentStartPage and documentEndPage to control which pages of the document the template applies to.
string
An optional query parameter that controls whether envelope recipients are preserved when applying a template. It accepts a string value of “true” or “false”. When omitted or set to “false” (the default), envelope recipients may be removed if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When set to “true”, the recipients will be preserved after the template is applied, regardless of anchor text presence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_TEMPLATES_TO_ENVELOPEThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API call. It ensures that the operation is performed on the correct account.
string
required
The unique identifier (GUID) of the envelope to which templates will be added. This parameter is required and must be provided in the path of the API call. It should be in the format of a GUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ensures that the templates are added to the specific envelope intended by the API caller.
array
string
An optional query parameter that determines whether to preserve or remove envelope recipients when applying the template. Valid values are ‘true’ or ‘false’. If omitted or set to ‘false’ (default), envelope recipients will be removed if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When set to ‘true’, the recipients will be preserved after the template is applied. This parameter allows fine-grained control over recipient management during template application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_USER_SIGNATURE_AND_INITIALS_IMAGESAdds or updates the authenticated user’s DocuSign signature and initials using JSON signature definitions; DocuSign can generate default images from the name and font, and signature IDs may change on update. The account is normally the first returned by OAuth userinfo, overriding the supplied account ID.

Input Parameters

string
required
The ID of the user to access. This parameter specifies which user”s signature is being modified. It must be a valid user ID within the specified account. Note that users can only access their own information, even those with Admin rights cannot access another user”s settings. This parameter is required for the API call.
string
required
The external account number (int) or account ID GUID. This parameter identifies the DocuSign account associated with the user whose signature is being added or updated. It must be a valid account identifier. Required.
array
An array of user signature objects to create or update. Each object can specify a signature name, initials, font style (e.g., ‘7_DocuSign’, ‘Mistral’, ‘Rage Italic’), and various metadata fields. When using JSON content type, DocuSign generates default signature images based on the provided name and font. Optional. If not provided, no signatures will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ADD_USERS_TO_EXISTING_GROUPAdds 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.

Input Parameters

array
An array of user objects to add to the group. Each user object should contain at minimum the ‘userId’ field with the user’s ID (GUID). Alternatively, you can provide the ‘email’ field to identify the user by email address. Other fields like ‘userName’ are optional and will be ignored when adding users to a group.
string
required
The unique identifier of the group to which users will be added. This parameter is required and must be provided in the path. It specifies the target group for the user addition operation. The value should be a valid group ID within the specified account, typically a string or numeric identifier assigned by DocuSign.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your connected account and typically does not need to be provided. If specified, it should be a valid DocuSign account identifier in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_APPLY_ACTION_TO_BULK_SEND_ENVELOPESThis 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.

Input Parameters

string
The action to apply in the request body. Valid values: Resend, Correct, Void (capitalized). This should match the bulkAction path parameter but with capitalization. Optional - if not provided, the action is inferred from the path parameter.
string
The external account number (int) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the bulk send batch. It must be a valid string representing either an integer account number or a GUID.
string
required
The action to apply to the bulk send batch. This parameter is required and must be one of: “resend” (resend failed/undelivered envelopes), “correct” (make corrections to envelopes), or “void” (cancel and void all envelopes). Use lowercase values. The action will be applied to all envelopes in the batch.
string
Reason for voiding the envelope. This message is shown to recipients. Required when bulkAction is “void” or action is “Void”. Example: “Document no longer needed due to updated requirements.”
string
required
The unique identifier for the bulk send batch. This parameter is required and must be a valid string representing the specific batch ID to which the action will be applied. This ID is typically obtained when creating or retrieving information about a bulk send batch.
boolean
Whether to use account default notification settings. When true, ignores reminder and expiration settings in this request and uses account defaults. When false, uses the settings specified in this request. Default: false.
integer
Number of days before expiration to send a warning email to recipients. Set to 0 to disable warning emails. Example: 7 (warn 7 days before expiration).
integer
Number of days the envelope is active before expiring. Only applies when expireEnabled is set to true. Example: 120 (envelope expires in 120 days).
integer
Number of days after envelope is sent before the first reminder is sent. Example: 3 (send first reminder 3 days after envelope is sent). Default: 0.
boolean
Whether envelope expiration is enabled. When true, the envelope expires after the number of days specified in expireAfter. When false or not set, uses account default expiration settings.
boolean
Whether reminders are enabled. When true, reminder emails are sent to recipients based on the delay and frequency settings. Default: false.
integer
Interval in days between reminder emails after the initial reminder. Example: 5 (send reminder every 5 days). Default: 0 (no recurring reminders).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CHANGE_USERS_IN_ACCOUNTThis 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.

Input Parameters

array
User management information.
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
The external account number (int) or account ID GUID. This parameter is required and identifies the specific DocuSign account in which the user(s) will be updated. It must be a valid account identifier associated with the API caller”s access token.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.
string
An optional query parameter that, when set to true, allows the use of all languages supported by DocuSign for the user(s) being updated. This can be useful when updating users in multinational organizations or when enabling support for multiple languages within an account. If not specified, the default language settings for the account will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CLOSE_USERS_IN_ACCOUNTCloses 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.

Input Parameters

array
An array of userInfo objects containing information about the users in the group.
string
An optional query parameter that specifies a list of groups to remove the user from when closing their account. It accepts a comma-separated list of the following values: “Groups”, “PermissionSet”, and “SigningGroupsEmail”. This parameter allows for fine-grained control over user group memberships during the closure process.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the request. It ensures that the operation is performed on the correct account within the DocuSign system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_COMMIT_CHUNKED_UPLOAD_FOR_ENVELOPESThis 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.

Input Parameters

string
The action to perform on the chunked upload. Must be set to ‘commit’ to finalize the upload. This instructs the API to validate and prepare the chunked upload for use with other API calls such as envelope creation.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is automatically injected by the DocuSign base action from the authenticated user’s account information.
string
required
The unique identifier for the specific chunked upload that is being committed. This ID is obtained when initializing the chunked upload process. It is required to identify which upload is being finalized. The value must be a non-empty string that corresponds to an existing chunked upload in the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CONFIGURE_CLOUD_STORAGE_REDIRECT_URLConfigures the OAuth redirect URL for one or more cloud storage providers (Box, Dropbox, GoogleDrive, SkyDrive/OneDrive, Salesforce) for a specific user in DocuSign. This action sets up the authentication flow between DocuSign and cloud storage services by specifying where users should be redirected after authenticating with the cloud storage provider. The redirect URL must be within the docusign.com or docusign.net domains for security. The response includes authentication URLs with the redirect URL appended as a query parameter. Direct users to these URLs to complete the OAuth flow and connect their cloud storage accounts to DocuSign. Use this when integrating cloud storage services to enable users to access documents from external providers within DocuSign workflows.

Input Parameters

string
required
The user ID for whom to configure cloud storage. Use ‘me’ to configure for the authenticated user, or provide a specific user ID GUID. Note: users can only configure their own cloud storage settings, even with admin privileges.
string
The DocuSign account ID. This is automatically populated from your authentication token and should be left empty. The system will fetch the account ID from the authenticated user’s information.
array
List of cloud storage provider configurations to set up. Each item specifies a provider (via ‘service’ or ‘serviceId’) and its redirect URL. Example: [{‘service’: ‘Box’, ‘redirectUrl’: ‘https://www.docusign.com/oauth/callback’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_ACCOUNT_CUSTOM_FIELDCreates 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.

Input Parameters

string
The name of the custom field (required). This name will be used to identify the custom field throughout the account and in envelopes. Choose a descriptive name that clearly indicates the field’s purpose.
string
When set to ‘true’, the custom field displays at the top of the Certificate of Completion. When set to ‘false’ or omitted, the field is not displayed. Accepts string values ‘true’ or ‘false’.
string
The default value for the custom field. For text fields, this can be any string up to 2,000 characters. For list fields, this should match one of the items in the ‘listItems’ array to pre-select that option.
string
When set to ‘true’, the signer must complete this custom field before the envelope can be completed. When set to ‘false’ or omitted, the field is optional. Accepts string values ‘true’ or ‘false’.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. When not provided, the account ID from the authentication context will be used automatically.
array
Required when customFieldType is ‘list’. An array of strings representing the selectable options in the dropdown list. Each item can be up to 2,000 characters. Example: [‘Option A’, ‘Option B’, ‘Option C’].
string
The type of custom field to create. Valid values: ‘text’ (for text input fields) or ‘list’ (for dropdown selection fields). When using ‘list’, you must also provide the ‘listItems’ parameter. Defaults to ‘text’.
string
When set to ‘true’, applies the newly created custom field to all existing templates in the account. When set to ‘false’ or omitted, the custom field will only be available for new envelopes. Accepts string values ‘true’ or ‘false’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_A_COLLABORATIVE_WORKSPACECreates a new collaborative workspace in DocuSign for document management and team collaboration. A workspace provides a centralized area for file sharing and collaborative work on agreements. Use this when setting up a new project or team workspace. The creator becomes the workspace owner automatically. After creation, you can add members and upload files using separate actions. Minimal required input: accountId and workspaceName. Optional settings include workspaceDescription and commentsAllowed for enabling document comments.

Input Parameters

string
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
string
The UTC DateTime when the workspace user authorization was created.
string
The DocuSign account ID (GUID) or external account number for which to create the workspace. This identifies which account will own the workspace.
string
The ID of the workspace, always populated.
string
Utc date and time the comment was last updated (can only be done by creator.)
string
The relative URI for accessing the workspace.
string
The name of the workspace.
string
The relative URL for accessing the workspace.
string
The ID of the account to bill.
string
Text describing the purpose of the workspace.
string
Type of the user. Valid values: type_owner, type_participant.
string
The workspace user”s email address.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
When true, commenting on the documents in the workspace is allowed.
string
The UTC DateTime when the workspace user was created.
string
Type of the user. Valid values: type_owner, type_participant.
string
The name of workspace user.
string
The workspace user”s email address.
string
The account ID associated with the workspace user.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
The UTC DateTime when the workspace user was created.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
The name of workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
The account ID associated with the workspace user.
string
Type of the user. Valid values: type_owner, type_participant.
string
The workspace user”s email address.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
The ID of the workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
The UTC DateTime when the workspace user was created.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The name of workspace user.
string
The account ID associated with the workspace user.
string
The ID of the workspace user.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
A brief message describing the error condition.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
The ID of the workspace user.
string
A brief message describing the error condition.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
A brief message describing the error condition.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_BCC_EMAIL_ARCHIVE_CONFIGURATIONCreates 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. Key Details: - Only requires the ‘email’ parameter - the BCC email address to receive archived emails - Supports up to 5 active and pending email archive addresses per account - Each email address must be added one at a time - After creation, an activation email is sent to the BCC address for confirmation Important: The BCC Email Archives feature must be enabled for your DocuSign account before using this action. If not enabled, you’ll receive a “BCC_EMAIL_ARCHIVES_NOT_ACTIVATED” error. Contact DocuSign support to enable this feature if needed.

Input Parameters

string
The BCC email address to use for archiving DocuSign emails. This is the only required field in the request body. The email address will receive copies of all DocuSign notifications for this account. Example: archive@example.com
string
The external account number (integer) or account ID GUID that identifies the DocuSign account for which the BCC email archive configuration is being created. This parameter is required and must be provided in the path of the API request. It ensures that the BCC email archive is associated with the correct account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_BRAND_PROFILES_FOR_ACCOUNTCreates a new brand profile for a DocuSign account to customize the signing and sending experience with your organization’s visual identity and branding elements. This action allows you to define brand properties such as company name, brand languages, colors for UI elements (buttons, headers), and custom landing pages. The accountId is automatically populated from authentication credentials. Brand logos must be uploaded separately using the brand logo management endpoints after creating the brand profile. Requirements: The DocuSign account must have ‘canSelfBrandSign’ or ‘canSelfBrandSend’ settings enabled. Without these permissions, the API will return a 400 error. Contact your DocuSign administrator to enable branding features if needed. Typical workflow: 1) Create brand profile with this action, 2) Upload logos via updateLogo endpoint, 3) Apply brand to envelopes during creation.

Input Parameters

An array of brandLink objects that contain information about the links that the brand uses.
array
An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text
string
The ID used to identify a specific brand in API calls.
string
The DocuSign account ID (GUID format like ‘b06ae21f-4d1a-4da9-8e7a-795f6c9c8f7b’). This parameter is automatically populated from your authentication credentials and typically does not need to be provided manually. If you need to target a different account, provide the account ID GUID explicitly.
string
The name of the brand.
string
The name of the company associated with the brand.
array
Deprecated.
array
An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used.
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
array
An array of two-letter codes for the languages that you want to use with the brand. The supported languages are: - Arabic (ar) - Armenian (hy) - Bahasa Indonesia (id) - Bahasa Malay (ms) - Bulgarian (bg) - Chinese Simplified (zh_CN) - Chinese Traditional (zh_TW) - Croatian (hr) - Czech (cs) - Danish (da) - Dutch (nl) - English UK (en_GB) - English US (en) - Estonian (et) - Farsi (fa) - Finnish (fi) - French (fr) - French Canada (fr_CA) - German (de) - Greek (el) - Hebrew (he) - Hindi (hi) - Hungarian (hu) - Italian (it) - Japanese (ja) - Korean (ko) - Latvian (lv) - Lithuanian (lt) - Norwegian (no) - Polish (pl) - Portuguese (pt) - Portuguese Brasil (pt_BR) - Romanian (ro) - Russian (ru) - Serbian (sr) - Slovak (sk) - Slovenian (sl) - Spanish (es) - Spanish Latin America (es_MX) - Swedish (sv) - Thai (th) - Turkish (tr) - Ukranian (uk) - Vietnamese (vi)
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
boolean
When true, the sending brand is the default brand for sending new envelopes.
boolean
When true, the siging brand is the default brand for the signing experience.
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
string
The URI for the email resource file that the brand uses.
string
The URI for the sending resource file that the brand uses.
string
The URI for the signing resource file that the brand uses.
string
Indicates if this brand is associated with the organization level. Used for enterprise accounts with organizational hierarchies.
string
The two-letter code for the language that you want to use as the brand default. The supported languages are: - Arabic (ar) - Armenian (hy) - Bahasa Indonesia (id) - Bahasa Malay (ms) - Bulgarian (bg) - Chinese Simplified (zh_CN) - Chinese Traditional (zh_TW) - Croatian (hr) - Czech (cs) - Danish (da) - Dutch (nl) - English UK (en_GB) - English US (en) - Estonian (et) - Farsi (fa) - Finnish (fi) - French (fr) - French Canada (fr_CA) - German (de) - Greek (el) - Hebrew (he) - Hindi (hi) - Hungarian (hu) - Italian (it) - Japanese (ja) - Korean (ko) - Latvian (lv) - Lithuanian (lt) - Norwegian (no) - Polish (pl) - Portuguese (pt) - Portuguese Brasil (pt_BR) - Romanian (ro) - Russian (ru) - Serbian (sr) - Slovak (sk) - Slovenian (sl) - Spanish (es) - Spanish Latin America (es_MX) - Swedish (sv) - Thai (th) - Turkish (tr) - Ukranian (uk) - Vietnamese (vi)
string
A brief message describing the error condition.
URI to the organization brand logo. This is a read-only field that provides the logo URI for organization-level brands.
string
The code associated with the error condition.
boolean
When true, the brandCompany property is overriding the name of the company in the account settings.
string
The URI for the captive (embedded) signing resource file that the brand uses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_BULK_SEND_REQUESTInitiates a bulk send process in DocuSign to send a single template or envelope to multiple recipients in a single batch operation. This is ideal for large-scale document distribution scenarios such as sending contracts to numerous clients or company-wide notices. Prerequisites: 1. Create a bulk send list first (using createBulkSendList API) with recipient data 2. Ensure you have a template with recipient roles matching the bulk list’s roleNames 3. The bulk send list must contain at least one recipient entry How it works: - The bulk send list defines recipient data (names, emails, role assignments) - The template defines the document structure and recipient roles - DocuSign creates one envelope per entry in the bulk send list - All envelopes are queued asynchronously for processing Important: Test compatibility using createBulkSendTestRequest before sending. The returned batchId can be used to track the bulk send operation status.

Input Parameters

string
The external account number (int) or account ID GUID of the DocuSign account. This is a required path parameter that identifies the account associated with the envelope being sent in bulk. It must be a valid account identifier in string format.
string
The human-readable name of the batch. If you do not set this value, it defaults to the name property of the bulkSendingList object.
string
required
The GUID of the bulk send list to be used for this bulk send operation. This is a required path parameter. A bulk send list contains the recipient data (names, emails, and role assignments) for each copy of the envelope/template to be sent. You must create a bulk send list first using the createBulkSendList endpoint before using this action. The list must contain at least one recipient with a roleName that matches a role in your template.
string
required
The GUID of the envelope or template that you want to send in bulk. This is a required parameter. The template or envelope must have recipient roles defined that match the roleName values in the bulk send list. For example, if your bulk send list has recipients with roleName ‘Signer’, your template must have a recipient with the role ‘Signer’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_BULK_SEND_TEST_REQUESTThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID for the DocuSign account. This parameter is required and must be provided in the path. It uniquely identifies the account for which the bulk send test is being performed. The value should be a valid DocuSign account identifier, typically a string of alphanumeric characters.
string
The human-readable name of the batch. If you do not set this value, it defaults to the name property of the bulkSendingList object.
string
required
The GUID (Globally Unique Identifier) of the bulk send list to be tested. This parameter is required and must be provided in the path. It is created after posting a new bulk send list and uniquely identifies the list of recipients for the bulk send operation. The value should be a valid GUID string, typically in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
string
The GUID of the envelope or template that you want to send in bulk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_CONNECT_CONFIGURATION_FOR_ACCOUNTThis 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.

Input Parameters

string
The name of the Connect configuration. This property is required.
array
A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the urlToPublishTo property. Set this property when you are using the JSON SIM event model. If you are instead using any of the legacy event message formats, set either the envelopeEvents property or the recipientEvents property. The possible event statuses are: * envelope-created * envelope-sent * envelope-resent * envelope-delivered * envelope-completed * envelope-declined * envelope-voided * recipient-authenticationfailed * recipient-autoresponded * recipient-declined * recipient-delivered * recipient-completed * recipient-sent * recipient-resent * template-created * template-modified * template-deleted * envelope-corrected * envelope-purge * envelope-deleted * envelope-discard * recipient-reassign * recipient-delegate * recipient-finish-later * click-agreed * click-declined
array
A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. By default, the users will be included in the configuration. If you want to exclude the users, set the allUsersExcept property to true. Note: If allUsers is set to false, then you must provide a list of user IDs.
string
When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is false. Note: If this property is false, make sure you set the userIds property to a non-empty array of user IDs.
array
A list of group IDs to associate with this Connect configuration for event filtering.
string
The password for the Connect configuration. This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.
string
The name of the user.
string
The external account number (integer) or account ID GUID for which the Connect configuration is being created. This parameter is required and must be provided in the path of the API call.
string
The Docusign-generated ID for the Connect configuration. This property is read-only.
string
When true, Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues. You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the Logs tab in the Connect console.
array
An array of Salesforce objects.
string
The email address of the user who disabled this Connect configuration.
string
When true, includes an HMAC signature in webhook messages for verification and security.
string
The delivery mode of the configuration. Valid values: * SIM * Aggregate
string
When true, includes OAuth authentication information in the Connect notification.
string
The namespace of the SOAP interface. Note: If useSoapInterface is set to true, you must set this value.
string
This flag allows you to toggle between including and excluding specified users from the configuration. When false, the users corresponding to the IDs in userIds will be included in the configuration. Conversely, when true, the users will be excluded from the configuration. The default value is false.
array
A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * Delivered * Completed * Declined * Voided Note: These values are case-sensitive.
string
When true, allows envelope senders to override the Connect configuration settings.
string
The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
array
An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * AutoResponded * Delivered * Completed * Declined * AuthenticationFailed Note: These values are case-sensitive.
string
The ID of an external folder.
string
Reserved for Docusign.
string
When true, Mutual TLS authentication is enabled.
string
When true, the notifications are sent to your endpoint as SOAP requests.
string
The type of the configuration. Valid values: * custom: Creates an account-level configuration * customrecipient: Creates a Recipient Connect configuration * salesforce * eOriginal This property is required.
string
The format of the event data. Use ‘json’ or ‘xml’. When using restv2.1, JSON format is recommended.
string
When true, indicates this configuration is managed by an integration partner or ISV.
string
Set this property to restv2.1 to return event data in JSON. If the property is not set, the event data will be returned in XML by default.
string
The OAuth authorization code for Salesforce integration authentication.
string
The label for an external folder.
string
Set this value to true to enable the webhook. The default property is false.
string
The version of the Salesforce API that you are using.
string
When true, the SOAP header includes certificate information for authentication.
string
When true, the Document Fields associated with the envelope”s documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.
string
The callback URL for Salesforce OAuth authentication flow.
array
This property sets the items that are available for selection when adding or editing Connect objects.
string
When true, Docusign sends data to the designated Salesforce account through Connect. The default value is true.
array
A string array of the data to be included. The default is the empty array []. - attachments: Include attachments associated with the envelope. - custom_fields: Include the custom fields associated with the envelope. - documents: Include the documents associated with the envelope. - extensions: Include information about the email settings associated with the envelope. - folders: Include the folder where the envelope exists. - payment_tabs: Include the payment tabs associated with the envelope. - powerform: Include the PowerForms associated with the envelope. - prefill_tabs: Include the pre-filled tabs associated with the envelope. - recipients: Include the recipients associated with the envelope. - tabs: Include the tabs associated with the envelope.
string
When true, event delivery acknowledgements are enabled for your Connect configuration. Docusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back. #### When true and Send Individual Messages (SIM) mode is activated If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down. The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason Pending. When a message succeeds, all queued messages for the configuration will be tried immediately, in order. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When true and SIM mode is not activated If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When false When requiresAcknowledgement is set to false and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.
string
When true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
string
When true, Connect will include the envelope time zone information.
string
When true, the Connect Service includes the Certificate of Completion with completed envelopes.
string
When true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer”s web server) during the TLS handshake protocol.
string
When true, Connect will include the sender account as Custom Field in the data.
string
When true, Docusign can use documents in your Salesforce account for sending and signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_CUSTOM_DOCUMENT_FIELDS_IN_ENVELOPECreates 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It”s used to specify which account the operation should be performed on. The value should be a string representing either a numeric account number or a GUID (Globally Unique Identifier) in the standard format.
string
required
The unique identifier of the document within the envelope. This parameter is required and must be provided in the path. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically, the first document has the ID “1”, the second document “2”, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). This ID is used in tab objects to specify which document the tab should be placed on.
string
required
The envelope”s GUID (Globally Unique Identifier). This parameter is required and must be provided in the path. It uniquely identifies the envelope that contains the document you want to add custom fields to. The format is a standard GUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
array
The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: * name - A string that can be a maximum of 50 characters. * value - A string that can be a maximum of 200 characters. IMPORTANT: If you are using xml, the name/value pair is contained in a nameValue element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_CUSTOM_FIELDS_FOR_ENVELOPEThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account number (integer) or the account ID GUID. It is a required path parameter used to specify which account the envelope belongs to. The value must be a valid DocuSign account identifier associated with the API user”s credentials.
string
required
The unique identifier for the specific envelope to which custom fields will be added or updated. This is a required path parameter and must be provided as a GUID (Globally Unique Identifier) string. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. The envelopeId must correspond to an existing draft or in-process envelope within the specified account.
array
An array of list custom fields.
array
An array of text custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_CUSTOM_FIELDS_IN_TEMPLATE_DOCUMENTCreates 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request.
string
required
The unique identifier for the document within the template. This is a user-specified ID, typically using sequential numbers (e.g., 1, 2, 3) but can be any positive integer up to 2147483647. This parameter is required and must be provided in the path of the API request.
string
required
The unique identifier for the template in which the custom fields will be created. This parameter is required and must be provided in the path of the API request.
array
The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: * name: A string that can be a maximum of 50 characters. * value: A string that can be a maximum of 200 characters. If you are using XML, the name/value pair is contained in a nameValue element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_CUSTOM_TAB_WITH_PROPERTIESCreates 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.

Input Parameters

string
When true, the information in the tab is bold.
string
The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
string
string
The type of this tab. Values are: - Approve - CheckBox - Company - Date - DateSigned - Decline - Email - EmailAddress - EnvelopeId - FirstName - Formula - FullName - InitialHere - InitialHereOptional - LastName - List - Note - Number - Radio - SignerAttachment - SignHere - SignHereOptional - Ssn - Text - Title - Zip5 - Zip5Dash4
array
If the tab is a list, this represents the values that are possible for the tab.
string
The width of the tab in pixels. Must be an integer.
string
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
string
The height of the tab in pixels. Must be an integer.
string
When true, the information in the tab is italic.
string
When true, the signer cannot change the data of the custom tab.
string
When true, this custom tab is shared.
string
When true, the custom tab is editable. Otherwise the custom tab cannot be modified.
string
The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72
string
When true, the signer is required to fill out this tab.
string
When true, the radio button is selected.
string
The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
string
The external account number (int) or account ID GUID. This parameter is required and must be provided in the path to identify the DocuSign account for which the custom tab is being created.
string
The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
string
The type of stamp. Valid values are: - signature: A signature image. This is the default value. - stamp: A stamp image. - null
string
When true, the information in the tab is underlined.
string
When true and shared is true, information must be entered in this field to complete the envelope.
string
Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.
string
Specifies units of the anchorXOffset and anchorYOffset. Valid units are: - pixels (default) - inches - mms - cms
string
The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
string
The original value of the tab.
string
The UTC DateTime this object was last modified. This is in ISO 8601 format.
string
Specifies the X axis location of the tab in anchorUnits relative to the anchorString.
string
Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.
string
string
The maximum number of entry characters supported by the custom tab.
string
string
Specifies how numerical data is validated. Valid values: - number - currency
string
The userId of the Docusign user who created this object.
string
When true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
string
When true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
string
Specifies the row number in a Salesforce table that the merge field value corresponds to.
string
If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: SHAK1 Maximum Length: 100 characters.
string
If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: Hamlet
string
Sets the object associated with the custom tab. Currently this is the Salesforce Object.
string
string
string
The message displayed if the custom tab fails input validation (either custom of embedded).
string
A regular expression used to validate input for the tab.
string
This property controls how [anchor tabs][AnchorTabs] are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false. For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters: $~><|^+= For example, the anchorString water will match on the string Fetch a pail of water. - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true. - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is i, then only one anchor tab is placed in skiing. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value). Note: You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
Reserved for Docusign.
string
When true, the text string in a document must match the value of the anchorString property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is false. For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When false, if the input is man then man, manpower, fireman, and penmanship will all match. This functionality uses the following rules: - Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters: $~><|^+= For example, the anchorString water will match on the string Fetch a pail of water. - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true. - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is i, then only one anchor tab is placed in skiing. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value). Note: You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
The user name of the Docusign user who created this object.
string
The userId of the Docusign user who last modified this object.
string
When true, data entered into the merge field during Signing will update the mapped Salesforce field.
string
When true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: The Danish play by Shakespeare Maximum Length: 100 characters.
string
When true, this tab is ignored if the anchorString is not found in the document.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
array
Reserved for Docusign.
string
This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - right: Aligns the tab’s left side with the last character of the matching anchor word. Note: You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
The User Name of the Docusign user who last modified this object.
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code. Supported formats: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL
array
An array of option strings supported by this setting.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
string
Optional element for field markup. When true, the signer is required to initial when they modify a shared field.
string
When true, the sender can modify the value of the mergeField tab during the sending process.
string
If you are using merge fields, this property specifies the type of the merge field. The only supported value is salesforce.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
array
An array of option strings supported by this setting.
string
When true, use the long currency format for the locale.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
array
An array of option strings supported by this setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_DOCUMENT_RESPONSIVE_HTML_PREVIEWCreates a responsive HTML preview for a specific document in an envelope. Generates a mobile-friendly preview showing how the document renders on different devices. Useful for testing smart sections, collapsible content, and responsive tables before sending. Requirements: Envelope and document must already exist. Use CREATE_ENVELOPE_FROM_TEMPLATE first. Optional: Provide HTML definition settings (displayAnchors, source) to customize display. Returns: HTML preview of the responsive document version.

Input Parameters

string
Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: source: "<html> ... <body><p>hello world</p></body></html>" If the value of this property is the string document, the HTML signing page is generated from the provided document. source: "document" Related topics - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - Responsive signing [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It helps identify the specific account context for the document preview operation.
string
required
Specifies the document ID number that the tab is placed on. This must refer to an existing Document”s ID attribute.
string
required
The envelope”s globally unique identifier (GUID). This parameter is required and must be provided in the path of the API request. It uniquely identifies the envelope containing the document to be previewed. The format is a string of hexadecimal digits, typically separated by hyphens, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This GUID ensures that the correct envelope and its associated documents are accessed for the preview operation.
string
Header text or an HTML tag to place above the responsive HTML block.
string
The position on the page where the display section appears.
string
The GUID of the document.
array
An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the display property of the displaySettings object.
string
If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level.
string
Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
string
The number of the page on which the display section appears.
string
Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
string
When true (the default), the Mobile-Friendly toggle displays at the top of the screen on the user”s mobile device. When false, the toggle will not be displayed. the Mobile-Friendly toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATECreates a signing envelope from a pre-existing DocuSign template. This action maps specific recipients to template roles and creates an envelope, either as a draft (status=‘created’) or sent immediately (status=‘sent’). Prerequisites: - Use DOCUSIGN_LIST_ALL_TEMPLATES to get template IDs and role names - Role names in template_roles must match template roles exactly (case-sensitive) - Include ‘recipients’ parameter in list templates to see available role names Common Use Cases: - Send contracts, NDAs, or agreements for electronic signature - Create multi-party approval workflows with sequential signing - Distribute documents to carbon copy recipients Returns envelope_id for tracking and management.

Input Parameters

string ("created" | "sent")
The status of the envelope after creation. Use ‘created’ to save as a draft (default, recommended) or ‘sent’ to immediately send the envelope to all recipients for signing. Note: In some environments (e.g., demo accounts), sending immediately may require additional recipient validation. Avoid changing status from ‘created’ to ‘sent’ after creation, as this can trigger duplicate or unexpected email notifications to recipients.
string
required
The DocuSign account ID. This is automatically populated by the base action from the authenticated user’s account information.
string
required
The ID of the template to use for creating the envelope. Must be a valid template ID from the account’s template library. Example: ‘1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p’. Use the DOCUSIGN_LIST_ALL_TEMPLATES action to get available template IDs.
string
required
The subject line for the envelope notification email sent to recipients. This will appear in the recipient’s email inbox.
array
required
List of recipient information that maps to roles defined in the template. Each recipient must have ‘email’, ‘name’, and ‘roleName’. The ‘roleName’ must match a role defined in the template (case-sensitive). Optional fields: ‘recipientId’ (unique identifier, recommended for tracking), ‘routingOrder’ (signing sequence, where 1 signs first). Multiple recipients can share the same routingOrder to sign in parallel. Note: Use DOCUSIGN_LIST_ALL_TEMPLATES with include=‘recipients’ to see available role names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_GROUPS_FOR_ACCOUNTCreates 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.

Input Parameters

array
A collection group objects containing information about the groups.
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
The external account number (integer) or account ID GUID. This parameter identifies the DocuSign account for which the groups will be created. It is required and must be provided in the path of the API request.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_IDPROOF_RESOURCE_TOKEN_FOR_RECIPIENTGenerates a 2-minute resource token to access recipient identity verification data via DocuSign’s ID Evidence API. Requirements: Recipient must have completed identity verification (phone auth, ID scan, etc.) during envelope signing. Fails if envelope is draft or verification incomplete. Usage: Get token and proof_base_uri, then call ID Evidence API with “Bearer {token}” to retrieve verification details (ID scans, selfies, phone records). Response: resource_token (expires 2 min), proof_base_uri (API base URL like https://proof-d.docusign.net). Use for compliance/audit to programmatically verify recipient identity data.

Input Parameters

string
The DocuSign account ID (GUID format). Identifies which account contains the envelope. Usually obtained from authentication metadata or account settings. Example: ‘b06ae21f-4d1a-4da9-8e7a-795f6c9c8f7b’
string
required
The envelope ID (GUID) containing the recipient whose ID verification data you want to access. The envelope must have been sent and the recipient must have completed identity verification. Example: ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’
string
required
The recipient’s unique identifier (recipientIdGuid) within the envelope. This identifies which specific recipient’s ID evidence to retrieve. The recipient must have completed identity verification (e.g., phone auth, ID scan) before this endpoint will work. You can get this ID from envelope recipient lists or from the envelope creation response.
string
Optional scopes/permissions for the resource token. Controls what types of identity verification data can be accessed with the token. If not specified, default scopes are applied. Consult DocuSign ID Evidence API documentation for available scope values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_NEW_ACCOUNT_PERMISSION_PROFILECreates a new DocuSign account permission profile defining user capabilities, from envelope sending to account management. The account is resolved from the connected user’s account information, normally using the first returned account; creating a profile does not automatically assign users to it.

Input Parameters

array
A list of user objects containing information about the users who are associated with the account permission profile.
string
A comma-separated list of additional properties to return in the response. The only valid value for this request is metadata, which returns metadata indicating whether the properties associated with the account permission profile are editable. This parameter is optional and used in the query string.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the URL path.
string
The total number of users in the group associated with the account permission profile.
string
The date and time when the permission profile was last modified.
string
The username of the user who last modified the permission profile.
string
string
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
The name of the account permission profile. Example: Account Administrator
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The PowerForms rights associated with the account permission profile. Valid values are: - none - user - admin
string
When true, users can manage documents by using the API.
string
When true, auto-tagging is enabled for the account.
string
When true, bulk sending is enabled for users.
string
string
Reserved for Docusign.
string
When true, users can access the Other Actions menu.
string
When true, users can add electronic seal (eSeal) recipients.
string
When true, users can send envelopes.
string
string
string
Specifies the level of access that users have to account templates. Valid values are: - none - use - create - share
string
When true, users cannot upload documents.
string
When true, users have full administrative access to the account.
string
When true, users can add requests for attachments from signers.
string
string
Reserved for Docusign.
string
When true, users can access the account by using the eSignature API.
string
When true, users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis.
string
string
When true, API request logging is enabled. Note: Logging limits apply.
string
Specifies the level of access that users have to the account”s address book. Valid values are: - personal - useShared - usePersonalAndShared - personalAndShared
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users may specify sequential signing recipients when they send documents by using the API.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the Docusign Desktop Client is enabled for users.
string
When true, senders can include supplemental documents.
string
string
When true, the tagger palette is visible during the sending and correct flows and users can add tabs to documents.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders can require recipients to read supplemental documents.
string
When true, users can require recipients to view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, users can send envelopes on behalf of others.
string
string
When true, senders can require recipients to accept supplemental documents.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sequential signing user interface is enabled.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders are notified when recipients view the documents that they send.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, users can be recipients of envelopes transferred to them by administrators of other accounts.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders can set the language of the email that is sent to recipients.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Indicates whether the property is editable. Valid values are: - editable - read_only
Reserved for Docusign.
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
An array of option strings supported by this setting.
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
When true, senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, PowerForm Administrators can access all of the PowerForm envelopes associated with the account.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_NOTARY_JURISDICTION_OBJECTRegisters a notary jurisdiction for the current DocuSign user, enabling electronic notarizations for a specific U.S. state. A user can only have ONE jurisdiction at a time. Required fields: commissionExpiration (MM/DD/YYYY format), commissionId, registeredName, sealType, and jurisdiction details (jurisdictionId, name, county). Seal type must match jurisdiction requirements: some states like California require user-uploaded seals, while others support system-created seals. Supports 24 U.S. jurisdictions (IDs: 5-California, 6-Colorado, 9-Florida, 10-Georgia, 12-Idaho, 13-Illinois, 14-Indiana, 15-Iowa, 17-Kentucky, 23-Minnesota, 25-Missouri, 30-New Jersey, 32-New York, 33-North Carolina, 35-Ohio, 37-Oregon, 38-Pennsylvania, 40-South Carolina, 43-Texas, 44-Utah, 47-Washington, 48-West Virginia, 49-Wisconsin, 62-Florida Commissioner of Deeds).

Input Parameters

string
The county where the notary commission is valid (e.g., ‘Denver’, ‘Miami-Dade’). This field is optional but recommended for accurate record-keeping.
string
The type of seal to use for this jurisdiction. Valid values are: system_created - Platform generates the seal automatically (most common), user_uploaded - User provides their own seal image, not_available - No seal available. Note: Some jurisdictions like California require user-uploaded seals, while others like Colorado support system-created seals. Check jurisdiction requirements before choosing.
string
The notary’s commission identification number. This is a unique identifier assigned by the jurisdiction’s notary authority and is required to register a notary jurisdiction. Format varies by jurisdiction (e.g., ‘CO-NOTARY-2026-001’).
string
The official registered name of the notary public as it appears on their commission certificate (e.g., ‘John Smith’, ‘Maria Garcia’). This is required.
string
The name of the jurisdiction (required). This is typically the state name (e.g., ‘California’, ‘Texas’, ‘Florida’).
string
The expiration date of the notary’s commission in MM/DD/YYYY format (e.g., ‘12/31/2030’). This is required to register a notary jurisdiction.
string
The county of the jurisdiction (required). This should match the county where the notary is registered.
string
The ID of the jurisdiction (required). Supported jurisdictions include: 5 - California, 6 - Colorado, 9 - Florida, 10 - Georgia, 12 - Idaho, 13 - Illinois, 14 - Indiana, 15 - Iowa, 17 - Kentucky, 23 - Minnesota, 25 - Missouri, 30 - New Jersey, 32 - New York, 33 - North Carolina, 35 - Ohio, 37 - Oregon, 38 - Pennsylvania, 40 - South Carolina, 43 - Texas, 44 - Utah, 47 - Washington, 48 - West Virginia, 49 - Wisconsin, 62 - Florida Commissioner of Deeds. Note: A user can only have one jurisdiction at a time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_OR_UPDATE_USER_AUTHORIZATIONSCreates or updates user authorizations in DocuSign, allowing an agent user to perform actions on behalf of a principal user. Grants permissions like Send, Manage, Sign, or Edit. Requirements: principal must be authenticated user or caller must be admin; agent users must be active; principal and agent must differ; agentUser.accountId and agentUser.userId are required. Returns HTTP 201 with results array showing success/error for each authorization attempt.

Input Parameters

string
required
The ID of the principal user. This is the user who is granting permissions to the agent user(s). It must be provided in the path and is required for the API call. The caller must either be an account administrator or the principal user identified by this ID.
string
The external account number (integer) or account ID GUID. This uniquely identifies the DocuSign account for which the user authorizations are being created or updated. It must be provided in the path and is required for the API call.
array
The list of user authorizations to create and/or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTMLCreates 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.

Input Parameters

string
Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: source: "<html> ... <body><p>hello world</p></body></html>" If the value of this property is the string document, the HTML signing page is generated from the provided document. source: "document" Related topics - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - Responsive signing [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This is automatically populated from your authenticated DocuSign connection and does not need to be provided manually.
string
required
Specifies the document ID number that the tab is placed on. This must refer to an existing Document”s ID attribute.
string
required
The ID of the template from which the document is being previewed. This is a required path parameter that uniquely identifies the template in the DocuSign system.
string
Header text or an HTML tag to place above the responsive HTML block.
string
The position on the page where the display section appears.
string
The GUID of the document.
array
An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the display property of the displaySettings object.
string
If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level.
string
Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
string
The number of the page on which the display section appears.
string
Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
string
When true (the default), the Mobile-Friendly toggle displays at the top of the screen on the user”s mobile device. When false, the toggle will not be displayed. the Mobile-Friendly toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTML_IN_ENVELOPECreates 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.

Input Parameters

string
Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: source: "<html> ... <body><p>hello world</p></body></html>" If the value of this property is the string document, the HTML signing page is generated from the provided document. source: "document" Related topics - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - Responsive signing [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is automatically populated from the authenticated user’s account information and typically does not need to be provided manually. If specified, it should be a valid string representation of either the numeric account ID or the GUID format account identifier.
string
Specifies the document ID number that the tab is placed on. This must refer to an existing Document”s ID attribute.
string
required
The unique identifier for the envelope containing the documents to be previewed. This parameter is required and must be provided in GUID format. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. The envelopeId is crucial for identifying the specific set of documents within the account for which the responsive HTML preview will be generated.
string
Header text or an HTML tag to place above the responsive HTML block.
string
The position on the page where the display section appears.
string
The GUID of the document.
array
An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the display property of the displaySettings object.
string
If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level.
string
Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
string
The number of the page on which the display section appears.
string
Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
string
When true (the default), the Mobile-Friendly toggle displays at the top of the screen on the user”s mobile device. When false, the toggle will not be displayed. the Mobile-Friendly toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_RECIPIENT_PREVIEW_FOR_ENVELOPECreates 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.

Input Parameters

string
The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.
string
The external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the envelope. It must be a valid string representing either a numeric account number or a GUID format account ID.
string
required
Required. The URL to which the user will be redirected after viewing the preview or in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL (e.g., ‘https://example.com/return’).
string
required
The envelope”s GUID (Globally Unique Identifier). This parameter is required and specifies the exact envelope for which the recipient preview is being created. It must be a valid GUID string, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
A unique identifier of the authentication event executed by the client application.
string
Unique identifier for the recipient. It is used by the tab element to indicate which recipient is to sign the document.
string
Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.
string
Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: deny (the page cannot be displayed in a frame), same_origin (the page can only be displayed in a frame on the same origin as the page itself), allow_from (the page can only be displayed in a frame on the origin specified by the xFrameOptionsAllowFromUrl property).
string
The domain in which the user authenticated.
string
Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: Biometric, Email, HTTPBasicAuth, Kerberos, KnowledgeBasedAuth, None, PaperDocuments, Password, RSASecureID, SingleSignOn_CASiteminder, SingleSignOn_InfoCard, SingleSignOn_MicrosoftActiveDirectory, SingleSignOn_Other, SingleSignOn_Passport, SingleSignOn_SAML, Smartcard, SSLMutualAuth, X509Certificate. This information is included in the Certificate of Completion.
string
URL to redirect when the recipient cancels the signing session.
string
A sender-generated value that indicates the date and time that the signer was authenticated.
string
URL to redirect when the recipient declines to sign.
string
URL to redirect when an exception occurs during signing.
string
URL to redirect when a fax is pending.
string
URL to redirect when the time-to-live expires.
string
When the value of xFrameOptions is allow_from, this property specifies the origin on which the page is allowed to display in a frame. If the value of xFrameOptions is allow_from, you must include a value for this property.
string
URL to redirect when identity check fails.
string
URL to redirect when the signing session times out.
string
URL to redirect when signing is completed.
string
URL to redirect when viewing is completed.
string
URL to redirect when access code verification fails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_RECIPIENT_VIEW_URLCreates a temporary URL for embedding the DocuSign recipient view for a sent envelope, with options for customizing the signing experience. If no recipient user ID is provided, the tool fills it with the authenticated user’s ID, including when email and name are supplied.

Input Parameters

string
Email address of the recipient. Use either email and userName or userId to identify the recipient.
string
User ID of the recipient. Use either the user ID or email and user name to identify the recipient. If used with clientUserId, must match a recipientId.
string
Client URL that DocuSign pings to indicate signing is active, allowing the client to reset its session timer.
string
Username of the recipient. Use either email and userName or userId to identify the recipient.
string
The external account number (int) or account ID GUID. This is a required path parameter that identifies the DocuSign account associated with the envelope.
string
URL to redirect after the signing session ends (max 470 characters). Include ‘https://’ to avoid redirection issues. DocuSign adds an ‘event’ query parameter indicating the outcome (e.g., signing_complete, cancel, decline).
string
required
The ID of the sent envelope for which to create the recipient view. This is a required path parameter that uniquely identifies the envelope in the DocuSign system.
string
A unique identifier of the authentication event executed by the client application.
string
Unique identifier for the recipient. Used by tabs to indicate which recipient should sign the document.
string
A sender-created value for embedded (captive) recipients. Use your application’s client ID (user ID) for the recipient to connect authentication details to the signature. Maximum length: 100 characters.
string
Display format for the embedded view (e.g., ‘focused’ or ‘default’).
string
Interval in seconds between pings on the pingUrl (default: 300). Valid values: 60-1200 seconds.
string
Controls whether the page can be displayed in a frame. Options: ‘deny’ (no frames), ‘same_origin’ (same origin only), ‘allow_from’ (specified origin).
array
Array of origins that can embed the frame (required for focus view). Demo: include your site URL and ‘https://apps-d.docusign.com’. Production: include your site URL and ‘https://apps.docusign.com’.
array
Originating domain for the signature request message (required for focus view). Demo: ‘https://apps-d.docusign.com’. Production: ‘https://apps.docusign.com’.
string
The domain in which the user authenticated.
string
Choose a value that most closely matches the technique your application used to authenticate the recipient/signer. Options: Biometric, Email, HTTPBasicAuth, Kerberos, KnowledgeBasedAuth, None, PaperDocuments, Password, RSASecureID, SingleSignOn_CASiteminder, SingleSignOn_InfoCard, SingleSignOn_MicrosoftActiveDirectory, SingleSignOn_Other, SingleSignOn_Passport, SingleSignOn_SAML, Smartcard, SSLMutualAuth, X509Certificate. This information is included in the Certificate of Completion.
string
URL to redirect when recipient cancels the signing operation.
string
A sender-generated value that indicates the date and time that the signer was authenticated.
string
URL to redirect when recipient declines to sign.
string
URL to redirect when a system error occurs.
string
URL to redirect when recipient has a fax pending.
string
URL to redirect when the Time To Live token expires.
string
When xFrameOptions is ‘allow_from’, specifies the origin allowed to display the page in a frame.
string
URL to redirect when recipient fails an ID check.
string
URL to redirect when the session times out.
string
URL to redirect when recipient completes signing.
string
URL to redirect when recipient completes viewing.
string
URL to redirect when recipient uses incorrect access code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_SENDER_VIEW_URL_FOR_ENVELOPECreates 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, the account ID will be automatically fetched from the connected DocuSign account using the OAuth userinfo endpoint.
string
Identifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).
string
required
The unique identifier for the envelope. This GUID is required and must be provided in the path of the API request. It should be in the format of a standard UUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
Set to envelope to limit the app user”s access to only the specified envelope. If this parameter is not set, the sender will have access to the entire account. Docusign strongly recommends using this property to make your integration more secure.
string
If your app will modify the envelope after the user finishes editing the envelope, create and use a lock token for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
string
Determines whether the Tagger”s back button is shown. Valid values: * true: The back button is shown. This is the default value. * false: Prevents access to the Prepare screen by hiding the back button.
string
Determines the starting screen for the sender view. Valid values: * Prepare (default) * Tagger
string
Sets the behavior of the back button when clicked. Valid values: * previousPage: Navigate to browser”s previous page * redirect: Redirect to the returnUrl specified in the request
string
Sets the behavior of the send button when clicked. Valid values: * send: send the envelope and redirect with query parameter event=Send (default) * redirect: Change the Tagger page”s button text to “Continue”; when clicked, redirect to the returnUrl with query parameter event=Save. Set showBackButton to false and startingScreen to Tagger.
string
When true, the Discard option is shown in the Actions menu. When false, the Discard option is not shown. The default value is true.
string
Determines whether the Actions menu displays advanced actions. Valid values: * true: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value. * false: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set startingScreen to Tagger and showBackButton to false.
string
Reserved for Docusign.
string
When paletteSections is set to custom, this property selects the tagger palette. Valid values: * custom (default) * merge * notary * seals * smartContracts * annotations * smartSections
string
When true, allows the sender to add, remove, or reorder pages in documents. When false, prevents page editing functionality.
string
Reserved for Docusign.
string
Valid values: * default (default): The default tagger palette UX * none: No tagger palette * custom: Set by paletteDefault
string
Reserved for Docusign.
string
When false, prevents the app user from adding, replacing, or deleting documents. The default value is true.
string
When true, displays the sender’s contacts list for easy recipient selection. When false, hides the contacts list from the recipient selection interface.
string
When true, allows the sender to add, remove, or modify recipients in the envelope. When false, prevents recipient editing.
string
Reserved for Docusign.
string
When true, allows the sender to control which recipients can view which documents. When false, prevents editing document visibility settings.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_SIGNING_GROUPCreates 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.

Input Parameters

array
A collection of group objects containing information about the signing groups to be created. Each group should have at minimum a ‘groupName’ field. You can optionally include ‘groupType’ (should be ‘sharedSigningGroup’), ‘groupEmail’, and ‘users’ list with member details.
string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required to specify which account the signing groups will be created under. The value must be a valid existing DocuSign account identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSCreates custom fields on a DocuSign template to capture additional metadata. Custom fields allow you to: - Add dropdown lists (listCustomFields) where senders select from predefined options - Add text fields (textCustomFields) where senders enter free-form text - Set default values and mark fields as required or optional - Control visibility in the envelope creation interface - Integrate with external systems like Salesforce using merge fields These fields are attached to the template and will appear when creating envelopes from that template, allowing senders to provide additional context or metadata before sending documents for signature. Note: You must provide at least one of listCustomFields or textCustomFields.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your DocuSign account information. You typically don’t need to provide this parameter.
string
required
The unique identifier of the template within the specified DocuSign account. This parameter is required and must be provided in the path of the API request. It determines which template will be updated with the new custom fields. The templateId is typically a string of alphanumeric characters.
array
An array of dropdown/list custom fields to add to the template. Each field allows users to select from predefined options.
array
An array of free-text custom fields to add to the template. Each field allows users to enter custom text values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_TEMPLATE_RECIPIENT_PREVIEW_URLGenerate a preview URL showing how a template will appear to recipients. This action creates an embeddable URL that displays a template from the recipient’s perspective, allowing senders to verify the signing experience before sending the actual document. This is particularly useful for: - Previewing tab placement and field positions - Validating the recipient workflow and experience - Testing template configuration before production use - Providing a “preview” feature in template management interfaces The returned URL can be embedded in an iframe or opened in a new window. The preview is read-only and does not affect the actual template. Note: This is for templates only, not for envelopes or sent documents. Use create_recipient_preview_for_envelope for envelope previews.

Input Parameters

string
The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.
string
The external account number (integer) or account ID GUID. This identifies the DocuSign account containing the template. This value is automatically populated from your connected account credentials.
string
The URL to redirect to when the user exits the preview or in error scenarios (e.g., link expiration). Must be an absolute URL starting with http:// or https://. Example: ‘https://yourapp.com/preview-complete’
string
required
The unique identifier (GUID) of the template to preview. You can obtain template IDs using the list_all_templates action. Example format: “123e4567-e89b-12d3-a456-426614174000”
string
A unique identifier of the authentication event executed by the client application.
string
The unique identifier of the recipient whose view you want to preview. This allows you to see the template from a specific recipient’s perspective. If not specified, a generic recipient view will be shown.
string
Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.
string
Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - deny: The page cannot be displayed in a frame. - same_origin: The page can only be displayed in a frame on the same origin as the page itself. - allow_from: The page can only be displayed in a frame on the origin specified by the xFrameOptionsAllowFromUrl property.
string
The domain in which the user authenticated.
string
Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: * Biometric * Email * HTTPBasicAuth * Kerberos * KnowledgeBasedAuth * None * PaperDocuments * Password * RSASecureID * SingleSignOn_CASiteminder * SingleSignOn_InfoCard * SingleSignOn_MicrosoftActiveDirectory * SingleSignOn_Other * SingleSignOn_Passport * SingleSignOn_SAML * Smartcard * SSLMutualAuth * X509Certificate This information is included in the Certificate of Completion.
string
The URL to redirect to when the user cancels the preview session.
string
A sender-generated value that indicates the date and time that the signer was authenticated.
string
The URL to redirect to when the user declines to sign.
string
The URL to redirect to when an exception occurs during the preview session.
string
The URL to redirect to when a fax is pending.
string
The URL to redirect to when the preview URL’s time-to-live (TTL) expires.
string
When the value of xFrameOptions is allow_from, this property specifies the origin on which the page is allowed to display in a frame. If the value of xFrameOptions is allow_from, you must include a value for this property.
string
The URL to redirect to when identity verification fails.
string
The URL to redirect to when the preview session times out.
string
The URL to redirect to when signing is completed.
string
The URL to redirect to when the user finishes viewing the preview.
string
The URL to redirect to when the access code validation fails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_TEMPLATE_RESPONSIVE_HTML_PREVIEWCreates 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.

Input Parameters

string
Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: source: "<html> ... <body><p>hello world</p></body></html>" If the value of this property is the string document, the HTML signing page is generated from the provided document. source: "document" Related topics - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - Responsive signing [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
string
The external account number (integer) or account ID GUID of the DocuSign account. This parameter is automatically populated by the DocuSign base action and does not need to be provided explicitly.
string
Specifies the document ID number that the tab is placed on. This must refer to an existing Document”s ID attribute.
string
required
The unique identifier of the template for which the responsive HTML preview is being created. This parameter is required and must be a valid string representing the template ID within the specified DocuSign account.
string
Header text or an HTML tag to place above the responsive HTML block.
string
The position on the page where the display section appears.
string
The GUID of the document.
array
An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the display property of the displaySettings object.
string
If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level.
string
Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
string
The number of the page on which the display section appears.
string
Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
string
When true (the default), the Mobile-Friendly toggle displays at the top of the screen on the user”s mobile device. When false, the toggle will not be displayed. the Mobile-Friendly toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_TEMPLATE_WORKFLOW_STEPAdds a new workflow step to an existing DocuSign template. This action enables sophisticated document routing automation within templates, including: - Pausing workflows before specific routing steps - Implementing delayed sending with scheduled resume dates - Setting up conditional recipient routing based on form field values - Creating multi-stage approval or review processes The workflow step controls the timing and conditions for sending documents to recipients. Common use cases include approval chains, compliance reviews, and conditional routing based on document data. Note: Only one workflow step type (delayed routing OR recipient routing) can be configured per step. Workflow steps are triggered based on routing order positions within the template.

Input Parameters

string
The workflow action type. Currently only supports ‘pause_before’ which pauses the workflow before reaching the trigger point defined in triggerOnItem. Use this to implement delayed sending or conditional routing logic.
string
The routing order number (as a string) where the workflow should pause. For example, ‘1’ pauses before the first recipient, ‘2’ before the second. Used in conjunction with triggerOnItem=‘routing_order’.
string
The status of the step. Valid values: - inactive - in_progress - paused - pending - completed This property is read-only.
string
The DocuSign account ID (GUID format like ‘12345678-1234-1234-1234-123456789012’). If not provided, the account ID will be automatically determined from the authenticated user’s account. Required for API calls.
string
required
The template ID (GUID format) where the workflow step will be added. Get this from the List Templates action or from the DocuSign web UI. Example: ‘a1b2c3d4-e5f6-7890-abcd-ef1234567890’
string
The timestamp of when the workflow step transitioned to completed status. This property is read-only.
string
Specifies what triggers this workflow step. Use ‘routing_order’ to trigger based on a specific recipient routing order position (set in itemId). The workflow will pause before documents are sent to the recipient at that position.
string
The timestamp of when the workflow step transitioned to in_progress status. This property is read-only.
string
A unique identifier for this workflow step. This property is read-only.
array
Defines when the paused workflow should resume. Provide exactly one rule with either ‘delay’ (duration like ‘2.00:00:00’ for 2 days) or ‘resumeDate’ (ISO 8601 timestamp). Maximum delay is 30 days from workflow step creation.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
array
Conditional routing rules that determine which recipients receive the document based on form field values. Each rule includes conditions (field checks) and a recipient group that gets activated when conditions are met.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_URLFOR_TEMPLATE_EDIT_VIEWCreates 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account the template belongs to. The accountId must be valid and associated with your API integration.
string
Identifies the return point after the user selects Save And Close. This property is required.
string
required
The unique identifier for the specific template to be edited. This ID is required and must correspond to an existing template within the specified account. The templateId is typically a GUID (Globally Unique Identifier) assigned by DocuSign when the template was created.
string
Set to template to limit the app user”s access to only the specified template. Docusign strongly recommends using this property to make your integration more secure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_CREATE_USER_AUTHORIZATION_FOR_AGENT_USERCreates 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.

Input Parameters

string
required
Required. The ID of the principal user who is granting authorization. The principal user is the one sharing their permissions with the agent user. The principal user must have ‘Active’ status and must be different from the agent user.
string
The UTC DateTime to end the authorization. The default value is the max UTC value (9999-12-31T23:59:59.0000000+00:00).
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request.
string
The UTC DateTime to initiate the authorization. The default value is the current date and time.
string
required
Required. The permission level to grant to the agent user. Determines what actions the agent can perform on behalf of the principal user. Valid values: Send (can send envelopes), Manage (can manage envelopes), Sign (can sign documents - each principal can only share signing permission with one agent at a time), Edit (can edit envelopes).
string
The full name of the agent user who will be granted authorization.
string
Optional. The email address of the agent user. Providing this along with userId helps ensure the correct user is identified.
string
required
Required. The unique user ID of the agent user who will be granted authorization to act on behalf of the principal user. The agent user must have ‘Active’ status and must be a different user than the principal. Both users must be in the same account.
string
required
Required. The account ID of the agent user who will be granted authorization to act on behalf of the principal user. Must be the same account as the principal user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ACCOUNT_BRANDDeletes a specific brand from the authenticated user’s first DocuSign account, where branding must be enabled for signing or sending. HTTP errors can be returned as a response with success set to false and an error message.

Input Parameters

string
required
The unique identifier for the brand to be deleted. This is a required string parameter that specifies which brand within the account should be removed. The brandId is typically a GUID or a unique string assigned by DocuSign when the brand was created. Example: “b1234567-89ab-cdef-0123-456789abcdef”.
string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). If not provided, it will be automatically populated from the authentication credentials. Specify this parameter only if you need to delete a brand from a different account than the authenticated one. Example: “12345” or “a1b2c3d4-5678-90ef-ghij-klmnopqrstuv”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ACCOUNT_CUSTOM_FIELDDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. This is automatically populated by the DocuSign base action from the authenticated user’s account information. You typically don’t need to provide this parameter as it will be set automatically.
string
required
The unique identifier of the custom field to be deleted. This is required to specify which exact custom field should be removed from the account. The value must be a valid string representing the ID of an existing custom field in the specified account.
string
An optional parameter that determines whether the deletion of the custom field should also be applied to templates. When set to “true”, the custom field will be removed from all templates in the account that use it. If not specified or set to “false”, the deletion only affects the account-level custom field. The value must be a string, either “true” or “false”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ACCOUNT_PERMISSION_PROFILEThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is automatically populated from your authenticated account and specifies which account’s permission profile should be deleted.
string
Optional query parameter specifying the permission profile ID to which users currently associated with the profile being deleted should be reassigned. This parameter is required if the permission profile has any users associated with it. Without this parameter, deletion of a profile with associated users will fail. Use the AccountPermissionProfiles: list endpoint to get valid permission profile IDs for reassignment.
string
required
The unique identifier for the permission profile to be deleted. This is a required string parameter. You can obtain this ID by using the AccountPermissionProfiles: list endpoint or by downloading a CSV file of all permission profiles from the Settings > Permission Profiles page in your eSignature account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ACCOUNT_STAMPDeletes a specific account stamp (signature) by ID from the authenticated user’s first resolved DocuSign account. The operation is irreversible, so use it with caution.

Input Parameters

string
The unique identifier for the DocuSign account. You can use the literal string ‘me’ to automatically use the account associated with the authenticated user, or provide a specific external account number (integer) or account ID GUID (string). When not provided or set to None, the action will attempt to automatically determine the account ID from the authenticated user’s information. The value must be a valid account identifier within your DocuSign organization.
string
required
The unique identifier for the account stamp (signature) to be deleted. This is a required string parameter that specifies which stamp should be removed from the account. The signatureId is typically obtained when creating a stamp or listing existing stamps in the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_BCC_EMAIL_ARCHIVE_CONFIGURATIONThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). It is required to specify which account”s BCC email archive configuration is being deleted. For example: “12345” or “a1b2c3d4-5678-90ef-ghij-klmnopqrstuv”.
string
required
The unique identifier for the specific BCC email archive configuration to be deleted. This is a required string parameter that precisely targets the configuration you want to remove. The format is typically a GUID, for example: “bcc123e4-5678-90ab-cdef-ghijklmnopqr”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_BRAND_FROM_GROUPThis 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.

Input Parameters

array
A list of brand objects to remove from the group. Each brand object must contain a brandId property specifying which brand to delete from the group. This parameter is effectively required for the operation to succeed, as the API returns an error if no brands are specified.
string
required
The ID of the group from which the brands will be deleted. This parameter specifies the target group within the account. It must be a valid group identifier string. This parameter is required and must be provided in the path of the API request.
string
The external account number (int) or account ID GUID. This parameter identifies the specific DocuSign account from which brands will be deleted from the group. If not provided, it will be automatically retrieved from the authenticated user’s default account. It must be a valid account identifier, either in the form of an integer or a GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_BRAND_LOGO_BY_TYPEThis 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.

Input Parameters

string
required
The unique identifier for the brand within the specified account. This is required to target the specific brand from which the logo will be deleted. It should be a string value, typically a GUID. For example: “b1c2d3e4-f5g6-7890-b1c2-d3e4f5g67890”.
string ("primary" | "secondary" | "email")
required
Specifies which type of logo to delete from the brand. This parameter is required and must be one of three valid values: “primary”, “secondary”, or “email”. Each type serves a different purpose in document branding: “primary” is the main logo used for the brand, “secondary” is an alternative logo used in specific contexts, and “email” is the logo used in email communications. Choose the appropriate type based on which logo you want to remove from the brand.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account”s brand logo should be deleted. For example: “7215555” or “a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_BRAND_PROFILESDeletes one or more brand profiles from a DocuSign account; deletion is irreversible and requires canSelfBrandSign or canSelfBrandSend to be enabled. The response may include brand IDs, names, and per-brand error details.

Input Parameters

array
required
A list of brand objects to delete from the account. Each object must contain a valid brandId. This operation is irreversible, so ensure you specify the correct brand IDs. You can retrieve available brand IDs using the list brands endpoint.
string
The external account number (int) or account ID GUID. This parameter is automatically populated by the DocuSign base action from your authenticated session. It uniquely identifies the DocuSign account from which brand profiles will be deleted. You typically do not need to provide this value manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CHUNKED_UPLOADDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). When not provided, it will be automatically extracted from the authentication context. This parameter is used to specify which account the chunked upload belongs to.
string
required
The unique identifier for the specific chunked upload to be deleted. This parameter is required and must be provided in the path of the API request. It is a string value that DocuSign assigns when the chunked upload is initially created. Use this ID to reference the exact chunked upload you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CONNECT_CONFIGURATIONDeletes 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.

Input Parameters

string
required
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). Required parameter. Format depends on the type of identifier used by your integration.
string
required
The unique identifier for the specific Connect configuration to be deleted. This is a required string parameter. The format is typically a GUID or a system-generated string. Ensure you have the correct connectId to avoid unintended deletions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CONNECT_FAILURE_LOG_ENTRYDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). This parameter is required and is used to specify which account”s Connect failure logs should be accessed.
string
required
The unique identifier of the specific Connect post failure log entry to be deleted. This parameter is required. It can be set to a specific failure ID to delete a single log entry, or to the string “all” to delete all failure log entries for the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CONNECT_LOG_ENTRIESDeletes Connect log entries for a DocuSign account. This endpoint allows account administrators to manage and clean up Connect event logs, which record webhook delivery attempts and outcomes. Use Case: Remove Connect log entries for data management, privacy compliance, or housekeeping purposes. Requirements: - Account administrator privileges - Connect must be enabled on the account - Provide a list of log IDs to delete specific entries Important: This operation is irreversible. Deleted log entries cannot be recovered. Ensure you have identified the correct log IDs before deletion. Use the list/get Connect logs endpoints first to identify the logs you want to delete. Note: The endpoint behavior may vary based on the logIds parameter: - With logIds: Deletes specific log entries - Without logIds: Behavior depends on API implementation (may delete all or return error)

Input Parameters

array
An array of Connect log entry IDs to be deleted. Each ID should be a valid string identifier for a Connect log entry. If not provided or empty, the endpoint may delete all Connect logs for the account (use with caution). To delete specific log entries, provide an array of log IDs like: [“log1”, “log2”].
string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). This parameter is automatically populated from your authenticated account if not provided. It is used to specify which account”s Connect log entries should be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CONNECT_OAUTH_CONFIGURATIONDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). It is required to specify which account”s Connect OAuth configuration should be deleted. For example: “12345” or “a1b2c3d4-5678-90ef-ghij-klmnopqrstuv”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CONTACT_FROM_ACCOUNTDeletes a specific contact from the authenticated DocuSign account’s address book using its contact ID. The response can include a list of contacts; deletion should be used with caution.

Input Parameters

string
The DocuSign account ID. If not provided, it will be automatically retrieved from your authentication credentials. You can specify it explicitly if you need to target a specific account.
string
required
The unique identifier for the contact to be deleted from the account’s address book. This is a required parameter and must be provided to specify which contact should be removed. It should be a string value that corresponds to the ID of an existing contact in the account. Example: “c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDSDeletes 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.

Input Parameters

string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a string value, either a numeric account number or a GUID format for the account ID.
string
required
The unique identifier for the document within the envelope. This parameter is required and must be provided in the path. It should be a string value representing a number between 1 and 2147483647. Typically, documents are numbered sequentially (1, 2, 3, etc.), but any numbering scheme within this range is acceptable. This ID is crucial for identifying which document”s custom fields are to be deleted.
string
required
The unique identifier for the envelope containing the document. This parameter is required and must be provided in the path. It should be a string value in GUID format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ID is essential for locating the specific envelope from which document fields will be deleted.
array
Array of custom document fields to delete from the document. Each field should specify the ‘name’ of the field to be removed. When this parameter is not provided or is empty, all custom document fields will be deleted from the specified document. To delete specific fields, provide an array with the field names. Example: [{“name”: “CustomField1”}, {“name”: “CustomField2”}]. The name can be up to 50 characters long.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDS_FROM_TEMPLATEDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID. It is required to specify which account”s template should be modified. The accountId is typically obtained through authentication or from your DocuSign account settings.
string
required
The unique identifier for the document within the template. Unlike other IDs in the eSignature API, you specify this ID yourself. It should be a positive integer between 1 and 2147483647. Typically, the first document in a template has ID “1”, the second “2”, and so on, but you can use any numbering scheme within the valid range. This ID is crucial for identifying which document”s custom fields should be deleted.
string
required
The unique identifier for the template containing the document whose custom fields you want to delete. This ID is assigned by DocuSign when the template is created and is required to locate the specific template to be modified.
array
The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: * name: A string that can be a maximum of 50 characters. * value: A string that can be a maximum of 200 characters. If you are using XML, the name/value pair is contained in a nameValue element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CUSTOM_FIELDS_IN_TEMPLATEDeletes specified custom fields from a DocuSign template. This action removes envelope-level custom fields (both list and text types) that are no longer needed. How it works: - Specify which custom fields to delete by providing their fieldId values - You can delete multiple list and/or text custom fields in a single request - The template must not be locked by another user or application - Get field IDs using the retrieve template custom fields endpoint Response: Returns the list of deleted custom field IDs (not the remaining fields). Use case: Useful for maintaining templates by removing outdated custom fields, simplifying template structure, and keeping only relevant metadata fields for new envelopes created from this template. Note: This deletes template-level custom fields. For document-level custom fields within a template, use the delete custom document fields endpoint instead.

Input Parameters

string
The DocuSign account ID (GUID format). This parameter is automatically populated from your authenticated DocuSign account and uniquely identifies the account containing the template. You typically don’t need to provide this value as it’s extracted from your authentication credentials.
string
required
The unique identifier of the template from which custom fields will be deleted. This parameter is required and must be a valid string representing the template ID within the specified DocuSign account. The template ID is typically a long alphanumeric string.
array
An array of list custom fields to delete from the template. Each field object should specify the ‘fieldId’ property to identify which list custom field to remove. You can delete multiple list custom fields in a single request. Use the retrieve template custom fields endpoint to get the field IDs of existing custom fields.
array
An array of text custom fields to delete from the template. Each field object should specify the ‘fieldId’ property to identify which text custom field to remove. You can delete multiple text custom fields in a single request. Use the retrieve template custom fields endpoint to get the field IDs of existing custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CUSTOM_TAB_INFORMATIONDeletes 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account from which the custom tab will be deleted. This parameter is required and must be provided in the path of the API request. It can be either a numeric value or a GUID string, depending on how the account is identified in your system.
string
required
The DocuSign-generated unique identifier for the custom tab to be deleted. This parameter is required and must be provided in the path of the API request. It is a string value that specifically identifies the custom tab within the account. This ID is crucial for ensuring that the correct custom tab is targeted for deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_CUSTOM_USER_SETTINGSDeletes custom user settings for a DocuSign user by their names; users can only modify their own settings. If the settings array is omitted, all ungrouped custom settings are deleted.

Input Parameters

string
required
The unique identifier (GUID) of the user whose custom settings are to be deleted (e.g., ‘12345678-1234-1234-1234-123456789012’). This parameter is required. Note: Users can only access and modify their own custom settings. Even users with Admin rights cannot access another user’s custom settings.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path to specify the account context for the operation.
array
An array of custom setting objects to delete. Each object should specify the ‘name’ of the custom setting to delete. The ‘value’ and ‘originalValue’ fields are optional for delete operations. To delete specific settings, provide an array with the setting names. If omitted, all ungrouped custom settings for the user will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_DELAYED_ROUTING_RULE_FOR_ENVELOPE_STEPThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account the operation should be performed on. The value must be a non-empty string.
string
required
The unique identifier for the specific envelope within DocuSign. This is a GUID (Globally Unique Identifier) that precisely identifies the envelope for which the delayed routing rule should be deleted. The value must be a non-empty string in the format of a GUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
The unique identifier for the specific workflow step within the envelope. This ID is required to pinpoint the exact step from which the delayed routing rule should be removed. The value must be a non-empty string representing the step ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_DELAYED_ROUTING_RULES_FOR_TEMPLATEDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). It is required to specify which account the template belongs to. For example: “7215091” or “c35a6214-f03c-4de7-9b4c-b608d9f37439”.
string
required
The unique identifier for the template within the specified DocuSign account. This is a required string parameter that specifies which template”s workflow will be modified. The templateId is typically a long alphanumeric string, for example: “1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
required
The unique identifier for the specific workflow step within the template where the delayed routing rules will be deleted. This required string parameter pinpoints the exact step in the template”s workflow that will be affected. The format is typically a GUID, for example: “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_DRAFT_ENVELOPE_ATTACHMENTSDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required to specify which account the operation should be performed on. Example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier for the draft envelope from which attachments will be deleted. This must be a valid GUID for an existing draft envelope within the specified account. The envelope must be in a draft state for this operation to succeed. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
array
A list of attachment objects to delete from the draft envelope. Each object should include at minimum the attachmentId field to identify which attachment to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENOTE_CONFIGURATIONDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account from which the eNote configuration should be deleted. This can be either the external account number or the account ID GUID. If not provided, it will be automatically populated from the authenticated user’s account. When explicitly specified, the format should be either a string representation of an integer (e.g., ‘12345’) for external account numbers or a standard GUID format (e.g., “12345678-1234-1234-1234-123456789012”) for account IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_CUSTOM_FIELDSThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the integer external account number or the account ID GUID. It is required to specify which account the envelope belongs to.
string
required
The unique identifier for the envelope from which custom fields will be deleted. This must be a valid GUID (Globally Unique Identifier) in the format “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It is required to specify which envelope”s custom fields should be modified.
array
An array of list custom fields to delete. Each field should specify either the ‘name’ or ‘fieldId’ to identify which custom field to remove from the envelope.
array
An array of text custom fields to delete. Each field should specify either the ‘name’ or ‘fieldId’ to identify which custom field to remove from the envelope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_EMAIL_SETTINGSDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account number (integer) or the account ID GUID (string). It is required to specify which account the envelope belongs to. Example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
required
The unique identifier for the envelope whose email settings are to be deleted. This is a required GUID string that specifically identifies the envelope within the account. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_LOCKDeletes the lock on a specified DocuSign envelope using the required lock token. Only the user who originally locked the envelope can delete the lock; it is also released when its duration expires.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It ensures that the envelope lock is deleted from the correct account.
string
required
Required. The lock token that proves ownership of the envelope lock. This token is returned when you create a lock using the ‘Lock an envelope for editing’ action or by retrieving lock information with the ‘Get envelope lock information’ action. The token will be automatically added to the X-DocuSign-Edit header in JSON format: {“lockToken”:“<token>”}. Only the user/application that created the lock can delete it using this token. Example: “NTI1OWI3ZWMtOWY4YS00ZTM5LWE3MjUtZGJjZTRkYmUzNjlj”
string
required
The unique identifier for the envelope from which the lock should be deleted. This parameter is required and must be provided in the path. It should be a valid GUID format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. Ensure that the envelope ID corresponds to an existing envelope within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_SCHEDULED_SENDING_RULESDeletes 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided as a string. It can be either a numeric value representing the external account number or a GUID (Globally Unique Identifier) for the account ID. Example: “123456” or “a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6”.
string
required
The unique identifier for the envelope whose scheduled sending rules are to be deleted. This parameter is required and must be provided as a string in the format of a GUID (Globally Unique Identifier). The GUID is a 32-character hexadecimal string, typically displayed with hyphens separating groups of characters. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_TRANSFER_RULEDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. It can be either an external account number (integer) or an account ID GUID (string). If not provided, the system will automatically retrieve the account ID from the authenticated user’s context. When specified, it must be a valid account identifier associated with the API user’s organization.
string
required
The unique identifier for the specific envelope transfer rule to be deleted. This ID is generated by the DocuSign system when the rule is first created. It is required to pinpoint the exact rule for deletion. The value must be a valid string representing an existing envelope transfer rule ID within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_WORKFLOW_DEFINITIONThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). It is required to specify which account the operation should be performed on.
string
required
The unique identifier for the envelope whose workflow definition should be deleted. This is a GUID (Globally Unique Identifier) string. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It is required to specify which envelope”s workflow definition should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ENVELOPE_WORKFLOW_STEPDeletes 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.

Input Parameters

string
A unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). It is required to specify which account the operation should be performed on. Format: String (no specific length restrictions mentioned).
string
required
The globally unique identifier (GUID) for the specific envelope from which the workflow step will be deleted. This is a required parameter to identify the exact envelope being modified. Format: String, typically in the form of a UUID (e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”).
string
required
The unique identifier for the specific workflow step that needs to be deleted from the envelope. This parameter is required to pinpoint the exact step in the envelope”s workflow that should be removed. Format: String (no specific format restrictions mentioned).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_EXISTING_WORKSPACE_LOGICALLYLogically deletes a specified DocuSign workspace, preserving its data while removing it from active use. Workspace details and status are returned when present in the API response; an empty response yields a success indicator without those details.

Input Parameters

string
The external account number (integer) or account ID GUID that identifies the DocuSign account associated with the workspace. This parameter is automatically populated by the system from the authenticated user’s account information. It should be a valid string representing either a numeric account number or a GUID (Globally Unique Identifier) format. For example: “12345” or “1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
required
The unique identifier of the workspace to be deleted. This parameter is required and must be provided in the path. It should be a valid string representing the specific workspace ID within the specified account. The format is typically a GUID, for example: “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_MEMBERS_FROM_SIGNING_GROUPRemoves 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.

Input Parameters

array
List of users to be deleted from the signing group. Each user should be identified by their email address and optionally their userName. You can delete multiple users in a single request by providing multiple user objects in this list.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a valid string representation of either an integer or a GUID, depending on your account setup. For example: “123456” or “1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
required
The unique identifier of the signing group from which members will be deleted. This parameter is required and must be provided in the path. It should be a valid string representation of the signing group ID. For example: “group123”. Note that when sending an envelope to a signing group, anyone in the group can open and sign it with their own signature. Therefore, it”s recommended not to include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_MULTIPLE_CONTACTS_FROM_ACCOUNTDeletes multiple contacts from the authenticated DocuSign account’s address book using a list of contact objects containing contact IDs. The response can include affected contacts and per-contact errors; verify contacts before this irreversible operation.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account from which contacts will be deleted. This parameter is required and must be provided in the path of the API request.
array
A list of contacts to delete. Each contact should include at least the contactId field to identify which contact(s) to remove from the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_NOTARY_JURISDICTIONDeletes 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.

Input Parameters

string
required
The unique identifier for the notary jurisdiction to be deleted. This is a required path parameter that must be one of the supported jurisdiction IDs. Each ID corresponds to a specific U.S. state or jurisdiction where notary services are available through DocuSign. The value must be a string representing the numeric ID. For example, “5” for California or “62” for Florida Commissioner of Deeds. The full list of supported jurisdictions includes 24 options, ranging from California (5) to Florida Commissioner of Deeds (62). It”s crucial to use the correct ID as invalid IDs will result in an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_ONE_OR_MORE_SIGNING_GROUPSDeletes one or more signing groups from the connected DocuSign account. This removes the groups rather than their individual users; exercise caution because deletion is destructive.

Input Parameters

array
A list of signing group objects to delete. Each group object must contain at minimum a ‘signingGroupId’ field to identify which group(s) to remove. You can delete multiple groups in a single request by providing multiple group objects in this array.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account the signing groups belong to. The value must be a non-empty string representing a valid DocuSign account identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_PAGE_FROM_DOCUMENT_IN_ENVELOPEDeletes a specific page from a document within a DocuSign envelope. This endpoint removes a single page from a document based on its page number. The page is permanently deleted and this operation cannot be undone. Important Requirements: - The envelope must be in draft status (not yet sent) - The document must have multiple pages (cannot delete the only page) - Page numbers start at 1 for the first page - The specified page number must exist in the document Use Cases: - Removing incorrect or unnecessary pages from documents before sending - Cleaning up documents that were added to an envelope in error - Modifying multi-page documents during envelope preparation Note: This operation is destructive and permanent. Always verify the correct page number before deletion. Once sent, envelopes typically cannot have pages deleted due to audit trail requirements.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your connected DocuSign account credentials and typically does not need to be manually specified. If provided, it should be a string representation of either the numeric account number or the full GUID of the account.
string
required
The unique identifier for the document within the envelope. This parameter is required and identifies which document will have a page deleted. Document IDs are typically assigned sequentially starting from ‘1’ when documents are added to an envelope (e.g., ‘1’, ‘2’, ‘3’). You can retrieve document IDs by listing the documents in an envelope. The document ID must correspond to an existing document in the specified envelope.
string
required
The globally unique identifier (GUID) for the envelope. This parameter is required and must be provided to specify which envelope contains the document to be modified. The envelopeId should be a string in the format of a UUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This GUID ensures that the correct envelope is targeted for the page deletion operation.
string
required
The specific page number to be deleted from the document. This parameter is required and should be provided as a string representation of the page number (e.g., ‘1’, ‘2’, ‘3’). Page numbers start at 1 for the first page. The page number must correspond to an existing page in the document. Note: This operation permanently deletes the page from the document and cannot be undone. Ensure the correct page number is specified before deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_PAGE_FROM_TEMPLATE_DOCUMENTDeletes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account the template belongs to. Format: string.
string
required
The unique ID of the document within the template. This is a user-specified ID, typically following a sequential numbering scheme (e.g., 1, 2, 3). Valid values range from 1 to 2147483647 (32-bit signed integer). Required to identify which document in the template to modify. Format: string.
string
required
The number of the page to be deleted from the document. This is a required parameter that specifies which exact page should be removed. Page numbers typically start at 1 for the first page. Format: string representing an integer.
string
required
The unique identifier for the template containing the document to be modified. This is a required parameter to specify which template the document belongs to. Format: string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_POWER_FORM_BY_IDThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your authenticated session if not provided. You can also explicitly provide it as a string representing either a numeric account number or a GUID (e.g., “1234567” or “12345678-1234-1234-1234-123456789012”).
string
required
The unique identifier of the PowerForm to be deleted. This parameter is required and must be a valid string representing the specific PowerForm ID within the account. The format is typically a GUID (e.g., “12345678-1234-1234-1234-123456789012”). Ensure you have the correct PowerForm ID, as this operation is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_REQUEST_LOG_FILESDeletes all request log files for the authenticated user in DocuSign. This endpoint clears the diagnostic log buffer by removing all current request/response log entries. API request logging in DocuSign captures up to 50 request/response pairs for troubleshooting purposes. Use this action to clear the log buffer after downloading logs or when the buffer is full (logging is automatically disabled when the 50-entry limit is reached). Important notes: - Only logs for the authenticated user are deleted (not account-wide logs) - Deleted logs cannot be recovered - download logs first if needed - The operation requires no parameters and returns an empty response on success - Private information (passwords, integration keys) is never logged, even before deletion - Use with the DOCUSIGN_TOGGLE_API_REQUEST_LOGGING action to manage logging settings Returns an HTTP 204 No Content response on successful deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_SCHEDULED_SENDING_RULESDeletes 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, the account ID will be automatically retrieved from the authenticated user’s credentials.
string
required
The unique identifier of the template whose scheduled sending rules are to be deleted. This parameter is required and must be a valid template ID within the specified account. The template ID is typically a long string of characters that DocuSign assigns when the template is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_SIGNATURE_FOR_CAPTIVE_RECIPIENTSDeletes the signature for one or more captive (embedded) recipients in DocuSign. This endpoint is primarily used for testing and development purposes to reset signatures associated with embedded recipients (identified by clientUserId). After deletion, a new signature can be created the next time the clientUserId is used in an embedded signing session. Use Cases: - Testing embedded signing workflows repeatedly with the same test user - Resetting test data in development environments - Clearing signature state before re-testing signing ceremonies Important Notes: - This operation permanently removes signature data - Not intended for regular production use - use with caution - The recipients must have been created as embedded/captive recipients (with clientUserId set) - The recipientPart parameter must be set to “signature” (lowercase) Required Information: - Account ID (automatically populated) - Client User ID of the captive recipient - Email address of the recipient - Full name of the recipient

Input Parameters

string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and must be provided in the path of the API request. It uniquely identifies the account for which the captive recipient signatures will be deleted.
string
Specifies the part of the recipient information to be deleted. This parameter is required and must be provided in the path of the API request. Currently, the only supported value is “signature” (lowercase). This indicates that the operation will delete the signature associated with the specified captive recipients.
array
List of one or more captive (embedded) recipients whose signatures should be deleted. Each recipient must include at minimum the clientUserId, email, and userName that were used when the recipient was originally created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_SPECIFIC_CONNECT_LOG_ENTRYDeletes 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.

Input Parameters

string
required
The unique identifier for the specific Connect log entry to be deleted. It must be a valid string representing the log entry ID. Use the special value “all” to delete all Connect log entries for the specified account. For example: “1a2b3c4d-5e6f-7g8h-9i0j” or “all”.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). It is required to specify which account’s Connect logs are being accessed. For example: “7215062” or “f0f9781f-b448-4dcf-a92c-089c119963f4”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_SPECIFIED_ACCOUNTDeletes or closes the DocuSign account selected from the connected authentication context, with an optional user-data redaction parameter. Account closure has significant consequences for access to documents and user data.

Input Parameters

string
The unique identifier for the DocuSign account to be deleted. This can be either the external account number (integer) or the account ID GUID (string). This parameter is required and must be provided in the path of the API request. Ensure you have the correct account ID to avoid unintended account deletions.
string
An optional query parameter that, when set, instructs DocuSign to redact (remove or obscure) user data during the account deletion process. The specific behavior may vary based on DocuSign”s data retention policies. When using this parameter, consult DocuSign”s documentation for the exact implications and any valid values (e.g., “true” or “1” to enable redaction). If not specified, the default behavior is to not redact user data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_STAMP_IMAGE_FOR_ACCOUNTThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). When not provided, the account ID will be automatically determined from the authenticated user’s token. Specifying this parameter allows you to target a specific account if you have access to multiple accounts.
string
required
Specifies the type of image to be deleted from the stamp/signature. Must be one of: “stamp_image” (for stamp/seal images), “signature_image” (for handwritten signatures), or “initials_image” (for initial images). This parameter is required to target the specific image type within the stamp or signature definition. Note: To delete multiple image types, you must make separate API calls for each type.
string
required
The unique identifier for the account stamp or signature from which the image will be deleted. This ID is required to target the specific stamp/signature within the account. You can obtain signature IDs by using the retrieve_available_account_stamps action. DocuSign recommends using the signature ID rather than the signature name, as names may contain special characters that require URL encoding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_TEMPLATE_FROM_ENVELOPE_DOCUMENTDeletes a template from a document within an envelope. Removes a previously applied template from a specific document. This is useful when: - Replacing one template with another - Reverting a document to its original state - Correcting template application errors ⚠️ This operation is permanent and cannot be undone. Requirements: - The envelope must be in a modifiable state (draft, created, or sent) - The template must have been previously applied to the document - You need the envelope ID, document ID, and template ID

Input Parameters

string
The DocuSign account ID (GUID or external account number). Auto-populated from authentication if not provided.
string
required
The document ID within the envelope (e.g., ‘1’, ‘2’, ‘3’). Documents are numbered starting from ‘1’ by default. This identifies which document contains the template to delete.
string
required
The envelope ID (GUID format, e.g., ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’). Identifies the envelope containing the document.
string
required
The template ID (GUID) to remove from the document. This must be a template that was previously applied to this document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_TEMPLATE_LOCKDeletes the lock from a specified DocuSign template, releasing it for editing by others. Important Requirements: - The lock token is required to authenticate ownership of the lock - Only the user/application that created the lock can delete it - The lock is automatically released when the lock duration expires - The lock token is automatically added to the X-DocuSign-Edit header Use Cases: - Release a template lock after completing edits - Allow other users to modify a template that you previously locked - Clean up locks that are no longer needed before they expire naturally Security Note: You cannot delete a lock created by another user. The authenticated user must be the same user who created the lock, verified via the lock token.

Input Parameters

string
The DocuSign account ID (GUID format) or external account number (integer). If not provided, it will be automatically retrieved from the authenticated user’s account metadata. Example: ‘00000000-0000-0000-0000-000000000000’
string
required
Required. The lock token that proves ownership of the template lock. This token is returned when you create a lock using the ‘Lock template for editing’ action or by retrieving lock information with the ‘Get template lock information’ action. The token will be automatically added to the X-DocuSign-Edit header in JSON format: {“lockToken”:“<token>”}. Only the user/application that created the lock can delete it using this token. Example: “your_lock_token_here”
string
required
The unique identifier of the template from which the lock will be deleted. This parameter is required and must be provided in the path. It specifies which template’s lock should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_TEMPLATE_WORKFLOW_STEPDeletes 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, it will be automatically determined from the authenticated user’s context. Must be a valid string representing either the numeric account number or the GUID format account ID when specified. It is used to authenticate and authorize the API request to the specific DocuSign account.
string
required
The unique identifier of the template from which the workflow step will be deleted. This parameter is required and must be a valid string representing the template ID. It specifies the exact template within the account whose workflow definition will be modified by removing a step.
string
required
The unique identifier of the specific workflow step to be deleted from the template’s workflow definition. This parameter is required and must be a valid string representing the workflow step ID. It pinpoints the exact step within the template’s workflow that will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_AUTH_FOR_CLOUD_STORAGE_PROVIDERSThis 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.

Input Parameters

string
required
The unique identifier for the user whose cloud storage provider authentication is being deleted. This parameter is required and must be provided in the path of the API request. It”s important to note that users can only access and modify their own information, even if they have Admin rights. The userId ensures that the operation is performed on the correct user”s account.
string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). This parameter is required and must be provided in the path of the API request. It is used to specify which DocuSign account the operation should be performed on.
array
An Array containing the storage providers associated with the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_AUTHORIZATIONDeletes a specific DocuSign user authorization. A not-found error is reported as success, so a successful result can also mean the authorization was already deleted or did not exist.

Input Parameters

string
required
The unique identifier of the principal user whose authorization is being deleted. This parameter is required and must be provided in the path. It ensures that the correct user”s authorization is being targeted for deletion. Format: string (typically a GUID).
string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is required and must be provided in the path. It helps locate the specific account where the user authorization is to be deleted. Format: string (GUID or integer).
string
required
The unique identifier of the specific user authorization to be deleted. This parameter is required and must be provided in the path. It pinpoints the exact authorization that needs to be removed from the system. Format: string (typically a GUID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_AUTHORIZATIONSThe 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.

Input Parameters

string
required
The ID of the principal user whose authorizations are to be deleted. This parameter is required and must be provided in the path. It specifies the target user for the authorization deletion operation. The value should be a valid DocuSign user identifier, typically a string of numbers or a GUID (Globally Unique Identifier) associated with the user”s account.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your OAuth token and typically does not need to be provided manually. It determines the scope of the authorization deletion operation. If provided, the value should be a valid DocuSign account identifier, typically a string of numbers or a GUID (Globally Unique Identifier).
array
required
A list of authorization IDs to delete. Each authorization ID is a unique identifier (typically a GUID) that represents a specific permission grant that allows an agent user to act on behalf of the principal user. You can obtain authorization IDs by first calling the ‘Get User Authorizations For Principal’ action to retrieve the list of authorizations for a user, then use the authorization IDs from that response. This parameter is required and must contain at least one authorization ID. The API will return detailed results for each authorization ID, indicating whether it was successfully deleted or if an error occurred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_CLOUD_STORAGE_AUTHENTICATIONThis 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.

Input Parameters

string
The unique identifier of the user whose cloud storage authentication is being deleted. If not provided, defaults to the authenticated user’s ID. Important: Users can only delete their own authentication information, even those with Admin rights cannot access or modify another user”s settings.
string
The external account number (int) or account ID GUID. This uniquely identifies the DocuSign account for which the cloud storage authentication is being deleted. Must be a valid string representation of the account identifier.
string
required
The ID of the cloud storage service to delete authentication for. Can be specified either as the service name (e.g., “Box”) or the numerical serviceId (e.g., “4136”). This parameter is case-sensitive and must match the exact service identifier in the DocuSign system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_GROUPDeletes one or more user groups from the authenticated user’s resolved DocuSign account, using the supplied group IDs. The tool replaces any supplied account ID with the account resolved from authentication.

Input Parameters

array
An array of group objects specifying which groups to delete. Each group object should contain at minimum the ‘groupId’ field identifying the group to be deleted. Multiple groups can be deleted in a single request by including multiple group objects in this array.
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account where the group(s) will be deleted. If not provided, this parameter will be automatically populated from the authenticated user’s default account. This ensures that the group deletion operation is performed on the correct account.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_INITIALS_OR_SIGNATURE_IMAGEThis 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.

Input Parameters

string
required
The unique identifier for the user whose signature image is being deleted. Use “me” to reference the authenticated user (recommended). Users can only delete their own signature images - even users with admin rights cannot delete another user’s signature images. This security restriction ensures that signature images remain under the control of the individual user.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from authentication metadata. If not provided, it will be fetched from the user’s account information.
string
required
Specifies the type of image to be deleted. This parameter is required and must be one of the following valid values: - “signature_image”: Deletes the user’s signature image - “initials_image”: Deletes the user’s initials image - “stamp_image”: Deletes the user’s stamp image (eHanko or custom stamps) Note: Only one image type can be deleted per API call. To delete multiple types, make separate API calls for each image type.
string
required
The unique identifier for the signature to be deleted. This parameter is required and can be either the signature ID or the signature name. If using the signature name, it must be URL encoded if it contains spaces (e.g., “Bob Smith” should be encoded as “Bob%20Smith”). DocuSign recommends using the signature ID for more reliable results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USER_PROFILE_IMAGEDeletes a user’s DocuSign profile image; users can only delete their own image. The account is populated from the authenticated account, and the user ID is populated from authentication when omitted.

Input Parameters

string
The unique identifier of the user whose profile image is to be deleted. This parameter is optional in the request as it will be automatically populated from the authenticated user’s JWT token if not provided. Users can only delete their own profile image, so this typically defaults to the authenticated user’s ID. If explicitly provided, it must match the authenticated user’s own user ID.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is optional and will be automatically populated from the authenticated user’s account if not provided. If explicitly provided, it should be a valid string representing either a numeric account number or a GUID format account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_USERS_FROM_GROUPDeletes 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.

Input Parameters

array
An array of user objects to be deleted from the group. Each object should contain at minimum the userId field to identify which user to remove. Other fields like userName and email are optional and not required for deletion. This parameter is required to specify which users to delete from the group.
string
required
The unique identifier of the group from which users will be deleted. This parameter is required and must be provided in the path. It specifies the target group for the user deletion operation.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from authentication metadata and does not need to be manually provided. It identifies the account containing the group from which users will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_WORKFLOW_DEFINITION_FOR_TEMPLATEDeletes the workflow definition and its settings from a DocuSign template, such as when resetting the template’s workflow. A success response can also mean the template or workflow was not found, and does not necessarily confirm deletion.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required to specify which account the template belongs to. The value must be a non-empty string representing a valid DocuSign account identifier.
string
required
The unique identifier for the template whose workflow definition should be deleted. This is a required parameter and must be a non-empty string representing a valid template ID within the specified DocuSign account. The template ID is typically a long alphanumeric string generated by DocuSign when the template was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DELETE_WORKSPACE_FILES_OR_FOLDERSThis 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.

Input Parameters

array
A list of workspace items.
string
required
The ID of the folder containing the items to be deleted. This parameter is required and should be provided in the path. It”s a string value that uniquely identifies the folder within the specified workspace. To delete items from the root of the workspace, use the special value “root”. For sub-folders, use the folder”s unique identifier, which is typically a GUID (e.g., “00000000-0000-0000-0000-000000000000”).
string
The external account number (int) or account ID GUID. This parameter is required and should be provided in the path. It identifies the DocuSign account associated with the workspace. The value should be a string representing either a numeric account number or a GUID (Globally Unique Identifier) in the standard format (e.g., “123456” or “00000000-0000-0000-0000-000000000000”).
string
required
The ID of the workspace containing the items to be deleted. This parameter is required and should be provided in the path. It”s a string value that uniquely identifies the workspace within the specified account. The format is typically a GUID (e.g., “00000000-0000-0000-0000-000000000000”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_DEPRECATED_ENDPOINT_FOR_TAB_BLOBThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account the envelope belongs to.
string
required
The globally unique identifier (GUID) for the specific envelope. This 32-character alphanumeric string uniquely identifies the envelope containing the tabs to be updated. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This parameter is required to target the correct envelope for tab blob operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_EXPORT_BRAND_TO_XMLFILEExports a DocuSign brand’s configuration as an XML string. Use this action to retrieve comprehensive brand data including brand ID, name, company name, color scheme (background/text colors), logos (Base64-encoded), language settings, and custom links/landing pages. The XML format makes it suitable for backup, analysis, migration, or integration with other systems. Note: This operation requires branding to be enabled for the account (canSelfBrandSend or canSelfBrandSign must be true). Not all brands can be successfully exported - if a brand returns a 400 error, it may lack the necessary configuration or permissions for export.

Input Parameters

string
required
The unique identifier for the specific brand within the DocuSign account that should be exported. This is a required string parameter. Each brand in a DocuSign account has its own brandId, allowing for the export of information for a particular brand configuration.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is optional and will be automatically populated from authentication metadata if not provided. The accountId must correspond to an active DocuSign account with branding enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_FETCH_RECIPIENT_NAMES_FOR_EMAILRetrieves 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.

Input Parameters

string
required
The email address for which you want to retrieve associated recipient names. This is a required parameter that specifies which email to look up. The email address should be in a standard format (e.g., “user@example.com”). The endpoint will return all names linked to this email address in the specified DocuSign account.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your authenticated session and typically does not need to be provided manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GENERATE_EDIT_VIEW_URLFOR_ENVELOPEGenerates 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. This parameter is required and must be provided in the path of the request.
string
Identifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).
string
required
The unique identifier for the envelope to be edited. This is a GUID (Globally Unique Identifier) that specifically identifies the envelope within the DocuSign system. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This parameter is required and must be provided in the path of the request.
string
Set to envelope to limit the app user”s access to only the specified envelope. If this parameter is not set, the sender will have access to the entire account. Docusign strongly recommends using this property to make your integration more secure.
string
If your app will modify the envelope after the user finishes editing the envelope, create and use a lock token for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
string
Determines whether the Tagger”s back button is shown. Valid values: * true: The back button is shown. This is the default value. * false: Prevents access to the Prepare screen by hiding the back button.
string
Determines the starting screen for the sender view. Valid values: * Prepare (default) * Tagger
string
Sets the behavior of the back button when clicked. Valid values: * previousPage: Navigate to browser”s previous page * redirect: Redirect to the returnUrl specified in the request
string
Sets the behavior of the send button when clicked. Valid values: * send: send the envelope and redirect with query parameter event=Send (default) * redirect: Change the Tagger page”s button text to “Continue”; when clicked, redirect to the returnUrl with query parameter event=Save. Set showBackButton to false and startingScreen to Tagger.
string
When true, the Discard option is shown in the Actions menu. When false, the Discard option is not shown. The default value is true.
string
Determines whether the Actions menu displays advanced actions. Valid values: * true: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value. * false: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set startingScreen to Tagger and showBackButton to false.
string
Reserved for Docusign.
string
When paletteSections is set to custom, this property selects the tagger palette. Valid values: * custom (default) * merge * notary * seals * smartContracts * annotations * smartSections
string
string
Reserved for Docusign.
string
Valid values: * default (default): The default tagger palette UX * none: No tagger palette * custom: Set by paletteDefault
string
Reserved for Docusign.
string
When false, prevents the app user from adding, replacing, or deleting documents. The default value is true.
string
string
string
Reserved for Docusign.
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GENERATE_ENVELOPE_CORRECTION_URLGenerates a URL for embedding the DocuSign envelope correction view in an application. The view can be customized through request settings, and a return URL is required for redirecting users after correction.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your DocuSign connection and does not need to be provided manually. It is used to specify which account the envelope correction view should be generated for.
string
required
Required. Identifies the return point after correcting the envelope. DocuSign returns to this URL and includes an event parameter that can be used to redirect the user to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the correction transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the correction session ends before the user completes another action).
string
required
The unique identifier for the envelope that needs correction. This must be an envelope that has been sent (status: ‘sent’ or ‘delivered’). Draft envelopes cannot be corrected; use the sender view or edit view for draft envelopes instead. The envelope ID should be a valid GUID format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
Set to envelope to limit the app user”s access to only the specified envelope. If this parameter is not set, the sender will have access to the entire account. Docusign strongly recommends using this property to make your integration more secure.
string
If your app will modify the envelope after the user finishes editing the envelope, create and use a lock token for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
string
Determines whether the Tagger”s back button is shown. Valid values: * true: The back button is shown. This is the default value. * false: Prevents access to the Prepare screen by hiding the back button.
string
Determines the starting screen for the sender view. Valid values: * Prepare (default) * Tagger
string
Sets the behavior of the back button when clicked. Valid values: * previousPage: Navigate to browser”s previous page * redirect: Redirect to the returnUrl specified in the request
string
Sets the behavior of the send button when clicked. Valid values: * send: send the envelope and redirect with query parameter event=Send (default) * redirect: Change the Tagger page”s button text to “Continue”; when clicked, redirect to the returnUrl with query parameter event=Save. Set showBackButton to false and startingScreen to Tagger.
string
When true, the Discard option is shown in the Actions menu. When false, the Discard option is not shown. The default value is true.
string
Determines whether the Actions menu displays advanced actions. Valid values: * true: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value. * false: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set startingScreen to Tagger and showBackButton to false.
string
Reserved for Docusign.
string
When paletteSections is set to custom, this property selects the tagger palette. Valid values: * custom (default) * merge * notary * seals * smartContracts * annotations * smartSections
string
Controls whether document pages can be edited (e.g., rotated, deleted, reordered). When false, prevents editing of document pages. The default value is true.
string
Reserved for Docusign.
string
Valid values: * default (default): The default tagger palette UX * none: No tagger palette * custom: Set by paletteDefault
string
Reserved for Docusign.
string
When false, prevents the app user from adding, replacing, or deleting documents. The default value is true.
string
Controls whether the contacts list is available when adding recipients. When true, users can select recipients from their contacts list. The default value is true.
string
Controls whether recipients can be edited in the correction view. When false, prevents modification of envelope recipients. The default value is true.
string
Reserved for Docusign.
string
Controls whether the document visibility settings can be edited. When true, allows editing document visibility for recipients. The default value is true.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GENERATE_RECIPIENT_SHARED_VIEW_URLGenerates a URL for embedding the DocuSign recipient view of a shared envelope in your application. IMPORTANT: This endpoint requires the envelope to be explicitly shared with users on the same DocuSign account. The envelope must be shared first using DocuSign’s envelope sharing feature. Required: envelopeId (shared envelope), recipientId (from envelope), userId (account member with shared access), authenticationMethod (default: ‘None’). Use for team collaboration, delegation, and administrative support workflows. Not recommended for mobile iframes; use WebView on iOS instead.

Input Parameters

string
Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
string
required
REQUIRED. The user ID of the account member who is viewing the shared envelope. This user must have been granted shared access to the envelope. You can use either userId OR the combination of email and userName to identify the recipient. Use the List Envelope Recipients API to retrieve the userId from the envelope’s recipient list.
string
The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.
string
The username of the recipient. You can use either email and userName or userId to identify the recipient.
string
The external account number (integer) or account ID GUID. If not provided, it will be automatically populated from the authenticated user’s account information.
string
The URL to which the user should be redirected after the signing session has ended. Maximum Length: 470 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL Be sure to include https:// in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an event query parameter that your app can use: * access_code_failed: Recipient used incorrect access code. * cancel: Recipient canceled the signing operation, possibly by using the Finish Later option. * decline: Recipient declined to sign. * exception: A system error occurred during the signing process. * fax_pending: Recipient has a fax pending. * id_check_failed: Recipient failed an ID check. * session_timeout: The session timed out. An account can control this timeout by using the Signer Session Timeout option. * signing_complete: The recipient completed the signing ceremony. * ttl_expired: The Time To Live token for the envelope has expired. After being successfully invoked, these tokens expire after five minutes. * viewing_complete: The recipient completed viewing an envelope that is in a read-only/terminal state, such as completed, declined, or voided.
string
required
The envelope”s GUID (Globally Unique Identifier). This parameter is required and must be provided in the path to specify the exact envelope for which the shared view URL is being generated. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
A unique identifier of the authentication event executed by the client application.
string
required
REQUIRED. The unique identifier for the recipient who is viewing the shared envelope. This must match a recipientId from the envelope’s recipient list. Use the List Envelope Recipients API to retrieve valid recipientId values.
string
A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. Use your application”s client ID (user ID) for the recipient. Doing so enables the details of your application”s authentication of the recipient to be connected to the recipient”s signature if the signature is disputed or repudiated. Maximum length: 100 characters.
string
The display format for the signing view (e.g., ‘focused’ for focused view).
string
Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.
string
Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - deny: The page cannot be displayed in a frame. - same_origin: The page can only be displayed in a frame on the same origin as the page itself. - allow_from: The page can only be displayed in a frame on the origin specified by the xFrameOptionsAllowFromUrl property.
array
An array of ancestors that can embed the frame. This property is required when using focus view. In the demo environment, include your site URL and https://apps-d.docusign.com. You can use http://localhost for local development and testing. Example: ["https://my.site.com", "https://apps-d.docusign.com"] In the production environment, include your site URL and https://apps.docusign.com. HTTPS must be enabled on your site. Example: ["https://my.site.com", "https://apps.docusign.com"]
array
The originating domain for the signature request message. This property is required when using focus view. In the demo environment, the value must be https://apps-d.docusign.com. In production, the value must be https://apps.docusign.com.
string
The domain in which the user authenticated.
string
REQUIRED. Choose a value that most closely matches the technique your application used to authenticate the recipient/signer. Common values: ‘None’ (no authentication), ‘Email’, ‘Password’, ‘SingleSignOn_SAML’. Full list of valid values: Biometric, Email, HTTPBasicAuth, Kerberos, KnowledgeBasedAuth, None, PaperDocuments, Password, RSASecureID, SingleSignOn_CASiteminder, SingleSignOn_InfoCard, SingleSignOn_MicrosoftActiveDirectory, SingleSignOn_Other, SingleSignOn_Passport, SingleSignOn_SAML, Smartcard, SSLMutualAuth, X509Certificate. This information is included in the Certificate of Completion. Default: ‘None’.
string
The URL to redirect to when the recipient cancels.
string
A sender-generated value that indicates the date and time that the signer was authenticated.
string
The URL to redirect to when the recipient declines.
string
The URL to redirect to when an exception occurs.
string
The URL to redirect to when a fax is pending.
string
The URL to redirect to when the TTL expires.
string
When the value of xFrameOptions is allow_from, this property specifies the origin on which the page is allowed to display in a frame. If the value of xFrameOptions is allow_from, you must include a value for this property.
string
The URL to redirect to when ID check fails.
string
The URL to redirect to when the session times out.
string
The URL to redirect to when signing is complete.
string
The URL to redirect to when viewing is complete.
string
The URL to redirect to when the access code fails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ACCOUNT_BILLING_CHARGES_LISTRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is required to specify which account”s billing charges should be retrieved. Automatically populated from the authenticated user’s account if not provided.
string
An optional query parameter to specify which types of billing charges to include in the response. Valid values are “envelopes” and “seats”. If not specified, all charge types will be included. Use this parameter to filter the response to specific charge categories of interest.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ACCOUNT_PASSWORD_RULESRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). If not provided, the account ID will be automatically determined from the authenticated user’s information. The accountId must correspond to a valid, existing DocuSign account that the authenticated user has permission to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ACCOUNT_STAMP_IMAGERetrieves a downloadable image for a specific stamp, signature, or initials in the authenticated user’s first resolved DocuSign account. An option controls whether to include the chrome around the image.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account the stamp or signature belongs to. For example: “12345” or “a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8”.
string
required
Specifies the type of image to retrieve. This is a required parameter and must be exactly one of three valid string values (case-sensitive): “stamp_image” (retrieves the image of an account stamp), “signature_image” (retrieves the image of a signature), or “initials_image” (retrieves the image of initials). No other values are accepted. Choose the type based on which visual element you need to obtain.
string
required
The unique identifier for the specific stamp, signature, or initials image you want to retrieve. This is a required string parameter. It ensures that you get the exact image you”re looking for within the account. The format is typically a GUID, for example: “b1c2d3e4-f5g6-7890-h1i2-j3k4l5m6n7o8”.
string
Optional parameter that controls whether to include decorative framing (chrome) around the signature image. Although conceptually boolean, this must be provided as a string value: “true” to include the frame/border/identifying text around the image, “false” to return only the core image without decoration, or omit entirely to use the default behavior (no chrome). This parameter allows flexibility in how the image is presented or used in other applications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_AGENT_USER_AUTHORIZATIONSReturns the authorizations for which the specified user is the agent user. An agent user can act on behalf of other users (principal users) in the account. This endpoint retrieves the list of principal users and their authorization details, including permissions like Send, Manage, Sign, and Edit. Supports filtering by permission level, active status, and pagination for large result sets.

Input Parameters

string
Maximum number of results to return per page for pagination.
string
The unique identifier of the user for whom to retrieve agent authorizations. Auto-populated with the authenticated user ID.
string
The external account number (integer) or account ID GUID. Auto-populated from authenticated account.
string
When set to ‘true’, returns only active authorizations. Defaults to ‘false’ (returns both active and inactive).
string
Filter by permission levels (comma-separated). Valid values: ‘Send’, ‘Manage’, ‘Sign’, ‘Edit’.
string
Starting position in result set for pagination (0-based index).
string
When ‘true’ (default), includes authorizations from closed/inactive users. Only applied when active_only is ‘false’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BCC_EMAIL_ARCHIVE_CONFIGURATIONSRetrieves a paginated list of BCC email archive records for a DocuSign account, including email addresses, status, and modification details.

Input Parameters

string
The maximum number of results to return in a single API call. This optional query parameter allows you to limit the size of the result set. It should be used in conjunction with “start_position” for paginating through large sets of results. The value should be a positive integer. If not specified, the API will return all available results up to a server-defined limit.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is required and must be provided in the path to specify which account”s BCC email archive configurations should be retrieved.
string
The zero-based index of the first result to return in the current API call. This optional query parameter is used for pagination, allowing you to specify where in the result set to begin retrieving records. It should be used in conjunction with “count” to paginate through large sets of results. The value should be a non-negative integer. If not specified, it defaults to 0, meaning the API will start from the beginning of the result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BCCEMAIL_ARCHIVE_HISTORYRetrieves 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.

Input Parameters

string
An optional query parameter that specifies the maximum number of results to return in the response. Use this parameter in conjunction with “start_position” to implement pagination and control the size of the result set. If not specified, the API will return all available results up to a system-defined limit.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account”s BCC email archive configuration history should be retrieved.
string
An optional query parameter that specifies the zero-based index of the first result to return. Use this parameter in conjunction with “count” to implement pagination and retrieve specific subsets of the result set. The default value is 0, which returns results from the beginning of the list. This parameter is particularly useful for navigating through large result sets.
string
required
The unique identifier of the specific BCC email archive configuration whose history is being requested. This parameter is required and must be provided in the path of the API request. It is used to pinpoint the exact configuration for which the history should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BRAND_LOGO_BY_TYPERetrieves 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.

Input Parameters

string
required
The unique identifier for the brand within the specified DocuSign account. Required parameter that determines which specific brand”s logo will be retrieved.
string ("primary" | "secondary" | "email")
required
Specifies the type of logo to retrieve. Must be one of: ‘primary’ (main brand logo), ‘secondary’ (alternate brand logo), or ‘email’ (logo used in email communications). Each type represents a different use case for the logo within the DocuSign platform.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is optional and will be automatically populated from your authenticated account if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BRANDS_INFORMATION_FOR_GROUPRetrieves 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.

Input Parameters

string
required
The unique identifier for the group within the specified DocuSign account. This parameter is required and must be a valid group ID string. It determines which group”s brand information will be retrieved. The groupId must correspond to an existing group within the specified account, and the API user must have appropriate permissions to access the group”s information.
string
The unique identifier for the DocuSign account. This can be either the account”s external number (an integer) or the account ID GUID. If not provided, the account ID will be automatically retrieved from the authenticated user’s account information. The accountId must be valid and associated with an existing DocuSign account to which the API user has access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BULK_SEND_BATCH_STATUSGet the status and progress of a DocuSign bulk send batch operation. This action retrieves comprehensive status information for a bulk send batch, including counts of sent, queued, and failed envelopes. Use this to monitor the progress of large-scale document distribution operations. Key Response Fields: - batchSize: Total envelopes in the batch - sent: Successfully sent envelopes - queued: Envelopes still being processed - failed: Failed envelope count - bulkErrors: Details about any failures Usage Notes: - Bulk send processing is asynchronous; poll this endpoint to check progress - The batch is complete when batchSize equals (sent + failed) - Recommended polling interval: 30-60 minutes for large batches - Use the bulkSendBatchId returned from creating a bulk send request

Input Parameters

string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This is automatically populated from your connected account credentials and typically does not need to be provided manually.
string
required
The unique identifier (GUID) for the bulk send batch to query. This is the batchId returned when creating a bulk send request. Use this to track the progress and outcome of your bulk sending operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_BULK_SEND_LISTS_INFORMATIONRetrieves 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.

Input Parameters

string
The external account number (int) or account ID GUID. This parameter is required and must be provided in the path to identify the specific DocuSign account for which to retrieve the Bulk Send Lists information. It can be either an integer external account number or a GUID (Globally Unique Identifier) string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_DOCUSIGN_ACCOUNT_CONTACTSRetrieves detailed information about a specific contact from a DocuSign account’s address book. Use this action when you need to look up a contact’s details including their name, email addresses, phone numbers, organization, notary certifications, and signing group associations. Requires the contact’s unique ID which can be obtained from listing contacts or previous operations. The contact data can be sourced from the default DocuSign address book or connected cloud storage providers like DocuSign Rooms. Note: Phone numbers for shared contacts may have limited visibility to users other than the contact creator.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. This parameter is automatically populated from your authenticated session if not provided.
string
required
The unique identifier for a specific contact in the account’s address book. This is required to retrieve information about a particular contact.
string
Optional parameter specifying the cloud service from which to retrieve the contact. Valid values are “rooms” for DocuSign Rooms contacts and “docusignCore” for the standard DocuSign address book (default if not specified).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_DOWNGRADE_PLAN_INFO_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). If not provided, the account ID will be automatically retrieved from the authenticated user’s OAuth token. When specified, it must be a valid DocuSign account identifier to retrieve that account’s downgrade request information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ELECTRONIC_DISCLOSURE_FOR_RECIPIENTRetrieves 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.

Input Parameters

string
required
The language code for the disclosure (e.g., ‘en’ for English, ‘fr’ for French, ‘de’ for German, ‘es’ for Spanish, ‘ja’ for Japanese). Use ‘browser’ to auto-detect the viewer’s browser language. Supported codes include: ar, bg, cs, zh_CN, zh_TW, hr, da, nl, en, en_GB, et, fa, fi, fr, fr_CA, de, el, he, hi, hu, id, it, ja, ko, lv, lt, ms, no, pl, pt, pt_BR, ro, ru, sr, sk, sl, es, es_MX, sv, th, tr, uk, vi.
string
The DocuSign account ID (automatically populated from authentication). This identifies the DocuSign account for which the disclosure is being retrieved.
string
required
The envelope’s unique identifier (GUID format). Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”
string
required
The recipient’s unique identifier within the envelope. This is typically a sequential number (e.g., ‘1’, ‘2’, ‘3’) or a GUID assigned when the envelope was created. Use this to specify which recipient’s disclosure to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ELECTRONIC_RECORD_AND_SIGNATURE_DISCLOSURERetrieves 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.

Input Parameters

string
Optional query parameter specifying the desired language version of the disclosure to retrieve. Must be a valid language code string if provided. Supported languages include Arabic (“ar”), Bulgarian (“bg”), Chinese Simplified (“zh_CN”), English US (“en”), French (“fr”), German (“de”), Japanese (“ja”), and many others. Use “browser” to automatically detect and use the viewer”s browser language. If not provided, returns the default language disclosure. The language code affects the content of the retrieved disclosure.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve the Electronic Record and Signature Disclosure (ERSD). This parameter is required and must be a valid string representation of either the account number or GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENOTE_INTEGRATION_SETTINGSRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is a required path parameter that specifies which account’s eNote integration settings should be retrieved. The value must be a valid DocuSign account identifier associated with your organization or user permissions. If not provided, it will be automatically populated from the authenticated user’s account information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPEGets 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

Input Parameters

string
required
The external account number (int) or account ID GUID
string
required
The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_DOC_GEN_FORM_FIELDSRetrieves document generation form fields from an envelope’s documents. DocGen form fields are placeholder fields (tags) in template documents that can be dynamically populated with data before sending. This action returns the list of available form fields including their names, types, validation rules, and current values. Use this to discover which fields can be populated via the UPDATE_ENVELOPE_DOC_GEN_FORM_FIELDS action. Common use cases: - Retrieve form field definitions before populating them with data - Inspect field types and validation requirements - Check current values of form fields in a draft envelope Note: Returns an empty response if the envelope has no DocGen form fields.

Input Parameters

string
The DocuSign account ID (GUID format) or external account number. Leave empty to auto-retrieve from the authenticated connection. Example: ‘b06ae21f-4d1a-4da9-8e7a-795f6c9c8f7b’
string
required
The unique identifier (GUID) of the envelope containing DocGen form fields. The envelope must exist in the specified account. Example: ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_DOCUMENT_FIELDSRetrieves custom document fields from a specific document within a DocuSign envelope. Custom document fields are metadata key-value pairs attached to individual documents in an envelope. They are different from: - Envelope custom fields (which apply to the entire envelope) - Tabs/fields (which are fillable form fields for recipients) Use this action to retrieve metadata associated with a specific document, such as department codes, project IDs, or other custom categorization data. Prerequisites: - A valid envelope_id (create using DOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATE) - A valid document_id (obtain from DOCUSIGN_GET_ENVELOPE) - The document must exist in the specified envelope The document_id must be a string representation of a positive integer (1-2147483647). Typically documents are numbered sequentially starting from ‘1’. Returns a dictionary containing the ‘documentFields’ array with field objects.

Input Parameters

string
required
The DocuSign account ID. This is automatically populated by the base action from the authenticated user’s account information. You can also use ‘me’ as an alias.
string
required
The unique ID of the document within the envelope. Must be a string representation of an integer between 1 and 2147483647. Typically the first document has ID ‘1’, the second has ID ‘2’, etc. You can get document IDs by calling DOCUSIGN_GET_ENVELOPE which returns information about all documents in the envelope.
string
required
The unique identifier (GUID) of the envelope containing the document. Example: ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’. You can get envelope IDs from DOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATE or other envelope-related actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_LOCK_INFORMATIONRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account the envelope belongs to.
string
required
The unique identifier for the envelope whose lock information is being requested. This is a required GUID string that specifically identifies the envelope. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_NOTIFICATION_DEFAULTSRetrieves account-level default email notification settings for envelopes sent through the API or console, including sender and signer notification preferences for envelope events.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account’s external number (int) or the account ID GUID. This parameter is automatically populated from your authenticated DocuSign credentials when not provided. The accountId must be associated with your DocuSign credentials to access the settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_WORKFLOW_DEFINITIONRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and must be provided in the path of the API request. It identifies the specific account context for the envelope workflow being retrieved.
string
required
The unique identifier (GUID) of the envelope for which the workflow definition is being requested. This parameter is required and must be provided in the path of the API request. It should be a valid GUID string, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. Only envelopes that exist within the specified account can be queried.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ENVELOPE_WORKFLOW_DELAYED_ROUTING_DEFINITIONRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. This parameter is required and must be provided in the path of the API request. It is used to specify which account the envelope and workflow belong to.
string
required
The unique identifier for the envelope. This is a GUID (Globally Unique Identifier) that specifically identifies the envelope you want to retrieve the delayed routing definition for. The envelopeId is required and must be provided in the path of the API request. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
The unique identifier for the specific workflow step within the envelope. This parameter is required and must be provided in the path of the API request. It specifies which step in the envelope”s workflow you want to retrieve the delayed routing definition for. The format is typically a string, but the exact structure may vary depending on DocuSign”s internal representation of workflow steps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_GROUPS_INFORMATION_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The maximum number of results to return in the response. Valid values range from 1 to 100. Use in conjunction with “start_position” for pagination. If not specified, the default behavior may return all results or a server-defined default number.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account”s groups to retrieve.
string
Filters the returned groups by type. Valid values are “AdminGroup”, “CustomGroup”, or “EveryoneGroup”. If not specified, groups of all types will be returned. Use this to focus on specific categories of groups within the account.
string
A string used to filter the results based on group names. The search is case-insensitive and matches any part of the group name. Use this for finding specific groups when you don”t know the exact name or ID.
string
The zero-based index of the first result to return. Use in combination with “count” for pagination. The default value is 0, which starts at the beginning of the result set. For example, to get the second page of results with 50 items per page, use start_position=50.
string
A boolean flag that, when set to “true”, includes a “userCount” property in the response for each group, indicating the total number of users in that group. The default value is “true”. Set to “false” to omit this information if it”s not needed, potentially improving response time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_LIST_OF_ACCOUNT_PERMISSION_PROFILESThis 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.

Input Parameters

string
An optional query parameter that allows requesting additional properties in the response. It accepts a comma-separated list of values. Valid options are: - user_count: Includes the total number of users associated with each permission profile. - closed_users: When used with user_count, includes closed users in the count. - account_management: Includes the account management settings for each profile. - metadata: Includes metadata indicating whether the properties associated with each account permission profile are editable. Example usage: “user_count,closed_users” This parameter is optional. If not specified, the response will include only the standard profile information.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the URL path. It should be a valid account identifier associated with your DocuSign integration. Example: “12345” or “a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_MEMBERS_OF_A_SIGNING_GROUPRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is optional as it will be automatically populated from your authentication credentials if not provided. For example: “7215091” or “f0f9781e-a546-4ca0-aa1c-0e878c61b64d”.
string
required
The unique identifier of the Signing Group whose members you want to retrieve. This is a required string parameter. It corresponds to the ID of a previously created Signing Group in the specified DocuSign account. For example: “1376641” or “1234567”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_NOTARY_JOURNALSTool to retrieve notary journal entries for the current user. Use when you need to access a user’s notary journal records, which contain information about notarized documents including signer names, document names, jurisdictions, and timestamps.

Input Parameters

string
The maximum number of results to return.
string
Use this parameter to search for specific text.
string
The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_NOTARY_JURISDICTION_OBJECTRetrieves 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.

Input Parameters

string
required
The unique identifier for the notary jurisdiction. This ID must correspond to a jurisdiction the current user is registered for as a notary. You can retrieve available jurisdiction IDs by first calling the ‘Get Notary Jurisdictions For User’ action. Jurisdiction IDs are numeric strings representing U.S. states or territories (e.g., “6” for Colorado, “49” for Wisconsin). Note: A user can typically only be registered for one jurisdiction at a time. Using an unregistered jurisdiction ID will result in a 400 error with code “NOTARY_JURISDICTION_NOT_CONFIGURED”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_NOTARY_USER_SETTINGSRetrieves notary settings for the authenticated DocuSign user, including user information, enabled status, and creation date. Optionally requests jurisdiction details to help review the user’s notary configuration.

Input Parameters

string
Whether to include jurisdiction details in the response. Set to “true” to include a list of all supported jurisdictions for the notary user, or omit/set to “false” to exclude jurisdiction information. When “true”, the response includes a “jurisdiction” array with jurisdiction IDs, names, and other details. Optional parameter. Valid values: “true”, “false”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_ORIGINAL_HTML_DEFINITION_FOR_TEMPLATERetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is optional - if not provided, it will be automatically retrieved from the authenticated user’s account information. If provided, it must be a valid string representation of either an integer or a GUID. For example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier of the template for which the HTML definition is being requested. This parameter is required and must be a valid string representation of the template ID. For example: “template-123-abc-456-def”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_PAGE_IMAGE_FROM_ENVELOPERetrieves 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.

Input Parameters

string
An optional parameter that sets the dots per inch (DPI) for the returned image. This affects the resolution and file size of the image. Higher DPI values result in higher quality but larger file sizes. If not specified, a default DPI value will be used.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your authenticated connection. Leave empty to use the default account from your credentials.
string
An optional parameter that sets the maximum width for the page image in pixels. If specified, the DPI will be recalculated based on this setting to fit the image within the specified width while maintaining the aspect ratio. This can be used to limit the size of the returned image.
string
required
The unique identifier of the document within the envelope. This is a user-specified ID, typically starting from 1 for the first document, 2 for the second, and so on. It must be a positive integer between 1 and 2147483647. This parameter is required to identify the specific document from which to retrieve the page image.
string
required
The GUID (Globally Unique Identifier) of the envelope containing the document. This is a required parameter and must be in the format of a UUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It is used to locate the specific envelope from which the document page image will be retrieved.
string
An optional parameter that sets the maximum height for the page image in pixels. If specified, the DPI will be recalculated based on this setting to fit the image within the specified height while maintaining the aspect ratio. This can be used to limit the size of the returned image.
string
required
The specific page number of the document to be retrieved as an image. This is a required parameter and must be a positive integer representing the desired page. The value should not exceed the total number of pages in the document.
string
An optional boolean parameter that, when set to “true”, displays any changes or annotations made to the document in the returned image. If set to “false” or not specified, the original document page without changes will be returned. This is useful for viewing the latest version of the document with any modifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_PDFTRANSCRIPT_OF_ENVELOPE_COMMENTSRetrieves a PDF transcript of comments on a DocuSign envelope as a downloadable file. The comments feature must be enabled in the account settings.

Input Parameters

string
An optional parameter that specifies the encoding to use for the returned PDF file. If not provided, the default encoding will be used. The exact available encoding options are not specified in the schema, so consult the DocuSign API documentation for valid values if needed.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, it will be auto-populated from the authentication metadata.
string
required
The unique identifier (GUID) of the envelope containing the documents and comments to be retrieved. This parameter is required and must be in the format of a valid GUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It specifies which specific envelope”s comments should be included in the PDF transcript.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_PERMISSION_PROFILE_FOR_ACCOUNTRetrieves a specific DocuSign account permission profile, including its account role settings and API access permissions. The operation is read-only.

Input Parameters

string
An optional parameter that allows you to request additional information in the response. Currently, the only valid value is “metadata”, which will include metadata indicating whether the properties associated with the account permission profile are editable. This parameter is a comma-separated list, so it”s designed to support multiple values in the future. For example: “include=metadata”
string
The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID (a string). When not provided, the account ID is automatically retrieved from the authenticated user’s account. You can explicitly provide an account ID to query a different account. For example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
required
The unique identifier for the specific permission profile you want to retrieve. This is a required parameter and must be a valid permission profile ID associated with the specified account. You can obtain a list of permission profile IDs using the AccountPermissionProfiles: list endpoint. Alternatively, you can download a CSV file containing all permission profiles and their IDs from the “Settings > Permission Profiles” page of your eSignature account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_POWER_FORM_SENDERSRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). It is required to specify which account”s PowerForm senders should be retrieved. For example: “7215091” or “f0f9781e-a546-4572-aa5c-bf90532d2faf”.
string
An optional parameter that specifies the starting position within the total result set from which to begin returning values. It can be used for pagination to retrieve subsequent pages of results. The value should be a positive integer representing the index of the first item to return. For example, “1” to start from the beginning, or “51” to start from the 51st item. If omitted, the response will start from the beginning of the result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_RECIPIENT_DOCUMENT_VISIBILITYRetrieves 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.

Input Parameters

string
required
The unique identifier for the DocuSign account. This can be either an integer (external account number) or a GUID (account ID). Required parameter that specifies which account the envelope belongs to. Format: String.
string
required
The unique identifier for the envelope containing the documents and recipients. This is a required GUID string that precisely identifies the envelope you want to query. Format: String, Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
A unique identifier for the recipient within the envelope. This can be either an integer or a GUID and must be unique within the envelope. It”s used to map recipients to other objects, such as specific document tabs. Required parameter. Format: String, Example: “1” for the first recipient in many envelopes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_REQUEST_LOGGING_LOG_FILEDownloads the complete log file for a specific API request from DocuSign’s Diagnostics service. This action is essential for debugging and troubleshooting API interactions by providing detailed request/response information. The log file contains: - Full HTTP request details (method, URL, headers, body) - Complete HTTP response (status, headers, body) - Timing information - Other diagnostic metadata Note: API request logging must be enabled in your DocuSign account to generate log entries. You can enable it using the ‘toggle_api_request_logging’ action. After logging is enabled, use ‘retrieve_apirequest_log_files’ to get a list of available log IDs, then use this action to download specific log files. The log helps you: - Debug API integration issues - Verify request/response data - Troubleshoot authentication problems - Investigate unexpected API behavior

Input Parameters

string
required
The unique identifier for the specific log entry to be retrieved. This ID is obtained from the list of log entries (which can be retrieved using the ‘retrieve_apirequest_log_files’ action). The requestLogId must be a valid log entry identifier from your DocuSign account’s request logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_REQUEST_LOGSRetrieves a list of API request log entries as a JSON object. Use when you need to view diagnostic information about API requests made to DocuSign.

Input Parameters

string
Reserved for DocuSign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_REQUEST_LOG_SETTINGSTool to retrieve current API request logging settings for the authenticated user. Use when you need to check logging configuration or remaining log entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_RESOURCE_INFORMATIONRetrieves the base resources available for the DocuSign eSignature REST API, helping discover available API endpoints and resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SERVICE_INFORMATIONGets the current version and other information about the DocuSign eSignature REST API. Use this to retrieve service information including API versions and build details. This returns the available REST API versions (v1, v2, v2.1) with their endpoint URLs, the current build version string, and linked DocuSign sites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SIGNATURE_INFORMATION_FOR_RECIPIENTRetrieves signature information for a specific recipient in a DocuSign envelope. Returns signature metadata including: signature ID, name, type, initials, adoption and modification timestamps, signature image URI, base64-encoded image data, and stamp properties if applicable. Use when you need to: - Verify or audit recipient signature details after signing - Display signature images or metadata in your application - Retrieve current signature state within an envelope Required parameters: - envelopeId: The envelope ID containing the recipient - recipientId: The recipient’s ID (often “1” for first signer) - accountId: Auto-populated from authentication (optional) Note: Returns signature data only, not general recipient status. Recipient must be a signer or sign-in-person recipient type.

Input Parameters

string
The unique identifier for the DocuSign account. This is typically auto-populated from your authentication context and does not need to be provided manually. If specified, it should be either the external account number (integer) or the account ID GUID (string).
string
required
The unique identifier for the envelope containing the recipient whose signature information is being retrieved. This must be a valid GUID string (e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”). It is required to specify which envelope the recipient belongs to.
string
required
The unique identifier for the recipient within the specified envelope. This can be either an integer string or a GUID string. It must be unique within the envelope and is used to map recipients to other objects, such as specific document tabs. For example, many envelopes assign the first recipient a recipientId of “1”. This parameter is required to specify which recipient’s signature information to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SIGNING_GROUP_INFORMATIONRetrieves detailed information about a specific signing group in a DocuSign account. Returns comprehensive data including the group’s name, type (sharedSigningGroup, privateSigningGroup, or systemSigningGroup), email address, creation/modification timestamps, and a complete list of member users with their names and email addresses. This is a read-only operation useful for: - Auditing signing group composition and membership - Verifying group configuration before using in envelope workflows - Administrative tasks and troubleshooting - Integrating signing group data into custom applications The accountId parameter is optional - if not provided, it will be automatically derived from your authentication context. Only the signingGroupId is required.

Input Parameters

string
The DocuSign account ID (GUID format like ‘b06ae21f-4d1a-4da9-8e7a-795f6c9c8f7b’). Optional - if not provided, will be automatically determined from your authentication context. Only specify this if you need to access a different account than your default authenticated account.
string
required
The unique identifier of the signing group to retrieve (e.g., ‘1376642’). Required. This numeric string ID can be obtained from the CREATE_SIGNING_GROUP or RETRIEVE_ACCOUNT_SIGNING_GROUPS actions, or from the DocuSign web interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SPECIFIC_BRAND_RESOURCE_FILERetrieves a specific branding resource file (XML format) for customizing DocuSign experiences. Brand resource files control text and visual elements for sending, signing, email, and captive signing experiences. IMPORTANT: Resource files must be pre-configured for the brand. This is an advanced feature enabled through DocuSign admin or account manager. Use the “return_brand_resource_metadata_for_account” action first to verify which resource types are available before calling this action. Supports localization via language codes and can return either the full master resource file or only modified elements.

Input Parameters

string
required
The unique identifier for the brand whose resources will be retrieved. Each brand has its own set of customizable resources. Note: The brand must have resource files configured for this action to succeed.
string
Optional language code for the brand resources using ISO 639-1 codes (e.g., “en” for English, “fr” for French, “de” for German). If not provided, the default language for the brand will be used.
string
The DocuSign account ID (GUID) or external account number. Auto-populated from authentication if not provided.
string
Optional parameter to control which resource file data to return. Set to “true” to return only the master resource file, or “false” (or omit) to return only modified elements. Useful for comparing customizations against the master file.
string
required
The type of brand resource file to return. Valid values: “email” (email communications), “sending” (document sending experience), “signing” (standard signing experience), or “signing_captive” (embedded signing experience). The brand must have this specific resource type configured; use the “return_brand_resource_metadata_for_account” action to check available types first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SPECIFIED_ACCOUNT_STAMP_INFORetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (Globally Unique Identifier). This parameter is automatically populated from the authenticated user’s account if not provided. You typically don’t need to specify this parameter explicitly.
string
required
The unique identifier for the specific account stamp (signature) you want to retrieve information about. This is a required parameter and must be provided to pinpoint the exact signature within the specified account. The format is typically a string, possibly a GUID, assigned by DocuSign when the signature was created or last updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_SUPPORTED_LANGUAGES_FOR_RECIPIENTSRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). If not provided, the system will automatically use the account ID from your authenticated session. You can optionally specify a different account ID if you have access to multiple accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TABS_BLOB_FOR_ENVELOPEThis 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.

Input Parameters

string
required
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It can be either a numeric value or a GUID string, depending on how the account is identified in the system. Example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier for the envelope whose tabs blob you want to retrieve. This parameter is required and must be provided in the path of the API request. It should be a valid GUID (Globally Unique Identifier) string representing a specific envelope in the DocuSign system. The format is a 32-character hexadecimal string, typically displayed with hyphens separating four groups. Example: “93be49ab-1234-5678-abcd-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TAB_SETTINGS_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account’s external number (an integer) or the account’s GUID (Globally Unique Identifier). This field is automatically populated from your authentication credentials. You typically don’t need to provide this value manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATEGets a template definition from the authenticated user’s first DocuSign account. The include parameter can request PowerForms, tabs, documents, and favorite-template status.

Input Parameters

string
Comma-separated list of additional template attributes to include: powerforms, tabs, documents, favorite_template_status
string
required
The external account number (int) or account ID GUID
string
required
The ID of the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_DELAYED_ROUTING_RULESRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). If not provided, it will be automatically populated from your authenticated DocuSign account. The accountId must be valid and associated with your DocuSign integration.
string
required
The unique identifier for the DocuSign template. This is a required string parameter that specifies which template’s workflow step to query for delayed routing rules. The templateId must exist within the specified account and contain the workflow step being investigated.
string
required
The unique identifier for the specific workflow step within the template. This required string parameter determines which step’s delayed routing rules will be retrieved. The workflowStepId must be valid and correspond to an existing step in the specified template’s workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_DOCUMENT_HTML_DEFINITIONRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID. If not provided, the account ID will be automatically determined from the authenticated user’s context. Identifies the DocuSign account associated with the template and document.
string
required
The unique ID of the document within the template. This parameter is required and must be specified by the user. It should be a string representation of a 32-bit signed integer between 1 and 2147483647. Typically, the first document has ID “1”, the second “2”, and so on, but any valid numbering scheme within the specified range can be used. This ID is used to reference specific documents within the template.
string
required
The ID of the template containing the document. This parameter is required and uniquely identifies the template from which to retrieve the document’s HTML definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_LOCK_INFORMATIONRetrieves lock information for a DocuSign template, including duration, expiration and owner details; the lock token is available only to the locking user with the same integrator key. An HTTP 404 from the lock request returns an empty response.

Input Parameters

string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required to identify the specific account for which the template lock information is being requested. It should be a valid string representing either a numeric account number or a GUID format account ID.
string
required
The unique identifier of the template for which lock information is being requested. This parameter is required and should be a valid string representing the template ID within the specified DocuSign account. The template ID is typically a GUID-format string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_NOTIFICATION_INFORMATIONRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). When not provided, the account ID will be automatically retrieved from the authenticated user’s account information.
string
required
The unique identifier for the template within the specified DocuSign account. This is a required string parameter used to retrieve the notification information for a specific template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYRetrieves document visibility settings for a specific recipient in a DocuSign template. Returns which documents are visible to a recipient and their access rights (view/edit). Document visibility controls show or hide specific documents from recipients in multi-document templates, ensuring sensitive information is only shared with authorized parties. Important: Document Visibility must be enabled for your account by an administrator. Documents cannot be hidden from recipients if they have tabs assigned to them. Carbon Copy, Certified Delivery, Editor, and Agent recipients can always see all documents. Returns a list of documentVisibility objects with: documentId, visible (“true”/“false”), rights (access level), and recipientId.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. If not provided, it will be automatically retrieved from your connected DocuSign account. The accountId must be valid and associated with an active DocuSign account.
string
required
The unique identifier for the DocuSign template. This is required to specify which template”s recipient document visibility information should be retrieved. The templateId must correspond to an existing template within the specified account.
string
required
A unique identifier for the recipient within the template. This can be either an integer or a GUID. The recipientId is used to map recipients to specific document tabs and must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of “1”. This parameter is required to specify which recipient”s document visibility information should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATE_SCHEDULED_SENDING_SETTINGSRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided as a string, either in the form of a numeric account number or a valid GUID (Globally Unique Identifier).
string
required
The unique identifier of the template for which you want to retrieve the scheduled sending settings. This parameter is required and must be provided as a string. It represents the specific template within the account that you want to query for its scheduled sending configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATES_FOR_ENVELOPE_DOCUMENTRetrieves 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.

Input Parameters

string
A comma-separated list that limits the results returned by the API. This optional parameter allows you to specify which types of templates to include in the response. Valid values are: “applied” (returns templates that have been applied to the document) and “matching” (returns templates that match the document but may not have been applied). If omitted, the API will return all associated templates. For example, to get only applied templates, use “applied”; to get both applied and matching templates, use “applied,matching”.
string
The external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the operation is being performed. It is automatically populated from your authenticated DocuSign connection. You typically do not need to provide this parameter manually.
string
required
The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically, the first document has the ID “1”, the second document “2”, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). This ID is crucial for identifying the specific document within the envelope for which you want to retrieve associated templates.
string
required
The envelope”s GUID (Globally Unique Identifier). This is a required parameter that uniquely identifies the envelope containing the document for which you want to retrieve templates. The GUID should be in the format of a 32-character string, such as “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ID is essential for locating the correct envelope in the DocuSign system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_TEMPLATES_USED_IN_ENVELOPEThis 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.

Input Parameters

string
An optional query parameter that filters the types of templates to be returned. It accepts two possible values: “applied” (returns templates applied to the envelope) or “matching” (returns matching templates for the envelope). If not specified, it defaults to “applied”. This parameter allows for more targeted retrieval of template information based on how they relate to the envelope.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, it will be automatically retrieved from the authenticated user’s account information.
string
required
The unique identifier (GUID) of the envelope for which templates are to be retrieved. This parameter is required and should be in the format of a 32-character alphanumeric string, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It specifies the exact envelope whose templates you want to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_UNSUPPORTED_FILE_TYPES_LISTRetrieves DocuSign’s list of unsupported upload file types, including extensions and MIME types. The list may change as DocuSign updates its supported file types.

Input Parameters

string
The DocuSign account ID (GUID or integer). Auto-populated from authenticated account if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_URLFOR_EMBEDDING_DOCUSIGN_UIGenerate a URL to embed the DocuSign console view within your application. This action creates a URL that provides access to the DocuSign web interface, allowing users to interact with DocuSign features directly from your application without leaving your UI. Use Cases: - Display DocuSign console home page (when no envelopeId provided) - View specific sent envelope documents (with sent envelope ID) - Edit and send draft envelopes via sender view (with draft envelope ID) Security Note: This provides full access to the DocuSign account’s console interface. Use appropriate access controls in your application when exposing these URLs to users. Best Practice: When using with draft envelopes, provide a returnUrl to give users a way to navigate back to your application after completing their task.

Input Parameters

string
The DocuSign account ID (GUID format) for which to generate the console view URL. This is automatically populated from your connected DocuSign account.
string
Optional URL where the user will be redirected after completing their action in the DocuSign console. This is primarily used when viewing draft envelopes to provide an exit path from the sender view. Example: ‘https://yourapplication.com/dashboard’
string
Optional envelope ID to display in the console view. - If provided with a sent envelope: Returns URL to view envelope documents. - If provided with a draft envelope: Returns URL to sender view for editing. - If not provided: Returns URL to DocuSign console home page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_USER_AUTHORIZATION_DETAILSRetrieves 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.

Input Parameters

string
The unique identifier of the principal user associated with the authorization. This is required and helps to ensure that the correct authorization is being accessed. If not provided, it will be automatically populated from the authenticated user context.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account the user authorization belongs to.
string
required
The unique identifier for the specific user authorization to be retrieved. This ID is required and must correspond to an existing user authorization within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_USER_AUTHORIZATIONS_FOR_PRINCIPALRetrieves 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.

Input Parameters

string
Specifies the maximum number of results to return in the response. This optional parameter helps with pagination and should be provided as a string representing a positive integer in the query. If not specified, the API will use a default value.
string
The unique identifier of the principal user whose authorizations are being retrieved. This parameter is required and must be provided in the path. It should be a valid string representing the user”s ID within the DocuSign system.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a valid string representing either a numeric account number or a GUID format account identifier.
string
A boolean flag to filter authorizations based on their active status. When set to true (default), only active authorizations are returned. When false, both active and inactive authorizations are included. This parameter is optional and should be provided as a string (“true” or “false”) in the query.
string
Filters the results based on specific authorization permissions. Valid values are “Send”, “Manage”, and “Sign”. This optional parameter should be provided as a string in the query. Multiple permissions can be specified by repeating the parameter.
string
Specifies the starting position within the total result set for pagination. This optional parameter should be provided as a string representing a positive integer in the query. The special value “thumbnail” can be used to return the page image.
string
An optional filter to search for authorizations based on the email address of the authorized user. This parameter accepts a full email address or a substring of an email address. It should be provided as a string in the query and is case-insensitive.
string
An optional filter to search for authorizations based on the user”s name. This parameter accepts a full name or a substring of a name. It should be provided as a string in the query and does not require wildcard characters for partial matching.
string
A boolean flag to include authorizations for closed (inactive) users. This parameter is only applied when “active_only” is set to false. The default value is true. Provide this optional parameter as a string (“true” or “false”) in the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_USER_CLOUD_STORAGE_PROVIDER_CONFIGURATIONRetrieves the cloud storage provider configuration for a specific cloud storage service (identified by serviceId) for a user within a DocuSign account. This endpoint returns configuration details for the specified provider, such as service name and serviceId. Note: This endpoint primarily works with DocuSign-native cloud storage providers (like Rooms). External OAuth-based providers (Box, Dropbox, GoogleDrive, Salesforce, OneDrive) typically return 400 errors even with valid serviceIds, likely because they require authentication flow completion first. For retrieving all cloud storage providers, use the ‘Retrieve Cloud Storage Provider Configuration’ action instead (GET without serviceId). Users can only access their own cloud storage configuration, even with admin rights.

Input Parameters

string
The unique identifier for the user whose cloud storage configuration is being retrieved. Required parameter. Note that users can only access their own information, and even users with Admin rights cannot access another user”s settings. If not provided, the userId will be automatically extracted from the authentication token.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). Required parameter that specifies which account”s cloud storage configurations to retrieve.
string
required
The numerical identifier for the specific cloud storage service to access. Must be a valid serviceId (e.g., ‘35284455’ for Rooms) obtained from the Retrieve Cloud Storage Provider Configuration action. Note: This endpoint primarily works with DocuSign-native providers (like Rooms). External OAuth providers (Box, Dropbox, GoogleDrive, etc.) may not be supported by this endpoint even with valid serviceIds. Use the list endpoint to get all providers instead.
string
Optional parameter. The URL to which the user will be redirected after authentication with the cloud storage provider. Must be within the docusign.com or docusign.net domains. If provided, this URL will be appended to the authenticationUrl returned in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_USER_INFORMATION_BY_IDRetrieves 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.

Input Parameters

string
Optional parameter. While this parameter can be passed, its effect on this specific endpoint may be limited since the userId path parameter already identifies the specific user.
string
The ID (GUID) of the user whose information you want to retrieve. This must be a valid user ID for the authenticated user (users can only access their own information). If not provided, the action will attempt to use the authenticated user’s ID from the JWT token. Note: Even users with Admin rights cannot access another user’s settings using this endpoint.
string
The external account number (int) or account ID GUID. If not provided, defaults to the authenticated user’s account automatically. This identifies the specific DocuSign account from which to retrieve user information.
string
When set to ‘true’, the response includes additional user information such as account_management_granular information. When not specified or set to any other value, only standard user details are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_USERS_IN_GROUPRetrieves 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.

Input Parameters

string
The maximum number of user results to return in a single response. Valid values range from 1 to 100, with a default of 50 if not specified. This parameter is used in conjunction with “start_position” for pagination. It allows the client to control the amount of data returned in each request, which can be useful for optimizing performance and managing large result sets.
string
required
The unique identifier of the group whose users are being retrieved. This ID is required to specify which group’s membership is being queried. The groupId must be valid and associated with an existing group within the specified account.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account’s groups and users are being accessed. The accountId must be valid and associated with an active DocuSign account.
string
The zero-based index of the first result to return in the response. Used in combination with “count” for pagination. The default value is 0, which starts at the beginning of the result set. This parameter allows the client to request specific pages of results, enabling efficient navigation through large lists of users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_WATERMARK_DETAILS_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). It is required to specify which account”s watermark details should be retrieved. The accountId must be valid and associated with an existing DocuSign account. Example: “7215062” or “f0f9781e-a546-4ca0-aa1c-0e88b3c8fcf8”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_WORKFLOW_STEP_FOR_ENVELOPERetrieves detailed information about a specific workflow step for a DocuSign envelope. This endpoint allows you to fetch comprehensive data about a single step in an envelope’s workflow, including its action, status, delayed routing settings, and recipient routing rules. It’s particularly useful when you need to examine or troubleshoot the configuration of a specific workflow step within an envelope. 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 envelope.

Input Parameters

string
The external account number (integer) or account ID GUID of the DocuSign account. This parameter identifies the specific account context for the envelope workflow step being retrieved.
string
required
The unique identifier (GUID) of the envelope for which the workflow step information is being requested. This should be a valid GUID string, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
The unique identifier for the specific workflow step within the envelope. This ID is required to pinpoint the exact step you want to retrieve information about. It’s typically a GUID or a string identifier assigned by DocuSign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_WORKSPACE_FILERetrieves 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.

Input Parameters

string
required
The unique identifier of the file to retrieve. This is the fileId returned when listing workspace folder contents (using get_workspace_folder_contents action with include_files=true) or when uploading a file. Required.
string
required
The unique identifier of the folder containing the file. Folder IDs can be obtained by listing workspace folder contents. Required.
string
The external account number (int) or account ID GUID. This parameter is automatically populated from the authenticated user’s account information and typically does not need to be provided. If specified, it should be a valid DocuSign account identifier (either numeric ID or GUID format).
string
An optional boolean parameter that determines whether the file should be returned as a downloadable attachment. When set to “true”, the response will include a Content-Disposition header with the filename, making it easier for clients to save the file. When “false” or omitted, the file content is returned without the download header. Valid values are “true” or “false” (as strings). Default is “false”.
string
An optional boolean parameter that specifies whether the file should be converted to PDF format before being returned. When set to “true”, the endpoint will attempt to convert the file to PDF, which can be useful for standardizing document formats or ensuring compatibility. Valid values are “true” or “false” (as strings). Default is “false”. Note that not all file types may be convertible to PDF.
string
required
The unique identifier of the workspace. Workspace IDs can be obtained using the list_workspaces action. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_GET_WORKSPACE_FOLDER_CONTENTSRetrieves 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.

Input Parameters

string
The maximum number of results to return. This optional parameter allows you to limit the number of items in the response. It should be a positive integer as a string (e.g., “10”, “25”). Use in conjunction with “start_position” for pagination. If not specified, the API will return all results.
string
required
The ID of the folder to retrieve contents from. This parameter is required and must be a valid string representing the unique identifier of the workspace folder.
string
The external account number (int) or account ID GUID. This parameter is automatically populated from your DocuSign account if not provided. It identifies the DocuSign account associated with the workspace folder and must be a valid string representing either an integer or a GUID.
string
required
The ID of the workspace containing the folder. This parameter is required and must be a valid string representing the unique identifier of the workspace.
string
When set to “true”, the response includes file information in addition to folder information. When set to “false” or omitted, only folder information is returned. This optional parameter allows you to control whether file details are included in the response.
string
The zero-based index of the result from which to start returning results. This optional parameter is used for pagination in conjunction with “count”. Defaults to “0” if not specified. It should be a non-negative integer as a string (e.g., “0”, “10”, “20”) representing the starting position in the result set.
string
If specified, the response only includes results associated with the provided user ID. This optional parameter allows you to filter the results to show only items related to a specific workspace user. It should be a valid string representing the unique identifier of a workspace user.
string
When set to “true”, the response returns thumbnails for the items. When set to “false” or omitted, thumbnails are not included. This optional parameter allows you to include thumbnail images in the response, which can be useful for visual representation of files.
string
When set to “true”, the response includes information about the sub-folders of the current folder. When set to “false” or omitted, sub-folder information is not included. This optional parameter allows you to control whether sub-folder details are included in the response.
string
When set to “true”, the response includes extended details about the user. When set to “false” or omitted, basic user information is returned. This optional parameter allows you to include additional user information in the response, providing more context about the users associated with the workspace items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_INITIATE_NEW_CHUNKED_UPLOADInitiates 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.

Input Parameters

string
A base64-encoded representation of the content that is used to upload the file. Maximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account for which the chunked upload is being initiated. This parameter is required and must be provided in the path of the API request.
string
The ID of the chunked upload. Note: This property is ignored in requests, and overridden with an auto-generated value in responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_ALL_TEMPLATESGets 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.

Input Parameters

string
The maximum number of results to return. Default limit is 2,000 templates if not specified
string
Sort order: asc (A to Z) or desc (Z to A)
string
Comma-separated list of additional template attributes to include: powerforms, documents, folders, favorite_template_status, advanced_templates, recipients, custom_fields, notifications
string
End of search date range in UTC DateTime format. Defaults to current date if null
string
The ID of the user
string ("name" | "modified" | "used")
Property to order results by: name, modified, or used
string
Start of the search date range. Only returns templates created on or after this date/time
string
required
The external account number (int) or account ID GUID
string
A comma-separated list of folder ID GUIDs
string
When true, downloads the templates listed in template_ids as JSON definitions in a zip file. Only works with template_ids parameter
string
Text to search template names. Max 48 characters
string
Filter templates: owned_by_me, shared_with_me, or all
string
The type of folder to return templates for. Valid values: templates, templates_root, recylebin
string
When true, only includes templates shared by the user. When false, only returns templates not shared by the user
string
Comma-separated list of template IDs to download. Only valid when is_download is true
string
End of date range. Returns templates used or edited up to this date/time. Defaults to current date
string
Comma-separated list of additional properties to search: sender, recipients, envelope
string
Zero-based index of the result from which to start returning results. Default is 0
string
Start of date range. Returns templates used or edited on or after this date/time
string
Lists templates modified before this date
string
Lists templates modified before this date
string
Lists templates created on or after this date
string
Lists templates modified on or after this date
string
When true, retrieves templates that have been permanently deleted. Default is false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_BILLING_INVOICESRetrieves 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.

Input Parameters

string
An optional query parameter specifying the end date for the invoice retrieval range. The date should be provided in a standard date/time format (e.g., ISO 8601: YYYY-MM-DDTHH:mm:ssZ). If omitted, the default behavior is to include invoices up to the current date. This parameter, used in conjunction with from_date, allows for precise control over the time range of invoices to be retrieved.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve invoices. If not provided, the account ID will be automatically determined from the authenticated user’s context. This should be a valid DocuSign account identifier, typically a string of numbers or a UUID format.
string
An optional query parameter specifying the start date for the invoice retrieval range. The date should be provided in a standard date/time format (e.g., ISO 8601: YYYY-MM-DDTHH:mm:ssZ). If omitted, the default behavior is to include invoices from 365 days prior to the current date. This parameter allows for precise control over the time range of invoices to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_BRANDS_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The external account number (int) or account ID GUID. This is a required path parameter that uniquely identifies the DocuSign account for which you want to retrieve brand information. It must be a valid string representing either an integer account number or a GUID.
string
An optional query parameter that, when set to “true”, includes the logos associated with each brand in the response. This boolean parameter allows you to retrieve the logo URIs along with other brand details. If not specified or set to “false”, logo information will be omitted from the response to reduce payload size.
string
An optional query parameter that, when set to “true”, excludes distributor brand information from the response. This boolean parameter allows you to filter out distributor-specific branding details if they are not relevant to your use case. If not specified or set to “false”, distributor brand information will be included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_BULK_SEND_BATCH_SUMMARIESRetrieves 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.

Input Parameters

string
The maximum number of results to return in a single API call. Valid values range from 1 to 100, with a default of 100 if not specified. Use in conjunction with “start_position” for pagination of large result sets.
string
Filter the results based on the batch status. Must be one of: “all” (default, returns batches of all statuses), “failed” (only failed batches), “sent” (only successfully sent batches), or “queued” (batches waiting to be processed).
string
The end date for filtering batches in UTC DateTime format (e.g., “2023-04-30T23:59:59Z”). Only batches created on or before this date will be included in the results. If not provided, it defaults to the current date and time.
string
An optional parameter to filter batches by a specific user ID. This can be used to retrieve only the batches created or associated with a particular user in the DocuSign account.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account”s bulk send batches should be retrieved.
string
An optional comma-separated list of specific batch IDs to query. Use this parameter when you need to retrieve information about particular batches. For example: “batch1,batch2,batch3”.
string
The start date for filtering batches in UTC DateTime format (e.g., “2023-04-01T00:00:00Z”). Only batches created on or after this date will be included in the results. If not provided, no start date filtering is applied.
string
A string to search for within the batch information. This can be used to find batches with specific names or other matching text in their details.
string
The zero-based index of the first result to return. Use this parameter in combination with “count” for pagination. For example, to get the second page of results with 50 items per page, set start_position to 50 and count to 50. The default value is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_CLOUD_STORAGE_ITEMSRetrieves a list of items (files and folders) from a specific folder in a cloud storage provider integrated with DocuSign. This endpoint enables browsing and searching cloud storage contents directly within DocuSign, making it easier to select documents for signing workflows. Prerequisites: - The cloud storage provider must be connected and authenticated for the user - Valid serviceId and folderId must be provided from the connected storage Supported cloud storage providers include: Box, Dropbox, Google Drive, OneDrive, Salesforce, and DocuSign Rooms. The endpoint supports pagination, sorting, and text-based filtering of results. Users can only access their own cloud storage items, ensuring data privacy and security.

Input Parameters

string
An optional parameter that sets the maximum number of results to return in the response. Use this in conjunction with start_position for pagination. If not specified, the default value is 25.
string
An optional parameter that determines the order in which to sort the results. Valid values are “asc” for ascending order and “desc” for descending order. Use this to control the sorting direction of the returned items.
string
The ID of the user whose cloud storage items are being accessed. If not provided, it will be automatically extracted from the authentication token. Important: Users can only access their own information - even users with Admin rights cannot access another user’s settings or data.
string
required
The ID of the folder in the cloud storage service from which to list items. This is a required parameter and specifies the starting point for item retrieval. The format of this ID may vary depending on the cloud storage provider.
string
An optional parameter that specifies the file attribute to use for sorting the results. Valid values are “modified” (sort by last modified date) and “name” (sort alphabetically by name). Use this in combination with the “order” parameter to fully control result sorting.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. If not provided, it will be automatically extracted from the authentication token.
string
required
The ID of the cloud storage service to access. This is a required parameter. It can be specified either as the service name (e.g., “Box”) or the numerical serviceId (e.g., “4136”). This parameter determines which integrated cloud storage provider to query.
string
An optional parameter used to search for specific text within the item names or content. Use this to filter the results based on a search query, helping to locate specific files or folders quickly.
string
An optional parameter that sets the zero-based index of the first result to return. Use this in combination with “count” for implementing pagination. The default value is 0, which starts the list from the beginning.
string
An optional parameter specifying the file path to a specific cloud storage folder. Use this to narrow down the retrieval to a particular subfolder within the main folder identified by folderId.
string
An optional parameter that allows specifying folder IDs in plain text. This is particularly useful for rooms functionality. Multiple folder IDs can be provided as a comma-separated list, allowing retrieval of items from multiple folders in a single request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_ENVELOPE_AND_DOCUMENT_CUSTOM_FIELDSRetrieves all account-level custom fields defined for a DocuSign account. Account custom fields are envelope custom fields that can be applied across multiple envelopes, enabling account administrators to group, track, and manage envelopes consistently. The response includes two types of custom fields: - Text custom fields: Free-form text input fields - List custom fields: Dropdown fields with predefined options Each custom field contains metadata such as field ID, name, visibility settings, required status, and current values. This is useful for: - Auditing existing custom field configurations - Reviewing available custom fields before creating envelopes - Preparing for custom field updates or migrations - Understanding envelope metadata structure for reporting Note: This endpoint retrieves account-level custom field definitions, not the values set on individual envelopes. To get custom field values for a specific envelope, use the envelope custom fields endpoint instead.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). This parameter is required and must be provided in the path of the API request. It is automatically populated from your authentication context if not provided explicitly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_ENVELOPE_ATTACHMENTS_BY_ENVELOPE_IDRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your authenticated DocuSign account and typically does not need to be provided manually.
string
required
The unique identifier (GUID) for the envelope whose attachments are being requested. This parameter is required and must be in the format of a valid GUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. The envelopeId is typically obtained from a previous envelope creation or listing operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_OAUTH_USERINFORetrieves the authenticated user’s DocuSign OAuth profile and account information, including account IDs and base URIs for subsequent API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_PAST_DUE_INVOICESRetrieves 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.

Input Parameters

string
The DocuSign account ID (GUID format). This parameter is automatically populated from your authenticated account and typically does not need to be provided manually. Example: ‘a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_PAYMENT_GATEWAY_ACCOUNTS_INFORetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID (a string). When not provided, the system will automatically use the account ID associated with your authentication. You can explicitly provide a specific account ID if you need to access a different account that you have access to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_REGISTERED_NOTARY_JURISDICTIONSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_SIGNATURE_PROVIDERS_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is required to specify which account’s signature providers should be retrieved. For example: “12345” or “a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_USERS_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
Specifies the maximum number of results to return in the response. Must be an integer between 1 and 100. Use in conjunction with “start_position” for pagination of results. If omitted, the API will return all available results up to the maximum limit.
string
Filters results based on the email address associated with the user that you want to return. Note: You can use either this parameter or the email_substring parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.
string
Filters the results by user account status. Accepts a comma-separated list of statuses. Valid values are: “ActivationRequired”, “ActivationSent”, “Active”, “Closed”, “Disabled”. For example, “Active,Disabled” would return only active and disabled users.
string
Filters results based on one or more group IDs.
string
The external account number (int) or account ID GUID. This parameter is required to specify the DocuSign account for which to retrieve the list of users.
string
When true, the response includes the login status of each user.
string
Return user records excluding the specified group IDs.
string
Specifies the zero-based index of the first result to return. Use in conjunction with “count” for pagination of results. The default value is 0 if omitted. For example, to get results 50-74, use start_position=50 and count=25.
string
A boolean flag that, when set to true, includes full user information in the response. This includes detailed custom settings for each user in the account. If omitted, the default value is false, providing basic user information.
string
Filters the results based on a fragment of an email address. For example, entering “gmail.com” would return all users with Gmail addresses. This parameter does not use wildcard characters. Note that this parameter cannot be used in conjunction with the “email” parameter.
string
When true, return only users in domains claimed by your organization. The default value is false.
string
Filters the user records returned by the user name or a sub-string of user name.
string
When true, returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is false.
string
When true, the response includes the userSettings object data in CSV format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_WORKSPACE_FILE_PAGESRetrieves 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.

Input Parameters

string
The number of dots per inch (DPI) for the resulting images. This optional parameter allows customization of the image resolution. Valid values range from 1 to 310 DPI. If not specified, the default value is 94 DPI. Higher DPI values result in higher quality images but larger file sizes.
string
The maximum number of results to return. This optional parameter allows you to limit the number of page results in a single request. Use in conjunction with “start_position” for pagination. Must be a positive integer. If not specified, the API will return all available results.
string
required
The ID of the file to be retrieved. This parameter is required and uniquely identifies the specific file within the workspace folder. It must be a valid string representing the file”s unique identifier in the DocuSign system.
string
required
The ID of the folder containing the file. This parameter is required and specifies the unique identifier of the folder within the workspace where the file is located. It must be a valid string representing the folder”s ID in the DocuSign system.
string
The external account number (int) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the workspace. It must be a valid string representing either an integer account number or a GUID.
string
Sets the maximum width of the returned images in pixels. This optional parameter allows you to limit the horizontal size of the returned images. Must be a positive integer. If not specified, the images will be returned at their original width or scaled proportionally based on max_height if it”s set.
string
Sets the maximum height of the returned images in pixels. This optional parameter allows you to limit the vertical size of the returned images. Must be a positive integer. If not specified, the images will be returned at their original height or scaled proportionally based on max_width if it”s set.
string
required
The ID of the workspace containing the file. This parameter is required and identifies the specific workspace where the file is stored. It must be a valid string representing the workspace”s unique identifier in the DocuSign system.
string
The zero-based index of the result from which to start returning results. This optional parameter is used for pagination in conjunction with “count”. Must be a non-negative integer. The default value is 0, which starts from the beginning of the result set. Use this parameter to skip a certain number of results, useful when retrieving subsequent pages of data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LIST_WORKSPACESLists DocuSign workspaces and associated information for the account resolved from the connected user’s account information. The response can include result-set position and size information; the tool does not expose pagination controls.

Input Parameters

string
The external account number (integer) or account ID GUID. This parameter is required and must be provided in the path of the API request. It identifies the specific DocuSign account for which the workspaces are being retrieved. The value should be a valid DocuSign account identifier, either in the form of a numeric ID or a GUID (Globally Unique Identifier) string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LOCK_AN_ENVELOPE_FOR_EDITINGThis 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.

Input Parameters

string
The type of lock. Currently edit is the only supported type.
string
The external account number (integer) or account ID GUID. This parameter is required to identify the DocuSign account associated with the envelope to be locked. It must be provided in the path of the API request.
string
required
The envelope”s GUID (Globally Unique Identifier). This is a required parameter that uniquely identifies the envelope to be locked. It must be provided in the path of the API request. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
string
When true, a scratchpad is used to edit information.
string
The password for the template. If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the templatePassword to save the changes.
string
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_LOCK_TEMPLATE_FOR_EDITINGLocks a specified DocuSign template for editing to prevent concurrent modifications. This endpoint acquires an exclusive lock on a template, ensuring that only the lock holder can make changes during the lock period. The response includes a lockToken that must be included in the X-DocuSign-Edit header for all subsequent update operations on the locked template. Key features: - Returns a lockToken for exclusive editing access - Prevents race conditions in collaborative environments - Lock automatically expires after the specified duration - Default lock duration is typically 300 seconds (5 minutes) Use this action before modifying a template to ensure data integrity and prevent conflicts with other users attempting to edit the same template simultaneously.

Input Parameters

string
The type of lock. Currently edit is the only supported type.
string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required and must be provided in the path of the request URL.
string
required
The unique identifier for the template to be locked. This ID is required and must be provided in the path of the request URL. It specifies which template within the account should be locked for editing.
string
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
string
When true, a scratchpad is used to edit information.
string
The password for the template. If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the templatePassword to save the changes.
string
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_MODIFY_ACCOUNT_NOTIFICATION_SETTINGSUpdates the default email notification settings for envelope senders and signers in a DocuSign account. This endpoint allows customization of when and what type of notifications users receive regarding envelope status changes (e.g., signed, declined, completed), comments, and other events. Use this action when you need to: - Configure when senders receive notifications (e.g., when signers change, delivery fails) - Configure when signers receive notifications (e.g., envelope activation, completion) - Set comment notification preferences - Update notification settings for specific events like document purges or offline signing Note: These are account-level default settings. Individual envelope notification settings can override these defaults when sending specific envelopes.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID (a string). It is automatically retrieved from your authentication context if not provided. For example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, the sender receives notification that a recipient viewed the envelope.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
string
When true, the user receives notification that document markup has been activated.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
string
When true, the user receives notification that document markup has been activated.
string
When true, the user receives only comments that mention their own user name.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notification that he or she is a member of the signing group.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the sender receives an email notification when clickwrap responses reach their limit.
string
When true, the sender receives an email notification when PowerForm responses reach their limit.
string
When true, the user receives only comments that mention their own user name.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notification that he or she is a member of the signing group.
string
When true, the sender receives an email notification when clickwrap responses reach their limit.
string
When true, the sender receives an email notification when PowerForm responses reach their limit.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the sender receives notification that a recipient viewed the envelope.
string
When true, the sender receives an email notification if the signer changes.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_MODIFY_TAB_SETTINGS_FOR_ACCOUNTThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an integer (external account number) or a GUID (account ID). If not provided, it will be automatically retrieved from your authentication credentials.
string
When true, account users can set a tab order for the signing process. Note: Only Admin users can change this setting.
string
When true, URI (hyperlink) tabs are enabled.
string
When true, draw tabs (signature and initial drawing fields) are enabled.
string
When true, list tabs are enabled.
string
When true, note tabs are enabled.
string
Reserved for Docusign.
string
When true, text tabs are enabled.
string
When true, radio button tabs are enabled.
string
When true, tab locking is enabled. Note: Only Admin users can change this setting.
string
When true, prefill tabs are enabled, allowing tabs to be pre-populated with data.
string
Reserved for Docusign.
string
When true, checkbox tabs are enabled.
string
When true, data labels are enabled. Note: Only Admin users can change this setting.
string
When true, setting character limits for input fields is enabled.
string
When true, numerical tabs are enabled for numeric data entry fields.
string
When true, regular expressions are enabled for tabs that contain data fields.
string
When true, calculated fields are enabled for tabs.
string
When true, saving custom tabs is enabled.
string
When true, shared custom tabs are enabled.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, approve and decline tabs are enabled.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, agreement detail tabs are enabled for displaying agreement terms.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_POST_PAYMENT_TO_INVOICEPosts a payment to past due invoices for a DocuSign account. This action applies a payment amount to settle outstanding invoice balances and creates a payment transaction record. Before using this action, retrieve past due invoice information using the ‘List Past Due Invoices’ action to get the total balance due and verify that ‘paymentAllowed’ is true. The payment amount must exactly match the ‘pastDueBalance’ value from that response. This action requires account administrator privileges and the ‘billing:write’ OAuth scope. It is only available for production accounts with billing features enabled - demo accounts will return a 400 Bad Request error with ‘BILLING_PLAN_ERROR’ indicating the payment manager is blocked. Use this when you need to programmatically settle overdue DocuSign account invoices through the REST API.

Input Parameters

string
The DocuSign account ID (GUID format). This parameter is automatically populated from your authenticated account and typically does not need to be provided manually. Example: ‘a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6’.
string
required
The payment amount to apply to past due invoices. This must be a decimal string (e.g., ‘100.00’, ‘250.50’) and should match the pastDueBalance value retrieved from the List Past Due Invoices endpoint. The value will be applied to settle outstanding invoice balances. Example: ‘150.00’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_PURCHASE_ADDITIONAL_ENVELOPESThis 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.

Input Parameters

string
The total amount of the purchase.
string
The name of the client application making the purchase.
string
The platform of the client application (e.g., iOS, Android, Web).
string
The quantity of envelopes to add to the account.
string
required
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the envelopes are being purchased. This parameter is required and must be provided in the path of the API request. It ensures that the purchase is associated with the correct account in the DocuSign system.
string
The Product ID from the AppStore.
string
The name of the app store where the purchase was made (e.g., Apple, Google Play).
string
The encrypted Base64 encoded receipt data.
string
The ISO 4217 currency code for the purchase (e.g., USD, EUR, GBP). See https://en.wikipedia.org/wiki/ISO_4217 for the complete list.
string
Specifies the Transaction ID from the AppStore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_QUEUE_DOWNGRADE_BILLING_PLAN_REQUESTQueues a downgrade request for a DocuSign account’s billing plan. This action initiates the process of changing an account to a lower-tier or less expensive billing plan without immediately applying the change. Use this action when an account administrator needs to: - Downgrade from a paid plan to a free or lower-tier plan - Reduce subscription costs by moving to a plan with fewer features - Apply promotional pricing or discounts during the downgrade The downgrade is queued for processing and typically takes effect at the end of the current billing period. The response includes the new plan details, effective date, and remaining days in the current billing cycle. Note that billing plan management operations typically require administrator-level permissions and may not be available on demo or restricted accounts.

Input Parameters

string
required
The external account number (int) or account ID GUID for which to queue the downgrade request. You can use the shorthand ‘me’ to refer to your authenticated account, which will be automatically resolved to your account ID.
string
Optional promotional code that can be applied to the downgrade request.
string
Optional sale discount amount or percentage to be applied.
string
Optional field specifying the type of sale discount (e.g., percentage, fixed amount).
string
Optional field that specifies the type of downgrade event. Can be omitted if not applicable.
string
Reserved for Docusign.
array
Reserved for Docusign.
string
DocuSign’s unique identifier for the billing plan to downgrade to. This ID can be obtained from the billing plans list or account billing plan endpoints.
string
Specifies the ISO 4217 currency code for the account.
array
Reserved for Docusign.
array
List of recipient domains to be configured for the downgraded plan. Each domain specifies restrictions on which email domains can receive envelopes.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REGISTER_CURRENT_USER_AS_NOTARYThis 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.

Input Parameters

string
The date the this object was created.
string
When true, this notary is searchable.
string
The creation date of the account in UTC timedate format.
string
A URI containing the user ID.
string
The user”s email address.
string
The title of the user.
string
The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user”s settings.
string
The name of the user”s company.
string
When true, the user is an administrator.
string
The user”s job title.
string
The user”s last name. Maximum Length: 50 characters.
string
The user”s encrypted password hash.
string
The name of the user.
string
The type of user, for example CompanyUser.
string
The user”s first name. Maximum Length: 50 characters.
array
A list of the group information for groups to add the user to. Use UserGroups: listGroups to get information about groups. When setting a user”s group, only the groupId is required.
string
This property has been deprecated.
string
string
The user”s middle name. Limit: 50 characters.
string
The suffix for the user”s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
string
Status of the user”s account. One of: - ActivationRequired - ActivationSent - Active - Closed - Disabled
string
The two-letter code for the user”s country.
string
Boolean value that indicates whether the user is currently logged in or not.
string
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
array
The name/value pair information for the user custom setting.
string
The UTC DateTime when the item was created.
boolean
string
The URL for retrieving the user”s profile image.
string
The default account ID associated with the user.
string
A fax number associated with the address, if one is available.
string
The URI for retrieving the image of the user”s initials.
string
When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
string
A fax number associated with the address, if one is available.
string
The user”s city. Maximum length: 40 characters.
string
An endpoint URI that you can use to retrieve the user”s signature image.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
If password expiration is enabled, the date-time when the user”s password expires.
string
A phone number associated with the address.
string
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following these steps.
string
Access code provided to the user to activate the account.
string
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
string
The user”s country. Maximum length: 50 characters.
string
The user”s locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
string
The user”s country. Maximum length: 50 characters.
array
Object representing the user”s custom Connect configuration.
string
A brief message describing the error condition.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
The name of the account permission profile. Example: Account Administrator
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
When true, this user can use the bulk send feature for the account.
string
string
The code associated with the error condition.
string
The user”s postal code. Maximum length: 20 characters.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The user”s postal code. Maximum length: 20 characters.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
Reserved for Docusign.
string
When true, daylight savings time is in effect for this user”s time zone.
string
The date and time that the user was added to the account.
string
The date on which this user record was last modified.
string
Note referencing the page that modified this user record.
string
The custom DateTime format setting for this user.
string
Indicates the specified Vaulting mode: - none - estored - electronic_original
string
The date and time that the user”s profile was last modified.
string
Indicates the Power Form mode setting for the user: - none - admin - user
string
The user”s state or province. Maximum length: 40 characters.
string
When true, specifies that an additional activation email be sent if user”s log on fails before the account is activated.
string
When true, this user can export authoritative copy for the account.
string
When true, Vaulting is enabled for the account.
string
The timezone offset for the user. Valid values: - tz_01_afghanistan - tz_02_alaskan - tz_03_arab - tz_04_arabian - tz_05_arabic - tz_06_argentina - tz_07_atlantic - tz_08_aus_central - tz_09_aus_eastern - tz_10_azerbaijan - tz_11_azores - tz_12_bangladesh - tz_13_canada_central - tz_14_cape_verde - tz_15_caucasus - tz_16_central_australia - tz_17_central_america - tz_18_central_asia - tz_19_central_brazilian - tz_20_central_europe - tz_21_central_european - tz_22_central_pacific - tz_23_central - tz_24_central_mexico - tz_25_china - tz_26_dateline - tz_27_east_africa - tz_28_east_australia - tz_29_east_europe - tz_30_east_south_america - tz_31_eastern - tz_32_egypt - tz_33_ekaterinburg - tz_34_fiji - tz_35_fli - tz_36_georgian - tz_37_gmt - tz_38_greenland - tz_39_greenwich - tz_40_gtb - tz_41_hawaiian - tz_42_india - tz_43_iran - tz_44_israel - tz_45_jordan - tz_46_kaliningrad - tz_47_kamchatka - tz_48_korea - tz_49_magadan - tz_50_mauritius - tz_51_mid_atlantic - tz_52_middle_east - tz_53_montevideo - tz_54_morocco - tz_55_mountain - tz_56_mountain_mexico - tz_57_myanmar - tz_58_north_central_asia - tz_59_namibia - tz_60_nepal - tz_61_new_zealand - tz_62_new_foundland - tz_63_north_asia_east - tz_64_north_asia - tz_65_pacific_sa - tz_66_pacific - tz_67_pacific_mexico - tz_68_pakistan - tz_69_paraguay - tz_70_romance - tz_71_russian - tz_72_sa_eastern - tz_73_sa_pacific - tz_74_sa_western - tz_75_samoa - tz_76_se_asia - tz_77_singapore - tz_78_south_africa - tz_79_sriLanka - tz_80_syria - tz_81_taipei - tz_82_tasmania - tz_83_tokyo - tz_84_tonga - tz_85_turkey - tz_86_ulaanbaatar - tz_87_us_eastern - tz_88_us_mountain - tz_89_venezuela - tz_90_vladivostok - tz_91_west_australia - tz_92_west_central_africa - tz_93_west_europe - tz_94_west_asia - tz_95_west_pacific - tz_96_yakutsk
string
The user”s state or province. Maximum length: 40 characters.
string
When true, this user can send envelopes on the account.
string
When true, this user can sign envelopes.
string
When false, this user can apply tabs to documents during the sending experience.
array
Information about the seals associated with this user.
string
string
When true, the API returns suggested tabs for documents for this user.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is an administrator for the account.
string
When true, this user can use a scratchpad to edit information.
string
string
True if the user can manage users.
string
When true, this user can manage templates for the account.
string
When true, this user can send API requests on the account.
string
True if the user can manage administrators.
string
string
string
When true, this user can send envelopes “on behalf of” other users through the API.
string
When true, this user can access the Other Actions menu.
string
When true, the system notifies this user before applying a matching template.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
True if the user can manage sharing.
string
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
string
When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
string
When true, indicates that this user can send envelope-specific API requests on the account.
string
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create and manage Clickwraps.
string
When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
string
When true, this user is prohibited from uploading documents during sending.
string
True if the user can manage reporting.
string
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
When true, a new template is created each time the user sends an envelope.
string
string
True if the user can manage signing groups.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can participate in envelope transfers on the account.
string
string
When true, this user can use the signing attachments feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can edit the shared address book for the account.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
True if the user can manage account security settings.
string
True if the user can manage account settings.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users see template matching functionality.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can include supplemental documents.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the sender receives notification that a recipient viewed the envelope.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user receives notifications when envelopes are viewed.
string
Percentage used when matching templates.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user must both view and accept supplemental documents.
string
When true, this user must view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives notification that document markup has been activated.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, this user must accept supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The answer to the first forgotten password challenge question.
string
The answer to the second forgotten password challenge question.
string
The answer to the third forgotten password challenge question.
string
The answer to the fourth forgotten password challenge question.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives only comments that mention their own user name.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notification that he or she is a member of the signing group.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
The first challenge question presented to a user who has forgotten their password.
string
The second challenge question presented to a user who has forgotten their password.
string
The third challenge question presented to a user who has forgotten their password.
string
The fourth challenge question presented to a user who has forgotten their password.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user gets supplemental documents when downloading documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REMOVE_BULK_SEND_LISTDeletes a specific bulk send list from the authenticated DocuSign account using its list ID. Deletion is irreversible, does not affect envelopes already sent using the list, and may return summaries of remaining lists.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your connected account and specifies which account’s bulk send list should be deleted. It can be either a numeric value or a GUID string.
string
required
The globally unique identifier (GUID) of the bulk send list to be deleted. This parameter is required and is created when a new bulk send list is initially posted. It must be provided to specify exactly which bulk send list should be removed from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REMOVE_GROUP_SHARING_PERMISSIONS_FOR_TEMPLATERemoves 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.

Input Parameters

array
A collection group objects containing information about the groups.
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
The unique identifier for the DocuSign account. This can be either the account number (integer) or the account ID GUID (string). It is required to specify which account the template belongs to. For example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier for the template from which group sharing permissions will be removed. This is a required string parameter that specifies the exact template to be affected. For example: “template-123-abc-456-def”.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
string
required
Specifies the part of the template to modify. Currently, the only valid value is “groups”, which indicates that the operation will affect group sharing permissions. This parameter is required and must be set to “groups” for this endpoint to function correctly.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REMOVE_TEMPLATES_FROM_FAVORITESRemoves one or more templates from the authenticated connection’s account favorites. Supply a list of template IDs; the response can include updated templates and error details.

Input Parameters

string
required
The external account number (integer) or account ID GUID. This parameter is required and must be provided in the path of the API request. It identifies the specific DocuSign account from which the templates will be removed as favorites.
array
Array of template objects to remove from favorites. Each object should contain at minimum the templateId field.
string
A brief message describing the error condition. (Response field, do not include in request)
integer
The number of templates successfully updated by the call. This property is read-only and returned in the response. Do not include in request.
string
The code associated with the error condition. (Response field, do not include in request)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REMOVE_USER_SIGNATURE_INFORMATIONRemoves a user’s signature information from DocuSign by signature ID or name. If no user ID is supplied and user information does not provide one, the tool may select the first user returned by the account’s user list.

Input Parameters

string
The ID of the user whose signature information is being removed. This parameter is required and must match the authenticated user’s ID. Users can only access and modify their own signature information, regardless of their permissions level. The userId is typically a unique string or GUID assigned by DocuSign, for example: “u1234567-89ab-cdef-0123-456789abcdef”. If not provided, the userId will be automatically extracted from the authentication token.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account. If not provided, it will be automatically retrieved from the authenticated user’s account information. For example: “12345” or “a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8”.
string
required
The unique identifier for the signature to be removed. This parameter is required and can be either the signature ID or the signature name. Using the signature ID is strongly recommended to avoid URL encoding issues. If using a signature name that contains spaces or special characters, ensure it is properly URL encoded. For example, a signature ID might look like “s1g2n3-4567-89a0-b1c2d3e4f5g6”, while a signature name could be “John_Doe_Signature” or “John%20Doe%20Signature” (URL encoded).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REPUBLISH_CONNECT_DATA_FOR_ENVELOPERepublishes 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. If not provided, it will be automatically populated from the authenticated user’s account information. Only specify this parameter if you need to target a different account than the default.
string
required
The globally unique identifier (GUID) for the specific envelope you want to republish Connect information for. This is a required parameter and must be in the format of a 32-character string, typically hyphenated into five groups. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. Ensure you provide the correct envelopeId to target the intended document or set of documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REPUBLISH_CONNECT_INFO_FOR_ENVELOPESRepublishes Connect webhook information for multiple DocuSign envelopes. Queues envelopes for Connect webhook republishing to retry failed webhook deliveries. When DocuSign Connect fails to deliver webhook events to your endpoint, envelopes are added to a failure queue. This action manually triggers republishing attempts. Use cases: Retry webhook delivery after temporary endpoint issues, resend envelope events after fixing your webhook endpoint, or recover from missed notifications. Note: Only envelopes in the Connect failure queue can be republished. Envelopes not in the failure queue return status ‘Fail’ with ‘Envelope Id not found in failure queue’ (expected behavior). Use Connect failure logs API to identify envelopes needing republishing. Requires: Connect enabled on account, administrator access with connect:read and connect:write scopes.

Input Parameters

string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This is typically auto-populated from your authentication credentials and specifies which account’s Connect retry queue will be processed.
array
Array of envelope GUIDs to republish Connect information for. Each envelope ID should be a valid GUID format (e.g., ‘93be49ab-1234-5678-90ab-f752070d71ec’). The API will attempt to republish Connect webhook data for these envelopes. Note: Envelopes that are not in the Connect failure queue will return a ‘Fail’ status with message ‘Envelope Id not found in failure queue.’ This is expected behavior for envelopes that haven’t failed Connect delivery.
string
Controls whether the republish operation is synchronous or asynchronous. Must be set to ‘false’ (asynchronous mode). Synchronous mode is not supported by this endpoint and will result in API errors if set to any other value. In asynchronous mode, the API queues the republish requests and processes them in the background.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_BILLING_PLANRetrieves 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.

Input Parameters

string
required
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is a required parameter used to specify which account’s billing plan information should be retrieved. The accountId must be valid and associated with an existing DocuSign account.
string
Optional. Set to “true” to include additional metadata fields in the response: “canUpgrade” (whether account can be upgraded), “renewalStatus” (renewal state), and “supportedCountries” (array of supported billing countries). Set to “false” or omit to exclude this metadata.
string
Optional. Set to “true” to include the tax exemption ID in the response if the account has one, or “false” to exclude it. When omitted, tax exempt ID is not included. Useful for accounts with tax-exempt status.
string
Optional. Set to “true” to include successor plan information (available upgrade plans) in the response, or “false” to exclude it. When omitted, successor plans are not included. Use this to discover potential upgrade paths for the billing plan.
string
Optional. Set to “true” to include downgrade plan options and information in the response, or “false” to exclude it. When omitted, downgrade information is not included. Useful for showing available lower-tier billing plans.
string
Optional. Set to “true” to include credit card payment information in the response, or “false” to exclude it. Default behavior (when omitted) excludes credit card details. Use this to control whether sensitive payment information is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_BRAND_INFORMATIONRetrieves 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.

Input Parameters

string
required
The unique identifier for the specific brand within the account. This ID is used to retrieve information about a particular brand. It must be a non-empty string representing a valid brand ID within the specified account. This parameter is required to target the correct brand for information retrieval.
string
The unique identifier for the DocuSign account. This can be either the account”s external number (an integer) or the account ID GUID. It is automatically populated from authentication metadata if not provided. The value must be a non-empty string representing a valid DocuSign account identifier.
string
An optional query parameter that, when set to “true”, includes the URIs for the logos associated with the brand in the response. This provides access to the visual elements of the brand. The value must be a string, either “true” or “false”. If not specified, it defaults to “false”.
string
An optional query parameter that, when set to “true”, includes the landing pages and links associated with the brand in the response. This allows for a more comprehensive view of the brand”s external facing elements. The value must be a string, either “true” or “false”. If not specified, it defaults to “false”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_ENVELOPE_PURGE_CONFIGRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). You can also use ‘self’ to refer to the authenticated user’s default account. Defaults to ‘self’ for convenience.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_FAVORITE_TEMPLATESRetrieves the list of favorite templates for a DocuSign account. Returns an array of template IDs and the dates they were marked as favorites. This is useful for identifying which templates a user has marked for quick access. Note: This endpoint only returns template IDs and favorited dates, not the full template details. Use the List All Templates or Get Template actions to retrieve complete template information. Beta API: May be subject to changes in future versions.

Input Parameters

string
The unique identifier for the DocuSign account. Can be the external account number (e.g., ‘12345’) or account ID GUID (e.g., ‘a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p’). If not provided, defaults to the authenticated user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_INFORMATION_FOR_SPECIFIED_ACCOUNTRetrieves account information for the authenticated user’s first DocuSign account, including account identifiers, plan details and billing-related information. Account settings can be requested, but the response schema does not define their individual properties.

Input Parameters

string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required to specify which account”s information should be retrieved. It must be a valid account identifier within your organization”s DocuSign environment.
string
An optional boolean parameter that determines whether to include detailed account settings in the response. When set to true, the response will contain extensive configuration information about the account. When false or not provided, the response will exclude these detailed settings. The default value is false. Use this parameter when you need comprehensive information about the account”s configuration, including features, permissions, and user experience settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_PROVISIONING_INFORetrieves the account provisioning information for a DocuSign account. This endpoint returns crucial setup and configuration details including default connection IDs, billing plan identifiers, distributor codes, password policy rules, and promotional information. Use this action when you need to: - Verify account provisioning configuration - Retrieve default billing plan information - Check password policy requirements - Get distributor-related settings The account ID is automatically populated from your authentication credentials. This is a read-only endpoint that retrieves configuration data without making any modifications to the account. Returns provisioning details such as defaultConnectionId, defaultPlanId, distributorCode, passwordRuleText, and planPromotionText.

Input Parameters

string
The unique identifier for the DocuSign account. This parameter is automatically populated from your authentication credentials if not provided. You can use either the external account ID (integer) or the account GUID. Example: “12345” or “a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_SEAL_PROVIDERSRetrieves electronic seal providers (eSeals) available for a DocuSign account. Electronic seals certify document origin and integrity using a legal entity identity rather than an individual signature. Returns seal identifiers and names for all configured seals in the account. Use this to display available seal options or implement automated seal application workflows. IMPORTANT: Electronic Seals is a premium feature requiring provisioning by DocuSign Sales. Not available in standard developer sandboxes. A 401 error indicates the feature is not enabled. Contact DocuSign Sales to enable. Note: This retrieves seal information only; applying seals requires separate API calls.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is automatically populated from your authentication credentials. The account must have the Electronic Seals feature enabled to use this endpoint. Example formats: “12345” (account number) or “a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6” (account ID GUID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_SETTINGS_INFORMATIONRetrieves account settings for the authenticated user’s first resolved DocuSign account, including account preferences, feature toggles, security settings, UI options, and compliance-related configurations.

Input Parameters

string
The external account number (int) or account ID GUID. This parameter is required to identify the specific DocuSign account for which the settings information is being retrieved. It must be a valid account identifier within the DocuSign system. The value can be either an integer representing the external account number or a GUID (Globally Unique Identifier) string representing the account ID. For example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_SIGNING_GROUPSRetrieves signing groups for the authenticated user’s first resolved DocuSign account, with filtering by group type and optional member details.

Input Parameters

string
The unique identifier for the DocuSign account from which to retrieve signing groups. This can be either an external account number (integer) or an account ID GUID. Required parameter that must be provided in the path of the API request. Format: string.
string
Optional query parameter used to filter the returned signing groups by type. Valid values are “sharedSigningGroup”, “privateSigningGroup”, or “systemSigningGroup”. If not specified, all group types will be returned. Use this parameter to narrow down the results to specific types of signing groups based on your needs.
string
Optional query parameter that determines whether to include detailed information about the members of each signing group in the response. Set to “true” to include member details, or omit or set to “false” to exclude them. This allows for more granular control over the amount of data returned, which can be useful for performance optimization when member details are not needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ACCOUNT_VERIFICATION_WORKFLOWSRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account”s Identity Verification workflows should be retrieved.
string
An optional query parameter that filters the returned workflows based on their status. Valid values are: - “active”: Returns only active workflows (default if not specified) - “deactivated”: Returns only deactivated workflows - “all”: Returns both active and deactivated workflows Use this parameter to narrow down the results to specific workflow statuses based on your needs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ALL_ACCOUNT_TABSRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve tabs. This parameter is required and must be a valid account identifier. For example, “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
An optional boolean parameter that, when set to true, filters the response to include only custom tabs. When false or omitted, all tabs (both standard and custom) are returned. For example, use “true” to retrieve only custom tabs, or omit this parameter to retrieve all tabs. This parameter is not case-sensitive, so “true”, “TRUE”, and “True” are all valid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_AVAILABLE_ACCOUNT_STAMPSRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account”s stamps should be retrieved. The value must be provided as a string, even if it”s a numeric account number.
string
Optional parameter to filter stamps by name. Can be a Japanese surname (up to 5 characters) or a purchase order ID. Use this to search for specific stamps by their associated name or identifier. The search is not case-sensitive and partial matches may be returned.
string
Optional parameter to filter the returned stamps by their type. Valid values are “name_stamp” (for name-based stamps), “stamp” (for general stamps), or “signature” (for signature stamps). If not specified, stamps of all types will be returned. Use this to limit the results to a specific category of stamps.
string
Optional parameter to filter the returned stamps by their format. Valid values are “NameDateHanko” (stamp includes name and date), “NameHanko” (stamp includes only name), or “PlaceholderHanko”. If not specified, stamps of all formats will be returned. Use this parameter to narrow down the results to a specific stamp format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_BILLING_INVOICERetrieves a specific DocuSign billing invoice, including available amounts, balance, due date, and itemized charges.

Input Parameters

string
The unique identifier for the DocuSign account. This is automatically populated from your authenticated DocuSign account and typically does not need to be provided. The value can be either the external account number (integer) or the account ID GUID (string). Examples: “7215062” or “f0f9781f-d578-4e3e-b8f9-7b58414f8f41”.
string
required
The unique ID of the invoice to retrieve. This is a required parameter that identifies a specific billing invoice within your DocuSign account. Invoice IDs can be obtained from the ‘List billing invoices’ endpoint. The format is typically a numeric or alphanumeric string assigned by DocuSign (e.g., “12345”, “INV-2024-001”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_BILLING_PAYMENT_INFORetrieves details of a specific DocuSign billing payment, including available ID, number, amount, description, and date. The action declares the signature OAuth scope.

Input Parameters

string
The DocuSign account ID (GUID format). This parameter is automatically populated from your authenticated account and typically does not need to be provided manually. Example: ‘a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6’.
string
required
The unique identifier for the specific payment to retrieve. Payment IDs are string values returned by the DocuSign API when payments are created or listed. You can obtain payment IDs by calling the ‘Retrieve payment information list’ action (which lists all payments) or ‘Post payment to invoice’ action (which creates a payment and returns its ID). Required. Example: A payment ID might look like a GUID or numeric string depending on how the payment was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CHUNKED_UPLOAD_METADATARetrieves 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.

Input Parameters

string
Optional query parameter to include additional data in the response. The only valid value is “checksum”, which returns an SHA256 checksum of the chunked upload content. This allows verification of content integrity by comparing against a locally computed checksum.
string
required
The unique identifier for the DocuSign account. This can be either an integer (external account number) or a GUID (account ID). Required parameter that specifies which account the chunked upload belongs to.
string
required
The unique identifier for the specific chunked upload. Required parameter used to retrieve metadata for a particular chunked upload within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CLOUD_STORAGE_PROVIDER_CONFIGURATIONRetrieves cloud storage provider configuration for a user in a DocuSign account, with an optional redirect URL. The response exposes individual provider fields such as service ID, authentication URL, and error details.

Input Parameters

string
The unique identifier for the user whose cloud storage provider information is being requested. This parameter is required and must correspond to the authenticated user making the request. Users, including those with Admin rights, can only access their own information and cannot retrieve data for other users. If not provided, the userId will be automatically extracted from the authentication token.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is required to specify which account”s cloud storage provider information should be retrieved.
string
An optional parameter specifying the URL to which the user should be redirected after authenticating with a cloud storage provider. If provided, this URL will be appended to the authenticationUrl returned in the response. The redirectUrl must be within the docusign.com or docusign.net domains for security reasons. This parameter is useful for seamless integration of the authentication flow into your application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATION_DETAILSRetrieves 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.

Input Parameters

string
The DocuSign account ID (GUID) or external account number. Auto-populated from authentication context.
string
required
The unique ID of the Connect configuration to retrieve. You can get this ID from the list Connect configurations endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATIONSRetrieves DocuSign Connect configurations for the authenticated account, including webhook settings and envelope and recipient event triggers.

Input Parameters

string
The external account number (int) or account ID GUID that uniquely identifies the Docusign account for which to retrieve Connect configurations. This parameter is required and must be provided in the path of the API request. It can be either a numeric value (for external account numbers) or a GUID string (for account IDs). Example values: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_FAILURE_LOGSRetrieves 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.

Input Parameters

string
An optional query parameter specifying the end date for filtering the failure logs. The date should be provided in UTC DateTime format (e.g., “2023-04-30T23:59:59Z”). If not provided, the current date will be used as the default end date for the search range.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). It is a required path parameter used to specify the account for which to retrieve the Connect failure logs.
string
An optional query parameter specifying the start date for filtering the failure logs. The date should be provided in UTC DateTime format (e.g., “2023-04-01T00:00:00Z”). If not provided, no start date filtering will be applied, potentially returning all available logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_LOG_ENTRYRetrieves 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.

Input Parameters

string
required
The unique identifier of the specific Connect log entry to be retrieved. This parameter is required and must be provided in the path. It should be a valid string representing the log entry ID assigned by DocuSign.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a valid string representing either a numeric account number or a GUID format account ID.
string
An optional query parameter that, when set to “true”, includes additional debug information in the response. Specifically, it adds the “connectDebugLog” information to the output. This parameter accepts a string value, where “true” enables the additional information and any other value (or omitting the parameter) excludes it. This can be useful for more in-depth troubleshooting of Connect events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_LOGSRetrieves 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.

Input Parameters

string
An optional parameter specifying the end date for filtering Connect logs. It should be provided in UTC DateTime format (e.g., “2023-04-30T23:59:59Z”). If not provided, the current date and time will be used as the default end date.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to access the Connect logs for the specific account.
string
An optional parameter specifying the start date for filtering Connect logs. It should be provided in UTC DateTime format (e.g., “2023-04-01T00:00:00Z”). If not provided, no start date filtering will be applied, and logs from the earliest available date will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CONNECT_OAUTH_CONFIGURATIONRetrieves the DocuSign account’s Connect OAuth configuration for webhook integrations, including available authorization server, client and scope settings. A 404 response is returned as an empty configuration.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve the Connect OAuth configuration. This parameter is automatically populated from your authenticated DocuSign session. You typically do not need to provide this parameter as it will be set automatically. If provided, it should be a valid DocuSign account identifier (numeric string or GUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CREDIT_CARD_INFOThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). If not provided, it will be automatically retrieved from your connected DocuSign account. Example: “1234567” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_ENVELOPERetrieves custom field metadata for a specified envelope. Custom fields are additional data points attached to envelopes that are NOT visible to document recipients. They’re used for: - Organizing and categorizing envelopes internally - Tracking workflow stages or approval statuses - Storing reference IDs for integration with other systems (CRM, ERP, etc.) - Filtering and searching envelopes in reports Returns two types of custom fields: 1. List fields: Fields with predefined dropdown options 2. Text fields: Free-form text fields for custom values Supports Salesforce merge fields for CRM integrations. The fields returned are set at envelope creation or modification time and remain with the envelope for its entire lifecycle.

Input Parameters

string
The DocuSign account ID (GUID format) that identifies the account containing the envelope. This parameter is automatically populated from your authenticated DocuSign connection. You typically don’t need to provide this manually unless you want to override the default account. Example: ‘12345678-1234-1234-1234-123456789012’
string
required
The unique identifier (GUID) of the envelope whose custom fields you want to retrieve. This is required and must be a valid envelope ID from your DocuSign account. Example: ‘93be49ab-1234-5678-9abc-def012345678’. You can obtain envelope IDs from envelope creation actions or by listing envelopes in your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_TEMPLATEThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. If not provided, it will be automatically retrieved from your connected DocuSign account.
string
required
The unique identifier for the document within the template. This is a user-specified ID, typically following a sequential numbering scheme (e.g., 1, 2, 3). Valid values range from 1 to 2147483647 (maximum value for a 32-bit signed integer). This ID is crucial for identifying which specific document”s custom fields are being retrieved within the template.
string
required
The unique identifier for the template containing the document. This is a DocuSign-generated ID that uniquely identifies the template from which you want to retrieve custom document fields. The value must be a non-empty string representing a valid template ID within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CUSTOM_TAB_INFORMATIONRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided as a string. It is used to specify which account the custom tab belongs to.
string
required
The DocuSign-generated custom tab ID for the custom tab to be retrieved. This parameter is required and must be provided as a string. It uniquely identifies the specific custom tab within the specified account for which information is being requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_CUSTOM_USER_SETTINGSRetrieves custom user settings for a single DocuSign user. These user-specific settings are separate from standard account settings; users can only access their own custom settings.

Input Parameters

string
The unique identifier of the user whose custom settings are being retrieved. If not provided, defaults to the authenticated user. It should be a valid string representing the user’s ID in DocuSign. Note that users can only access their own information, even those with Admin rights cannot access another user’s settings. Example: “u1234567-89ab-cdef-0123-456789abcdef”.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is auto-populated from the authenticated account. It should be a valid string representing either a numeric account number or a GUID format account ID. Example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_DEFAULT_DISCLOSURE_FOR_ENVELOPERetrieves the Electronic Record and Signature Disclosure for a specified recipient in a DocuSign envelope, optionally requesting a language-specific version.

Input Parameters

string
An optional parameter to specify the language version of the disclosure to retrieve. Supports multiple languages including English (en), Spanish (es), French (fr), German (de), and many others. Use “browser” to automatically detect and use the viewer”s browser language. If not specified, the default language (usually English) will be used.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. This parameter is required to specify which account the envelope belongs to.
string
required
The unique identifier for the envelope. This must be a valid GUID representing the specific envelope for which you want to retrieve the consumer disclosure. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This parameter is required to identify the exact envelope associated with the disclosure.
string
required
A local reference used to identify the recipient within the envelope. This can be either an integer or a GUID, and it must be unique within the envelope. For example, many envelopes assign the first recipient a recipientId of “1”. This parameter is required to specify which recipient”s disclosure is being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_ATTACHMENTDownloads a developer-only envelope attachment file from a DocuSign envelope. This retrieves attachments that were added programmatically to an envelope (not signer attachments). These are files associated with the envelope that are only accessible via the API and not visible to signers in the DocuSign UI. The attachment is returned as a downloadable file that can be saved or processed. To get the attachmentId, first use the “List Envelope Attachments” action. Note: This endpoint is currently in beta and may undergo changes.

Input Parameters

string
The DocuSign account ID (GUID format). This is automatically populated from your authenticated DocuSign account and typically does not need to be provided manually. Example: “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”
string
required
The unique identifier of the envelope containing the attachment. This ID is returned when creating an envelope or can be obtained by listing envelopes. Format: GUID. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”
string
required
The unique identifier of the attachment to retrieve. This ID is returned when listing envelope attachments or adding attachments to an envelope. Format: GUID. Example: “b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_AUDIT_EVENTSRetrieves 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.

Input Parameters

string
The DocuSign account identifier. This is automatically populated from your authentication context and typically does not need to be provided explicitly. When omitted, the system will use the account ID associated with your access token. Format: string (GUID or numeric). Example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The envelope ID for which to retrieve audit events. This is a required parameter. The envelope must exist in the DocuSign account and be accessible with your current permissions. You can obtain envelope IDs from envelope creation responses, envelope listing APIs, or webhook notifications. Format: GUID string with hyphens. Example: “93be49ab-aaaa-bbbb-cccc-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENTSRetrieves 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.

Input Parameters

string
A boolean parameter that, when set to true, encrypts the PDF bytes returned in the response for all key managers configured on the DocuSign account. The encrypted documents can be decrypted using the Key Manager DecryptDocument API method. This optional parameter enhances document security during retrieval.
string
This parameter is reserved for DocuSign”s internal use. Its specific function is not detailed in the provided schema.
string
Specifies the language for the Certificate of Completion in the response. Optional parameter that accepts language codes such as “en” for English US, “fr” for French, “de” for German, etc. Supported languages include Chinese (Simplified and Traditional), Dutch, English, French, German, Italian, Japanese, Korean, Portuguese (including Brazilian Portuguese), Russian, and Spanish.
string
The external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account from which to retrieve the envelope documents.
string
A boolean parameter that controls the application of watermarks. When set to true, and if the account has the watermark feature enabled and the envelope is not complete, the account”s watermark is added to the PDF documents. This optional parameter can be used to remove the watermark when set to false.
string
required
The ID of the document to retrieve. This required parameter can be either a specific document ID or one of the following special keywords: “combined” (retrieves all documents as a single PDF), “archive” (retrieves a ZIP archive of all documents), “certificate” (retrieves only the certificate of completion), or “portfolio” (retrieves documents as a PDF portfolio). The choice of keyword determines the format and content of the retrieved documents.
string
required
The envelope”s GUID (Globally Unique Identifier). This required parameter specifies the exact envelope from which to retrieve documents. It should be in the format of a UUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
A boolean parameter used only when “documentId” is set to “combined”. When true, the certificate of completion is included in the combined PDF file. When false (default), it is not included. This optional parameter allows control over the inclusion of the completion certificate in combined document retrievals.
string
Allows the sender to retrieve documents as one of the recipients they control. This optional parameter works only when “documents_by_userid” is set to false. It”s useful for viewing documents from a specific recipient”s perspective.
string
A boolean parameter that, when set to true, highlights any changed fields in yellow and outlines optional signatures or initials in red in the returned PDF. This optional feature requires the account to have the “Highlight Data Changes” feature enabled.
string
The ID of a shared user to impersonate for document retrieval. This optional parameter is used in the context of a shared inbox, specifically when envelopes are shared from one user to another through the DocuSign Admin console.
string
A boolean parameter that, when set to true, allows recipients to get documents by their user ID. This is particularly useful when a user is included in multiple routing orders with different visibilities, as it returns all documents from all relevant routing orders. Optional parameter that defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_EMAIL_OVERRIDESRetrieves custom email settings for a specific DocuSign envelope. Use this action to get the envelope-specific email configuration overrides including: - Reply-to email address and display name - BCC email addresses for archiving (up to 5 addresses) These settings override the account-level defaults for this specific envelope only. Important: This information is NOT included in standard envelope status requests (GET /envelopes/{envelopeId}), so you must use this dedicated endpoint to retrieve email override settings. Use cases: - Verify custom reply-to addresses set for specific envelopes - Audit BCC configuration for compliance/archiving purposes - Troubleshoot email delivery issues by checking envelope-specific overrides

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. If not provided, the system will automatically use the account ID from the authenticated user’s context. Specify this only when you need to target a specific account in multi-account environments.
string
required
The unique identifier for the specific envelope whose email settings you want to retrieve. This is a GUID (Globally Unique Identifier) that DocuSign assigns to each envelope. The envelopeId is required and must be in the format of a valid GUID, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It ensures that you”re retrieving email settings for the correct envelope within the specified account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_HTML_DEFINITIONRetrieves the original HTML definition used to generate the responsive HTML for a specific document within an envelope in a DocuSign account. This endpoint is crucial for developers working with DocuSign’s responsive signing feature, as it provides detailed information about how the document is 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. Use this when you need to inspect or troubleshoot the HTML definition of a document in an envelope, particularly for documents using smart sections or responsive signing features. This endpoint does not modify any data and is purely for retrieval purposes.

Input Parameters

string
required
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account’s envelope HTML definition should be retrieved.
string
required
The unique identifier for the document within the envelope. This parameter is required to retrieve the HTML definition for a specific document. Use “1” for the first document, “2” for the second, etc., or use “combined” to get all documents combined. This is a required path parameter.
string
required
The unique identifier for the envelope containing the document. This parameter is required and must be provided in the path of the API request. It should be a valid GUID (Globally Unique Identifier) representing a specific envelope in the DocuSign system. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ENVELOPE_NOTIFICATION_DETAILSRetrieves 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account”s envelope you are querying. The accountId is typically obtained from your DocuSign integration settings or provided by DocuSign support.
string
required
The unique identifier for the envelope whose notification details you want to retrieve. This is a GUID (Globally Unique Identifier) assigned by DocuSign when the envelope was created. It must be a valid, existing envelope ID within the specified account. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_ITEMS_IN_CLOUD_STORAGE_FOLDERRetrieves 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.

Input Parameters

string
The maximum number of results to return in a single request. This optional parameter is used for pagination. It must be a positive integer. If not specified, the default value is 25. Use in conjunction with “start_position” to implement paging through large result sets.
string
Specifies the order in which to sort the results. This optional parameter accepts two values: “asc” for ascending order or “desc” for descending order. If not provided, the default sorting order is typically ascending.
string
required
The GUID of the DocuSign user whose cloud storage is being accessed. This parameter is required and must match the authenticated user. Users can only access their own cloud storage information - even users with Admin rights cannot access another user’s cloud storage settings. The userId can be obtained from the OAuth userinfo endpoint or from user management API calls.
string
The file attribute to use for sorting the results. This optional parameter accepts two values: “modified” to sort by last modified date, or “name” to sort alphabetically by item name. If not specified, the default sorting attribute is typically name.
string
The external account number (int) or account ID GUID. This unique identifier specifies the DocuSign account context for the operation. If not provided, it will be automatically populated from authentication metadata. Must be provided as a string, either in the form of an integer or a GUID.
string
required
The ID of the cloud storage service to access. Can be either a lowercase service name or a numeric service ID. Common service names include: “box” (Box), “dropbox” (Dropbox), “googledrive” (Google Drive), “skydrive” (OneDrive/SkyDrive), “salesforce” (Salesforce). Numeric service IDs are returned when configuring cloud storage providers (e.g., via CONFIGURE_CLOUD_STORAGE_REDIRECT_URL action). IMPORTANT: Users must have already connected and authenticated the cloud storage provider through DocuSign OAuth before this endpoint can successfully retrieve folder contents. Attempting to access an unauthenticated provider will result in a 400 Bad Request error. Use GET_USER_CLOUD_STORAGE_PROVIDER_CONFIGURATION or RETRIEVE_CLOUD_STORAGE_PROVIDER_CONFIGURATION to verify available authenticated providers.
string
A string to search for within the folder contents. This optional parameter allows filtering the results based on a text search, which can include file names or other searchable attributes. Leave empty to return all items without filtering.
string
The zero-based index of the first result to return. This optional parameter is used for pagination in conjunction with “count”. The default value is 0, which returns results from the beginning of the sorted list. Use this parameter to skip a certain number of results when implementing paging.
string
A comma-separated list of folder IDs to include in the request. This optional parameter allows you to specify one or more folders to retrieve items from. If not provided, the root folder is assumed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_LIST_OF_BILLING_PLANSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_PAYMENT_INFORMATION_LISTRetrieves 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.

Input Parameters

string
An optional query parameter specifying the end date for the payment information retrieval. It should be in a standard date-time format (e.g., ISO 8601: “YYYY-MM-DDTHH:mm:ssZ”). This parameter sets the upper bound of the date range for which you want to retrieve payment information. If not provided, the current date is used as the default end date.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is a required path parameter used to specify which account”s payment information should be retrieved. For example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6”.
string
An optional query parameter specifying the start date for the payment information retrieval. It should be in a standard date-time format (e.g., ISO 8601: “YYYY-MM-DDTHH:mm:ssZ”). This parameter allows you to set the lower bound of the date range for which you want to retrieve payment information. If not provided, the default behavior is to include payments from 365 days ago.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_PDF_FROM_SPECIFIED_TEMPLATERetrieves 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.

Input Parameters

string
An optional query parameter that, when set to “true”, encrypts the returned PDF bytes for all key managers configured on your DocuSign account. The encrypted document can be decrypted using the Key Manager DecryptDocument API method. This parameter enhances security for sensitive documents. If not specified, the document is not encrypted.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account from which to retrieve the template document. This parameter is automatically populated from your connected DocuSign account and typically does not need to be specified manually.
string
An optional query parameter to specify the file type of the document to be retrieved. The description for this parameter is empty in the schema, suggesting it may not be fully implemented or documented. It”s recommended to omit this parameter unless specific guidance is provided by DocuSign support.
string
required
The unique identifier of the document within the template. This parameter is required. Standard values are numeric strings like ‘1’, ‘2’, ‘3’, etc., representing individual documents in the template (typically starting from ‘1’). You can also use the special value ‘combined’ to retrieve all documents in the template merged into a single PDF file.
string
required
The unique identifier (GUID format) of the template from which to retrieve the document(s). This parameter is required and must be a valid template ID within your DocuSign account. You can find template IDs by listing templates or viewing them in the DocuSign web interface.
string
An optional query parameter that, when set to “true”, highlights any changes made by recipients in the returned PDF document. Changed document fields are highlighted in yellow, and optional signatures or initials are outlined in red. This is useful for quickly identifying modifications made during the signing process. If not specified or set to “false”, the document is returned without these visual indicators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_POWER_FORM_DATA_ENTRIESThis 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.

Input Parameters

string
Optional parameter to specify the end date for filtering PowerForm entries. Format: UTC DateTime (e.g., “2023-04-30T23:59:59Z”). If not provided, the default value is the current date and time (UtcNow).
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). If not provided, it will be automatically populated from the authenticated user’s account.
string
Optional parameter to specify the start date for filtering PowerForm entries. Format: UTC DateTime (e.g., “2023-04-01T00:00:00Z”). If not provided, no start date filtering is applied.
string
Optional parameter that specifies the layout format for the returned PowerForm data. Valid values are: - “Native”: Returns data in JSON format (set Accept header to “application/json”) - “Csv_Classic”: Returns data in classic CSV format (set Accept header to “application/csv”) - “Csv_One_Envelope_Per_Line”: Returns data in CSV format with one envelope per line (set Accept header to “application/csv”) - “Xml_Classic”: Returns data in classic XML format (set Accept header to “application/xml”) If not specified, the default format is determined by the Accept header.
string
required
The unique identifier for the specific PowerForm from which to retrieve data. Required parameter that determines which PowerForm’s entries will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_PROPERTIES_ABOUT_WORKSPACERetrieves 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.

Input Parameters

string
The DocuSign account ID (GUID format) or external account number (integer). This parameter is optional - if not provided, it will be automatically resolved from your authenticated session. When specified, it identifies the specific DocuSign account containing the workspace you want to retrieve. Example: “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6” or “12345”.
string
required
The unique identifier of the workspace to retrieve. This is a required parameter that must be a valid workspace ID from your DocuSign account. Workspace IDs are typically alphanumeric strings that can be obtained from listing workspaces or from workspace creation responses. Example: ‘a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_SHARED_ITEM_STATUS_FOR_USERSRetrieves shared item status for one or more users and types of items within a DocuSign account. This endpoint provides detailed information about how envelopes, templates, and folders are shared among users and groups. It can be used to audit sharing permissions, track shared resources, or gather information for access management. The endpoint offers various filtering options to customize the response based on item types, user statuses, and sharing directions. Note that this endpoint returns information for the legacy Shared Envelopes feature; for the new Shared Access feature, use the Authorizations resource instead.

Input Parameters

string
The maximum number of results to return in the response. This optional parameter allows you to limit the size of the result set. It must be a positive integer. If not specified, the default value is 1000. Use in conjunction with “start_position” for pagination of results.
string
A comma-separated list of sharing filters that specifies which users appear in the response. This optional parameter can include any combination of the following values: “not_shared” (users who do not share items), “shared_to” (users sharing items to the current user), “shared_from” (users sharing items from the current user), “shared_to_and_from” (users sharing items to and from the current user). If the current user does not have administrative privileges, only the “shared_to” option is valid.
string
A comma-separated list of user IDs for whom the shared item information is being requested. This optional parameter allows you to specify particular users of interest. Each ID in the list should be a valid user identifier within the specified account.
string
The external account number (integer) or account ID GUID. This parameter identifies the specific DocuSign account for which shared access information is being retrieved. If not provided, it will be automatically populated from the authenticated user’s account information.
string
Specifies the type of shared item being requested. This optional parameter can be set to one of three values: “envelopes” (get information about envelope sharing between users), “templates” (get information about template sharing among users and groups), or “folders” (get information about folder sharing among users and groups). If not specified, the API will return information for all item types.
string
A comma-separated list of folder IDs for which to return shared item information. This optional parameter is required if “item_type” is set to “folders”. Each ID in the list should be a valid folder identifier within the specified account.
string
An optional search string to filter user names. The wildcard ”*” (asterisk) can be used in the string for partial matches. This parameter allows for searching specific users within the shared access results.
string
The zero-based index of the result from which to start returning results. This optional parameter is used for pagination in conjunction with the “count” parameter. The default value is 0. Use this to retrieve subsequent pages of results when the total number of results exceeds the specified “count”.
string
An optional filter that works in conjunction with the “user_ids” parameter. It limits the results to users with a specific status when querying for envelopes that are not shared. Valid values are: “ActivationRequired”, “ActivationSent”, “Active”, “Closed”, or “Disabled”. This parameter helps in narrowing down the user list based on their account status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_SIGNER_SIGNATURE_IMAGE_INFORMATIONRequests a recipient’s signature image from a DocuSign envelope for verification, display, or record-keeping. An option controls whether to include chrome, the added line and identifier around the image.

Input Parameters

string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This is a required parameter and must be provided to specify which account the envelope and recipient belong to. It ensures that the authenticated user has the necessary permissions to access the signature image.
string
required
The unique identifier (GUID) of the envelope containing the signature. This is a required parameter and must be provided to locate the specific envelope from which to retrieve the signature image. The format is a string of hexadecimal characters, typically separated by hyphens. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
A local reference used to identify the specific recipient within the envelope whose signature image is being requested. This is a required parameter and must be either an integer or a GUID. It must be unique within the envelope. For example, many envelopes assign the first recipient a recipientId of “1”. This parameter is crucial for pinpointing the exact signature to retrieve from potentially multiple signatories in an envelope.
string
An optional query parameter that determines whether to include the chromed version of the signature image in the response. When set to “true”, the response includes the signature image with the added line and identifier around it. When “false” or omitted, only the raw signature image is returned. This boolean parameter allows flexibility in how the signature is presented or used in the calling application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_TEMPLATE_CUSTOM_FIELDSRetrieves 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from authentication metadata if not provided. The value should be a valid string representing either the numeric account number or the GUID format account ID.
string
required
The unique identifier of the template from which to retrieve custom fields. This parameter is required and must be a valid string representing the template ID. The template ID is typically a GUID-like string that DocuSign assigns to each template when it”s created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_TEMPLATE_DOCUMENT_PAGE_IMAGESRetrieves 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.

Input Parameters

string
An optional query parameter that sets the resolution of the returned page images in dots per inch (DPI). Valid values range from 1 to 310 DPI. If not specified, the default value is 94 DPI. Higher DPI values result in higher quality images but also larger file sizes.
string
An optional query parameter that specifies the maximum number of page images to return in the response. If not provided, the API will return all available page images. Use this parameter to limit the response size or implement pagination.
string
An optional query parameter that, when set to “true”, disables the use of cached image information and retrieves the latest data from the database. The default value is “true”. Set this to “false” if you want to use cached data for faster response times, assuming the data hasn”t changed recently.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically extracted from the authentication token if not provided. It ensures that the template document is retrieved from the correct account.
string
An optional query parameter that sets the maximum width of the returned images in pixels. Use this parameter to constrain the image size to fit within specific display requirements. If not specified, the images will be returned at their original width.
string
required
The unique identifier of the document within the template. This required parameter specifies which document’s pages should be retrieved from the selected template.
string
An optional query parameter that sets the maximum height of the returned images in pixels. Use this parameter to constrain the image size to fit within specific display requirements. If not specified, the images will be returned at their original height.
string
required
The unique identifier of the template containing the document. This required parameter must be provided in the path of the API request. It specifies which template contains the document whose pages are to be retrieved.
string
An optional query parameter that, when set to “true”, displays any changes or modifications made to the document in the returned images. This is useful for tracking and visualizing edits or annotations made to the template. If not specified or set to “false”, changes will not be shown in the returned images.
string
An optional query parameter that specifies the starting position within the total result set from which to begin returning values. This can be used for pagination or to retrieve specific subsets of pages. The special value “thumbnail” can be used to return only the page thumbnail image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_TEMPLATE_PAGE_IMAGERetrieves 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.

Input Parameters

string
The resolution of the returned image in dots per inch (DPI). This is an optional query parameter. Valid values range from 1 to 310 DPI. If not specified, the default value is 94 DPI. Higher DPI values result in higher quality images but larger file sizes.
string
required
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This is automatically populated from your connection.
string
The maximum width of the returned image in pixels. This is an optional query parameter used to limit the horizontal size of the image. If specified, the image will be scaled to fit within this width while maintaining its aspect ratio.
string
required
The unique identifier for the document within the template. This is a required path parameter. Unlike other IDs in the eSignature API, you specify this ID yourself. Typically, the first document has ID “1”, the second “2”, and so on, but you can use any numbering scheme within the range of 1 to 2147483647. This ID is used in tab objects to specify document placement.
string
The maximum height of the returned image in pixels. This is an optional query parameter used to limit the vertical size of the image. If specified, the image will be scaled to fit within this height while maintaining its aspect ratio.
string
required
The specific page number of the document to retrieve. This is a required path parameter. Page numbers start at 1 and must be within the range of pages in the document.
string
required
The unique identifier for the template from which to retrieve the page image. This is a required path parameter used to specify which template to access.
string
An optional query parameter that controls whether to display any changes or annotations on the page image. Accepts “true” or “false” as string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_ACCOUNT_SETTINGSRetrieves 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.

Input Parameters

string
The ID of the user whose settings to retrieve. If not provided, it will be automatically populated with the authenticated user’s ID. Note that users can only access their own information. Even users with Admin rights cannot access another user’s settings using this endpoint.
string
The external account number (integer) or account ID GUID. If not provided, it will be automatically populated from your authenticated account. This identifies the specific DocuSign account for which the user settings are being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_INITIALS_IMAGE_FOR_ENVELOPESRetrieves the initials image that a recipient used when signing a DocuSign envelope. This endpoint allows you to fetch the recipient’s initials image in its original format (GIF, PNG, JPEG, or BMP), with an option to include or exclude the chrome (added line and identifier around the image). The initials image is only available after the recipient has signed the envelope and used initials on the document. If the recipient hasn’t signed yet or didn’t use initials, the API will return a 404 error. This is particularly useful when you need to display or audit the actual initials that were stamped on documents during the signing process. Note that for older envelopes, only chromed images might be available.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from the authenticated user’s account information via the DocuSign base action. If not provided, it will be retrieved from the auth metadata. Example: “12345” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
required
The unique identifier for the envelope containing the recipient whose initials image is being retrieved. This parameter is required and must be provided in the path of the API request. It should be a valid GUID string. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
A local reference used to identify the recipient within the envelope whose initials image is being retrieved. This parameter is required and must be provided in the path of the API request. It can be either an integer or a GUID, and must be unique within the envelope. For example, many envelopes assign the first recipient a recipientId of “1”. Example: “1” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”.
string
An optional query parameter that determines whether to include the chrome (added line and identifier) around the initials image. Set to “true” to include the chrome, or “false” to exclude it. If not specified, the default behavior may vary. Note that for older envelopes, only chromed images might be available. Example: “true” or “false”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_PROFILE_IMAGERetrieves 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.

Input Parameters

string
The unique identifier of the user whose profile image is being retrieved. This parameter is required and must be provided in the path. It”s important to note that users can only access their own profile image, even if they have admin rights. The userId must match the authenticated user”s ID. The value should be a string representing the user”s unique identifier within the DocuSign system. If not provided, it defaults to the authenticated user’s ID.
string
An optional query parameter reserved for DocuSign”s internal use. Currently, this parameter is not actively used in this endpoint but may be utilized in future updates. If provided, it should be a string value. As it”s reserved, no specific format or values are defined for general use.
string
The external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is required and must be provided in the path. It ensures that the profile image is retrieved from the correct account context. The value should be a string representing either a numeric account number or a GUID (e.g., “1234567” or “a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_PROFILE_INFORMATIONRetrieves a user’s DocuSign profile information within an account, with a response modeled for identity and account information. Users can only access their own information.

Input Parameters

string
The ID of the user to access. This parameter is required and must match the authenticated user”s user ID. Users can only access their own information, even those with admin rights cannot access another user”s settings. The userId should be a valid string identifier assigned by DocuSign to the user. If not provided, the userId will be automatically extracted from the authentication token.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be a valid identifier for an existing DocuSign account. It determines the context in which the user profile information is retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_SIGNATURE_DEFINITIONSRetrieves a user’s DocuSign signature definitions, including signature and stamp metadata, with an optional stamp-type filter. Users can access only their own signature information, even with administrator rights. The account is normally the first account associated with the connection; a supplied account ID is overridden.

Input Parameters

string
The unique identifier of the user whose signature definitions are being retrieved. This parameter is required and must be provided in the path of the API request. It”s important to note that users can only access their own information, and even users with Admin rights cannot access another user”s settings using this endpoint. If not provided, the userId will be automatically extracted from the authentication token.
string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to identify the specific account for which the user signatures are being retrieved.
string
An optional query parameter that specifies the type of stamps to return in the response. Valid values are: “signature” (returns information about signature images only, this is the default value), “stamp” (returns information about eHanko and custom stamps only), or null (no specific type). If not provided, the default behavior is to return signature images only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_SIGNATURE_IMAGERetrieves the authenticated user’s DocuSign signature, initials, or stamp image as a downloadable file, optionally including its chrome frame. The account is normally the first returned by OAuth userinfo, overriding the supplied account ID.

Input Parameters

string
The unique identifier of the user whose signature image is being retrieved. This must match the authenticated user”s ID, as users can only access their own signature information. Even users with Admin rights cannot access another user”s settings. This parameter is optional - if not provided, it will be automatically extracted from the authentication token.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account the signature image belongs to.
string
required
Specifies the type of signature image to retrieve. Must be one of three valid values: “stamp_image” for a stamp, “signature_image” for a full signature, or “initials_image” for initials. This parameter is required to determine which type of image to fetch from the user”s available signature images.
string
required
The unique identifier for the specific signature image to retrieve. This can be either the signature ID or the signature name. If using a signature name, ensure it is URL-encoded, especially if it contains spaces (e.g., “Bob Smith” should be encoded as “Bob%20Smith”). DocuSign recommends using the signature ID for more reliable results. This parameter is required to pinpoint the exact signature image to fetch.
string
An optional query parameter that determines whether to include the chrome (frame) in the returned signature image. When set to “true”, the image will include the added line and identifier around the signature or initials. If not specified, the default behavior may vary. This parameter allows flexibility in how the signature image is presented or processed in the requesting application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_USER_SIGNATURE_INFORMATIONThis 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.

Input Parameters

string
The unique identifier of the user whose signature information is being accessed. Users can only access their own signature information, even if they have admin rights. If not provided, the userId will be automatically extracted from the authentication token.
string
The external account number (integer) or account ID GUID. This parameter identifies the specific DocuSign account for which the user signature information is being retrieved. If not provided, it will be automatically extracted from the authentication token and populated by the system.
string
required
The unique identifier for the signature to be retrieved. This can be either the signature ID (a GUID) or the signature name. When using a signature name, it should be URL encoded if it contains spaces or special characters (e.g., “Bob Smith” becomes “Bob%20Smith”). This parameter is required to specify which signature to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETRIEVE_WORKFLOW_STEP_FOR_TEMPLATERetrieves detailed information about a specific workflow step for a DocuSign template. This endpoint allows users to access the configuration and status of a single step within a template’s workflow, including delayed routing settings and conditional recipient rules. It’s particularly useful for monitoring the progress of complex, multi-step template 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 a template. Note that this endpoint does not allow modification of the workflow step; it is for retrieval purposes only.

Input Parameters

string
The external account number (integer) or account ID GUID of the DocuSign account. This parameter is required and must be a valid string representing either the numeric account identifier or the globally unique identifier (GUID) for the account. For example: “7215091” or “f0f9db05-0606-4c73-9f5d-fbb75aa08aa1”.
string
required
The unique identifier of the template for which the workflow step information is being requested. This parameter is required and must be a valid GUID string. The format is a 32-character hexadecimal string, typically hyphenated into five groups. For example: “93be49ab-1234-5678-abcd-f752070d71ec”. This ID is used to locate the specific template within the DocuSign system.
string
required
The unique identifier of the specific workflow step to retrieve. This parameter is required and must be a valid string representing the workflow step ID. The format of this ID is determined by DocuSign and is typically a GUID or a system-generated string. This ID is used to pinpoint the exact step within the envelope”s workflow for which details are being requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_ALL_CONNECT_SERVICE_USERSRetrieves 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.

Input Parameters

string
The maximum number of results to return in a single response. This optional query parameter allows for pagination of the results. If not specified, a default value determined by the API will be used.
string
An optional query parameter to filter users based on their status. Valid values may include “active”, “inactive”, or other status types defined by DocuSign. If not specified, users of all statuses will be returned.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the request.
string
required
The unique identifier for the custom Connect configuration being accessed. This parameter is required and must be provided in the path of the request.
string
An optional query parameter that specifies the starting position within the total result set from which to begin returning values. This parameter is used for pagination. The special value “thumbnail” can be used to return the page image instead of user data.
string
An optional query parameter to filter user records based on their email address. The filter matches against full email addresses or substrings of email addresses. For example, “@example.com” would match all users with email addresses from that domain.
string
An optional query parameter to filter results. When set to “true”, only users associated with the account”s domain will be returned. When set to “false” or omitted, all users will be included in the response.
string
An optional query parameter to filter results based on a full or partial user name. The filter matches against the beginning of user names. No wildcard character is needed or supported. For example, “John” would match “John Doe” but not “Johnathan Smith”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_BRAND_RESOURCE_METADATA_FOR_ACCOUNTRetrieves 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.

Input Parameters

string
required
The unique identifier for the specific brand within the account. This parameter is required to specify which brand”s resources to retrieve. The brandId is typically a string value assigned by DocuSign when the brand is created.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). This parameter is required to specify which account”s brand resources to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_ENVELOPE_TAB_DATA_FOR_EXISTING_ENVELOPERetrieves 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.

Input Parameters

string
required
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account the envelope belongs to and must be provided to access the correct data.
string
required
The unique identifier for the specific envelope from which to retrieve form data. This must be a valid GUID (Globally Unique Identifier) that corresponds to an existing envelope in the specified account. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It is required to pinpoint the exact envelope for data retrieval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_SCHEDULED_SENDING_RULES_FOR_ENVELOPEGet the scheduled sending configuration for a DocuSign envelope. Returns when and how an envelope is scheduled to be sent, including: - Send date/time (resumeDate): When the envelope will be sent - Delay rules: Time to wait before sending (format: d.hh:mm:ss) - Status: Whether sending is pending, started, or completed - Bulk list ID: If used with bulk sending Use this to check if an envelope has scheduled sending enabled and when it will be sent. Requires a valid envelope ID that has scheduled sending configured. Important: Returns 404 if the envelope doesn’t have scheduled sending rules. You must first set up scheduled sending using UPDATE_ENVELOPE_SCHEDULED_SENDING_RULES before you can retrieve the configuration. Example use cases: - Check when a draft envelope is scheduled to send - Verify scheduled sending configuration before envelope goes out - Monitor the status of delayed envelope sending

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). Required parameter for specifying which account the envelope belongs to.
string
required
The unique identifier for the envelope whose scheduled sending rules are being requested. This is a required parameter and should be provided as a GUID string. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURNS_DOCUMENT_PAGE_IMAGES_BASED_ON_INPUTRetrieves 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.

Input Parameters

string
An optional query parameter that sets the resolution of the returned images in dots per inch (DPI). Valid values range from 1 to 310 DPI. If not specified, the default value is 94 DPI. Higher DPI values will result in higher quality images but larger file sizes.
string
An optional query parameter that specifies the maximum number of page images to return in the response. If not provided, the API will return all available page images for the document.
string
An optional query parameter that controls whether to use cached data or retrieve fresh data from the database. When set to “true” (the default value), caching is disabled, and the API fetches the most up-to-date image information from the database. Set to “false” to allow caching, which may improve performance for frequently accessed documents.
string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. Required parameter that must be provided in the path to specify which account to access.
string
An optional query parameter that sets the maximum width of the returned images in pixels. If provided, the API will scale the images to fit within this width while maintaining the aspect ratio.
string
required
The unique identifier for the document within the envelope. This is a required path parameter. It”s a user-defined ID, typically starting from “1” for the first document, “2” for the second, and so on. The value must be within the range of a 32-bit signed integer (1 to 2147483647). This ID is used in other API calls to reference specific documents, such as when placing tabs.
string
required
The unique identifier for the envelope containing the document. This is a required path parameter. It should be provided as a GUID string, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ID is used to locate the specific envelope from which to retrieve the document page images.
string
An optional query parameter that sets the maximum height of the returned images in pixels. If provided, the API will scale the images to fit within this height while maintaining the aspect ratio.
string
An optional query parameter that determines whether changes made to the document should be displayed in the returned images. When set to “true”, the images will include visual indicators of any modifications made to the document. This is useful for tracking and displaying document revisions.
string
An optional query parameter that specifies the starting position within the result set from which to return values. This can be used for pagination or to retrieve specific page images. The special value “thumbnail” can be used to return the page image thumbnail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_TEMPLATE_WORKFLOW_DEFINITIONRetrieves 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.

Input Parameters

string
The external account number (int) or account ID GUID. If not provided, the account ID will be automatically determined from the authenticated user’s OAuth token. For manual specification, provide either an integer account number or a GUID string.
string
required
The unique identifier of the template whose workflow definition is being requested. This parameter is required and must be a valid string representing the template ID within the specified DocuSign account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_RETURN_USERS_FROM_CONNECT_SERVICERetrieves users associated with a specific DocuSign Connect configuration. This endpoint returns information about which users are linked to a Connect configuration, indicating either that all users are selected (allUsersSelected) or providing a list of specific users. Connect configurations define webhook settings for receiving real-time event notifications from DocuSign. The response indicates user selection for the Connect configuration: - When allUsersSelected is “True”, the configuration applies to all account users - When specific users are configured, they are returned in the users array - Supports pagination for large user lists via count and start_position parameters Requires account administrator privileges and an active Connect configuration.

Input Parameters

string
An optional parameter that specifies the maximum number of results to return in a single API call. Used in conjunction with “start_position” for pagination. If not specified, the API will return all results or a default number determined by the system.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. If not provided, the account ID will be automatically populated from the authenticated user’s context.
string
required
The unique identifier for the custom Connect configuration being accessed. This parameter is required and specifies which particular Connect setup”s users should be retrieved.
string
An optional parameter used for pagination. It specifies the zero-based index of the first result to return. Used in combination with “count” to retrieve a specific subset of results. The default value is 0, which starts from the beginning of the result set.
string
An optional boolean parameter that controls whether to include users who are part of the Connect configuration. When set to ‘true’, the response includes users associated with the Connect service. Default behavior varies by API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_REVOKE_ENVELOPE_CORRECTION_URLThis 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.

Input Parameters

string
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It can be either a numeric value or a GUID string.
string
(Required) The URL to which the user should be redirected after the view session has ended. Maximum Length: 470 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL Be sure to include https:// in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an event query parameter that your app can use: * send: User corrected and sent the envelope. * save: User saved the envelope. * cancel: User canceled the transaction. * error: There was an error when performing the correct or send. * sessionEnd: The session ended before the user completed a different action.
string
required
The unique identifier for the envelope whose correction view URL is to be revoked. This parameter is required and must be provided in the path of the API request. It should be a GUID string in the format “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”
string
string
Specifies whether the window is displayed with or without dressing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ROTATE_PAGE_IMAGE_FOR_ENVELOPEThis 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.

Input Parameters

string ("left" | "right")
Direction to rotate the page image.
string
Optional password for accessing a password-protected envelope. Only required if the envelope has been secured with a password.
string
The unique identifier for the DocuSign account. This field is automatically populated from your connected DocuSign account. You typically don’t need to provide this value manually. Format: GUID (e.g., ‘a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6’) or account number (e.g., ‘12345’).
string
required
The unique identifier for the document within the envelope. Unlike other IDs in the eSignature API, you specify this ID yourself. It must be a positive integer between 1 and 2147483647. Typically, the first document is assigned ID “1”, the second “2”, and so on, but you can use any numbering scheme within the valid range. This ID is crucial for identifying which document”s page you want to rotate. For example: “1” for the first document, “2” for the second, etc.
string
required
The unique identifier (GUID) for the envelope containing the document and page to be rotated. This is a required parameter to specify which envelope the operation should be performed on. The format is a 32-character string, including hyphens. For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
The specific page number within the document that needs to be rotated. This is a required parameter and should be a positive integer representing the page”s position in the document. For example, “1” for the first page, “2” for the second page, and so on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_ROTATE_TEMPLATE_PAGE_IMAGERotates 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.

Input Parameters

string
Sets the direction the page image is rotated. The possible settings are: “left” or “right”. This parameter is required in practice - the API returns a 400 Bad Request error if not provided.
string
The user’s encrypted password hash.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically extracted from the authentication token if not provided. It is used to specify which account the template belongs to.
string
required
The unique identifier of the document within the template. This parameter is required and must be provided in the path. It can be any number between 1 and 2147483647, typically starting with 1 for the first document, 2 for the second, and so on. This ID is used to specify which document’s page image should be rotated.
string
required
The specific page number of the document to be rotated. This parameter is required and must be provided in the path. It should be a positive integer representing the page number within the document. For example, use “1” for the first page, “2” for the second page, and so on.
string
required
The unique identifier of the template containing the page image to be rotated. This parameter is required and must be provided in the path. It is used to specify which template the document and page belong to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SEND_ENVELOPEUpdates a draft DocuSign envelope’s status to send it or save it as a draft. The default status is sent.

Input Parameters

string ("sent" | "created")
The desired status of the envelope. Use ‘sent’ to send immediately; use ‘created’ to save as a draft without sending.
string
required
The external account number (int) or account ID GUID
string
required
The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_ENVELOPE_PURGE_CONFIG_FOR_ACCOUNTConfigures automatic envelope purge settings for a DocuSign account. This action allows account administrators to set up policies for automatically removing envelope documents after a specified retention period. The configuration includes options for: - Enabling/disabling automatic purging - Setting the retention period (0-999 days) - Removing tabs and attachments during purge - Redacting personally identifiable information (PII) Important: This endpoint requires account administrator privileges. PII redaction can only be enabled when removeTabsAndEnvelopeAttachments is also enabled. Use Cases: - Set up automated document retention policies for compliance - Configure PII redaction for privacy requirements - Manage storage costs by purging old envelopes Beta Feature: This functionality is currently in beta status.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the envelope purge configuration will be set. Use ‘self’ to refer to the authenticated user’s default account. This parameter is required for the API request path.
string
When set to ‘true’, the system redacts personally identifiable information (PII) during the purge process. Important: PII redaction requires that removeTabsAndEnvelopeAttachments is also set to ‘true’. Must be a string value.
string
The number of days to retain envelope documents before purging them. Must be a string representation of an integer value between 1 and 999 (e.g., ‘90’, ‘180’, ‘365’). Important: This parameter can only be set when purgeEnvelopes is set to ‘true’. Setting this parameter alone will result in a 400 Bad Request error.
string
When set to ‘true’, enables automatic purging of envelope documents. When set to ‘false’, disables automatic purging. Must be a string value.
string
When set to ‘true’, the system purges tabs and attachments associated with envelopes during the purge process. This must be enabled if you want to use PII redaction. Must be a string value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_INITIALS_IMAGE_FOR_ACCOUNTLESS_SIGNERThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an integer (external account number) or a GUID (account ID). It is required to specify which account the operation should be performed under. For example: “12345” or “8a9de7e3-b8f0-4fbe-80e3-0e4a6a0444cc”.
string
required
The globally unique identifier (GUID) for the specific envelope containing the recipient whose initials image needs to be updated. This 32-character alphanumeric string is required to identify the correct envelope. For example: “93be49ab-1234-5678-abcd-f752070d71ec”.
object
required
The initials image file to upload. Supported formats include gif, png, jpeg, and bmp. The file size must be less than 200KB. This image will be used as the visual representation of the recipient’s initials on documents.
string
required
A local reference used to identify the specific recipient within the envelope whose initials image is being updated. This can be either an integer or a GUID and must be unique within the envelope. For example, the first recipient in an envelope often has a recipientId of “1”. This parameter is required to target the correct recipient for the image update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_SHARED_ACCESS_FOR_USERS_AND_TEMPLATESThis endpoint sets shared access for users and templates in DocuSign. It manages collaboration and access control within an organization for envelopes, templates, and folders. Only users with admin privileges can set envelope access, while template access requires ownership or admin rights. Changes replace current status, not add to it. Use ‘item_type=templates’ for template access. It’s an improved version of Update Group Share, offering more granular control.

Input Parameters

string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
A comma-separated list of user IDs whose shared item access is being set. This optional query parameter allows you to specify multiple users for the shared access operation.
string
The account ID associated with the envelope.
string
Specifies the type of shared item being set. Must be one of: - “envelopes”: Set envelope sharing between users. - “templates”: Set information about template sharing among users and groups. - “folders”: Get information about folder sharing among users and groups. This optional query parameter determines the context of the shared access operation.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
array
A list of shared access information of envelope and templates for the users specified in the request.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.
string
A brief message describing the error condition.
string
The code associated with the error condition.
string
When set to “true”, this optional query parameter preserves the existing shared access settings. When “false” or not specified, the existing shared access settings will be replaced by the new settings provided in the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_SIGNATURE_IMAGE_FOR_NO_ACCOUNT_SIGNERThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID. It is required to specify which account the envelope belongs to.
string
required
The globally unique identifier (GUID) for the specific envelope containing the recipient whose signature image needs to be updated. It must be a valid GUID string, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This parameter is required to target the correct envelope.
string
required
A unique identifier for the recipient within the envelope whose signature image is being updated. It can be either an integer or a GUID, but must be unique within the envelope. For example, many envelopes assign the first recipient a recipientId of “1”. This parameter is required to specify which recipient’s signature image to update.
object
required
The signature image file to upload. Supported formats are gif, png, jpeg, and bmp. The file size must be less than 200KB. This image will be used as the signature for the specified accountless signer or in-person signer in the envelope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_TEMPLATES_AS_ACCOUNT_FAVORITESThis 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.

Input Parameters

string
The external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the templates will be set as favorites. It must be provided in the path of the request URL. The value should be a valid DocuSign account identifier, either in the form of an integer or a GUID string.
array
The favorite templates acted upon by the call.
string
A brief message describing the error condition.
integer
The number of templates successfully updated by the call. This property is read-only.
string
The code associated with the error condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_UP_CONNECT_OAUTH_CONFIGURATIONSets up Connect OAuth configuration for the authenticated connection’s DocuSign account using a custom authorization server. It supports OAuth-based communication for Connect webhook notifications and requires Connect to be enabled on the account.

Input Parameters

string
The scopes that your app will request from the authorization server. This property is optional. Note: If you are using Azure, this value is the application ID URI of the secified resource affixed with the .default. For example: api://{{clientId}}/.default
string
The client ID assigned to your app by your authorization server or OAuth service. This property is required.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the Connect OAuth configuration is being set up. This parameter is required and must be provided in the path of the API request. It should be a valid DocuSign account identifier, typically a string of numbers or a UUID.
string
The secret value provided by your authorization server. This property is required.
string
string
The token URL for your authorization server or OAuth service. This property is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SET_USER_SIGNATURE_IMAGEUploads an image for a DocuSign account signature, initials, or stamp. The write normally targets the first account associated with the connection; a supplied account ID is overridden.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). Auto-populated from authentication metadata if not provided.
string
required
Specifies the type of image being set. Must be one of: “signature_image” (for signature), “initials_image” (for initials), or “stamp_image” (for stamp). This determines which signature element is updated.
object
required
The image file to upload as the signature, initials, or stamp image. Supported formats: PNG, JPG, GIF, BMP. Recommended: transparent PNG for best results.
string
required
The unique identifier for the signature to update. You can retrieve signature IDs using the RETRIEVE_USER_SIGNATURE_DEFINITIONS action. This ID identifies which signature element will be modified.
string
Optional query parameter. Set to ‘true’ to indicate the uploaded image has a transparent background. This helps DocuSign optimize the image rendering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SHARE_TEMPLATE_WITH_GROUPThis endpoint allows you to share a DocuSign template with a specified members group. It’s used to grant access to templates for collaboration and reuse within an organization. Note that this endpoint is deprecated, and for newer functionality, it’s recommended to use the ‘Accounts: Update Shared Access’ endpoint instead. The operation updates the sharing settings for a specific template, enabling administrators to control template access across different groups efficiently.

Input Parameters

array
A list of group objects specifying which groups to share the template with. Each group object should include at minimum the ‘groupId’ to identify the group.
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search (optional).
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is auto-populated by the framework from authentication metadata and typically does not need to be provided manually.
string
required
The unique identifier of the template to be shared. This parameter is required and must be provided. It specifies which template will have its sharing settings updated. The templateId should be obtained from a previous template creation or listing operation.
string
The last index position in the result set (optional).
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search (optional).
string
Specifies the part of the template to be shared. For this endpoint, the only valid value is “groups”. This parameter defaults to “groups” and indicates that the sharing operation is specifically for granting access to groups.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize (optional).
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize (optional).
string
The starting index position of the current result set (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_SUBMIT_BATCH_HISTORICAL_ENVELOPES_TO_WEBHOOKThis 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.

Input Parameters

string
The external account number (int) or account ID GUID. This parameter is required and must be provided in the path to identify the DocuSign account for which the historical envelopes will be published.
array
An array of envelope IDs as comma-separated strings. This property is required. For example: ["4280f274-xxxx-xxxx-xxxx-b218b7eeda08","9586h293-xxxx-xxxx-xxxx-m923b8opre71","2347w948-xxxx-xxxx-xxxx-t096b8krno89"]
string
The name of the Connect configuration. This property is required.
array
A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the urlToPublishTo property. Set this property when you are using the JSON SIM event model. If you are instead using any of the legacy event message formats, set either the envelopeEvents property or the recipientEvents property. The possible event statuses are: * envelope-created * envelope-sent * envelope-resent * envelope-delivered * envelope-completed * envelope-declined * envelope-voided * recipient-authenticationfailed * recipient-autoresponded * recipient-declined * recipient-delivered * recipient-completed * recipient-sent * recipient-resent * template-created * template-modified * template-deleted * envelope-corrected * envelope-purge * envelope-deleted * envelope-discard * recipient-reassign * recipient-delegate * recipient-finish-later * click-agreed * click-declined
array
A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. By default, the users will be included in the configuration. If you want to exclude the users, set the allUsersExcept property to true. Note: If allUsers is set to false, then you must provide a list of user IDs.
string
When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is false. Note: If this property is false, make sure you set the userIds property to a non-empty array of user IDs.
array
An array of group IDs whose envelope and recipient events should be tracked. Use this to limit the configuration to specific groups within your account.
string
The password for the Connect configuration. This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.
string
The name of the user.
string
The Docusign-generated ID for the Connect configuration. This property is read-only.
string
When true, Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues. You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the Logs tab in the Connect console.
array
An array of Salesforce objects.
string
The user ID or entity that disabled this Connect configuration. This field is automatically populated when a configuration is disabled.
string
When true, includes an HMAC signature in the Connect notification for message authentication and verification of message integrity.
string
The delivery mode of the configuration. Valid values: * SIM * Aggregate
string
When true, Connect notifications will include OAuth authentication tokens for API callbacks.
string
The namespace of the SOAP interface. Note: If useSoapInterface is set to true, you must set this value.
string
This flag allows you to toggle between including and excluding specified users from the configuration. When false, the users corresponding to the IDs in userIds will be included in the configuration. Conversely, when true, the users will be excluded from the configuration. The default value is false.
array
A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * Delivered * Completed * Declined * Voided Note: These values are case-sensitive.
string
When true, allows envelope senders to override the Connect configuration settings for individual envelopes.
string
The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
array
An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * AutoResponded * Delivered * Completed * Declined * AuthenticationFailed Note: These values are case-sensitive.
string
The ID of an external folder.
string
Reserved for Docusign.
string
When true, Mutual TLS authentication is enabled.
string
When true, the notifications are sent to your endpoint as SOAP requests.
string
The type of the configuration. Valid values: * custom: Creates an account-level configuration * customrecipient: Creates a Recipient Connect configuration * salesforce * eOriginal This property is required.
string
Reserved for Docusign.
string
When true, indicates that this Connect configuration is managed by an integrator or partner application rather than by the account administrator directly.
string
Set this property to restv2.1 to return event data in JSON. If the property is not set, the event data will be returned in XML by default.
string
string
The label for an external folder.
string
Set this value to true to enable the webhook. The default property is false.
string
The version of the Salesforce API that you are using.
string
When true, includes the certificate information in the SOAP header for SOAP-based Connect configurations.
string
When true, the Document Fields associated with the envelope”s documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.
string
array
This property sets the items that are available for selection when adding or editing Connect objects.
string
When true, Docusign sends data to the designated Salesforce account through Connect. The default value is true.
array
A string array of the data to be included. The default is the empty array []. - attachments: Include attachments associated with the envelope. - custom_fields: Include the custom fields associated with the envelope. - documents: Include the documents associated with the envelope. - extensions: Include information about the email settings associated with the envelope. - folders: Include the folder where the envelope exists. - payment_tabs: Include the payment tabs associated with the envelope. - powerform: Include the PowerForms associated with the envelope. - prefill_tabs: Include the pre-filled tabs associated with the envelope. - recipients: Include the recipients associated with the envelope. - tabs: Include the tabs associated with the envelope.
string
When true, event delivery acknowledgements are enabled for your Connect configuration. Docusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back. #### When true and Send Individual Messages (SIM) mode is activated If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down. The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason Pending. When a message succeeds, all queued messages for the configuration will be tried immediately, in order. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When true and SIM mode is not activated If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When false When requiresAcknowledgement is set to false and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.
string
When true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
string
When true, Connect will include the envelope time zone information.
string
When true, the Connect Service includes the Certificate of Completion with completed envelopes.
string
When true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer”s web server) during the TLS handshake protocol.
string
When true, Connect will include the sender account as Custom Field in the data.
string
When true, Docusign can use documents in your Salesforce account for sending and signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_TOGGLE_API_REQUEST_LOGGINGThis 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.

Input Parameters

string
When true, enables API request logging for the user.
string
Specifies the maximum number of API requests to log.
string
Indicates the remaining number of API requests that can be logged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_BRAND_SETTINGSThe 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.

Input Parameters

An array of brandLink objects that contain information about the links that the brand uses.
array
An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text
string
required
The ID used to identify a specific brand in API calls.
string
The unique identifier for the DocuSign account. It can be either the external account number (integer) or the account ID GUID (string). This parameter is required to specify which account”s brand is being updated.
string
The name of the brand.
string
The name of the company associated with the brand.
array
Deprecated.
array
An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used.
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
string
A boolean flag that determines whether to replace the entire brand or update specific fields. When set to true, it replaces the entire brand configuration, keeping only the brand ID unchanged. When false or omitted, it updates only the provided fields. The default value is false. This parameter must be specified as a query parameter in the request URL.
array
An array of two-letter codes for the languages that you want to use with the brand. The supported languages are: - Arabic (ar) - Armenian (hy) - Bahasa Indonesia (id) - Bahasa Malay (ms) - Bulgarian (bg) - Chinese Simplified (zh_CN) - Chinese Traditional (zh_TW) - Croatian (hr) - Czech (cs) - Danish (da) - Dutch (nl) - English UK (en_GB) - English US (en) - Estonian (et) - Farsi (fa) - Finnish (fi) - French (fr) - French Canada (fr_CA) - German (de) - Greek (el) - Hebrew (he) - Hindi (hi) - Hungarian (hu) - Italian (it) - Japanese (ja) - Korean (ko) - Latvian (lv) - Lithuanian (lt) - Norwegian (no) - Polish (pl) - Portuguese (pt) - Portuguese Brasil (pt_BR) - Romanian (ro) - Russian (ru) - Serbian (sr) - Slovak (sk) - Slovenian (sl) - Spanish (es) - Spanish Latin America (es_MX) - Swedish (sv) - Thai (th) - Turkish (tr) - Ukranian (uk) - Vietnamese (vi)
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
boolean
When true, the sending brand is the default brand for sending new envelopes.
boolean
When true, the siging brand is the default brand for the signing experience.
string
The URI for the brand”s secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use AccountBrands: updateLogo.
string
The URI for the email resource file that the brand uses.
string
The URI for the sending resource file that the brand uses.
string
The URI for the signing resource file that the brand uses.
string
string
The two-letter code for the language that you want to use as the brand default. The supported languages are: - Arabic (ar) - Armenian (hy) - Bahasa Indonesia (id) - Bahasa Malay (ms) - Bulgarian (bg) - Chinese Simplified (zh_CN) - Chinese Traditional (zh_TW) - Croatian (hr) - Czech (cs) - Danish (da) - Dutch (nl) - English UK (en_GB) - English US (en) - Estonian (et) - Farsi (fa) - Finnish (fi) - French (fr) - French Canada (fr_CA) - German (de) - Greek (el) - Hebrew (he) - Hindi (hi) - Hungarian (hu) - Italian (it) - Japanese (ja) - Korean (ko) - Latvian (lv) - Lithuanian (lt) - Norwegian (no) - Polish (pl) - Portuguese (pt) - Portuguese Brasil (pt_BR) - Romanian (ro) - Russian (ru) - Serbian (sr) - Slovak (sk) - Slovenian (sl) - Spanish (es) - Spanish Latin America (es_MX) - Swedish (sv) - Thai (th) - Turkish (tr) - Ukranian (uk) - Vietnamese (vi)
string
A brief message describing the error condition.
string
string
The code associated with the error condition.
boolean
When true, the brandCompany property is overriding the name of the company in the account settings.
string
The URI for the captive (embedded) signing resource file that the brand uses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_CUSTOM_FIELDThis 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.

Input Parameters

string
The name of the custom field.
string
When true, the custom field displays at the top of the Certificate of Completion.
string
Specifies the value of the custom field. Maximum Length: 2,000 characters.
string
The ID of the custom field.
string
When true, the signer must complete the custom field.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account”s custom field is being updated. The value must be a non-empty string representing a valid DocuSign account identifier.
array
For a list custom field, this is an array of strings that represent the items in a list. Maximum Length: 2,000 characters.
string
required
The unique identifier of the custom field to be updated. This ID is required to target the specific custom field for modification. It must be a non-empty string that corresponds to an existing custom field within the specified account.
string
The type of custom field. Valid values are: - text (default) - list
string
An optional query parameter that determines whether the updated custom field should be applied to templates. When set to “true”, the changes will be reflected in templates that use this custom field. When omitted or set to “false”, the update only affects the custom field at the account level without modifying existing templates. The value should be a string, either “true” or “false”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_PASSWORD_RULESUpdates password rules for the authenticated user’s first DocuSign account, including expiration, password complexity, lockout duration, and security question requirements. Changes affect account password policy.

Input Parameters

string
The external account number (integer) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the password rules will be updated. It must be provided in the path of the request. The value should be a valid account identifier within your DocuSign environment.
string
When true, passwords expire. The default value is false.
string
The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is 0.
string
The number of days before passwords expire. To use this property, the expirePassword property must be set to true.
string
The interval associated with the user lockout after a failed login attempt. Possible values are: - minutes (default) - hours - days
string
When true, passwords must include a digit. The default value is false.
string
The type of password strength. Possible values are: - basic: The minimum password length is 6 characters with no other password requirements. - medium: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character. - strong: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character. - custom: This option enables you to customize password requirements, including the following properties: - minimumPasswordLength - minimumPasswordAgeDays - passwordIncludeDigit - passwordIncludeDigitOrSpecialCharacter - passwordIncludeLowerCase - passwordIncludeSpecialCharacter - passwordIncludeUpperCase - questionsRequired
string
The minimum number of characters in the password. This value must be a number between 6 and 15. The default value is 6.
string
The number of minutes a user is locked out of the system after three failed login attempts. The default value is 2.
string
The minimum number of days after a password is set before it can be changed. This value can be 0 or more days. The default value is 0.
string
When true, passwords must include a lowercase letter. The default value is false.
string
When true, passwords must include an uppercase letter. The default value is false.
string
When true, passwords must include a special character. The default value is false. Note: Passwords cannot include angle brackets (< >) or spaces.
array
An array of option strings supported by this setting.
array
An array of option strings supported by this setting.
string
When true, passwords must include either a digit or a special character. The default value is false. Note: Passwords cannot include angle brackets (< >) or spaces.
string
The maximum number of days allowed for password expiration.
string
The minimum number of days allowed for password expiration.
string
The maximum number of days allowed for minimum password age.
string
The minimum number of days allowed for minimum password age.
string
The maximum number of password reset questions allowed for the account. This number must be between 0 and 4, and equal to or greater than minimumQuestions.
string
The minimum number of password reset questions allowed for the account. This number must be between 0 and 4, and equal to or less than maximumQuestions.
string
The maximum number of entry characters supported by the custom tab.
string
Minimum length of the access code string.
string
The maximum number of minutes allowed for account lockout duration.
string
The minimum number of minutes allowed for account lockout duration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_SETTINGSUpdates settings for the authenticated user’s first resolved DocuSign account, including security, compliance, and user interface options. Many settings require administrative privileges and some depend on other features.

Input Parameters

string
When true, the account can use the API. Note: Only SysAdmin users can change this setting.
string
string
When true, this user can use the bulk send feature for the account.
string
The external account number (int) or account ID GUID. This parameter is required to identify the specific DocuSign account for which settings will be updated. It must be a valid account identifier within your organization”s DocuSign environment.
string
string
The name on the account.
string
When true, the Document Markup feature is enabled. Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
string
Specifies how auto-navigation works. Valid values are: - off - required_fields - required_and_blank_fields - all_fields - page_then_required_fields - page_then_required_and_blank_fields - page_then_all_fields
string
Reserved for Docusign.
string
Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.
string
Boolean that specifies whether to hide the pricing functionality for an account.
string
string
When true, the account administrator can enable the Sign Now feature.
string
string
When true, bulk send functionality is enabled for the account. Note: Only Admin users can change this setting.
string
When true, the account administrator can enable in-person signing. Note: Only SysAdmin users can change this setting.
string
string
When true, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope. Note: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set.
string
When true, fax delivery to recipients is allowed for the account. Note: Only Admin users can change this setting.
string
Determines when a user”s authentication with the account expires. Valid values are: - always: Users are required to authenticate each time. - variable: If the authentication for a user is valid and falls within the value for the idCheckExpireDays property, the user is not required to authenticate again. Note: Only Admin users can change this setting.
string
When true, show tutorials.
string
When true, Signature Adoption Configuration is enabled. Note: Only Admin users can change this setting.
string
When true, IDV Level 1 is allowed. The default value is false.
string
string
string
When true, an account administrator can to turn on reminders and expiration defaults for the account. Note: Only Admin users can change this setting.
string
When true, Vaulting is enabled for the account.
string
string
The user ID for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
string
The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Reserved for Docusign.
string
When true, the Advanced Correction feature is enabled for this account.
string
When true, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is false. Note: Only Admin users can change this setting.
string
If the account plan does not include calculated fields, this setting allows an account to use them.
string
When true, shared tabs are enabled for the account. Note: Only Admin users can change this setting.
string
Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.
string
Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.
string
string
When true, enables PowerForms for the account. Note: Only SysAdmin users can change this setting.
string
Indicates if authentication is configured for the account. Valid values are: - always: Authentication checks are performed on every envelope. - never: Authentication checks are not performed on any envelopes. - optional: Authentication is configurable per envelope. Note: Only Admin users can change this setting.
string
The RSA rule set used with the account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
string
When true, auto-tagging is enabled for the account.
string
string
When true, the account can use merge fields with Docusign for Salesforce.
string
string
When true, account administrators can self-brand their sending console through the Docusign console.
string
When true, account administrators can self-brand their signing console through the Docusign console.
string
Boolean that specifies whether to enable PDF form fields to get converted to Docusign secure fields when the document is added or uploaded to an envelope.
string
When true, the mobile app distributor key is prevented from connecting for account users.
string
Boolean that specifies whether clickwraps are enabled in your app. A clickwrap is an iframe that you embed in your own website or app.
string
Reserved for Docusign.
string
string
When true, the account can send in-session (embedded) envelopes. Note: Only Admin users can change this setting.
string
The password for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
string
When true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. When false, only the email will be affected when the sender specifies a unique language for a recipient. Note: Only Admin users can change this setting.
string
When true, the time shows the AM or PM indicator.
string
Reserved for Docusign.
string
Specifies the time zone to use in the UI. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
Reserved for Docusign.
string
Valid values are: - docusign - account
string
When true, the watermark feature is enabled for the account.
string
When true, senders can download form data from the envelopes that they send. Note: Only Admin users can change this setting.
string
When true, eHanko stamps are enabled.
string
string
Boolean that specifies whether to display a Beta switch for your app.
string
Sets a document retention period, which controls the number of days that Docusign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is 356 days.
Enables direct links to envelopes in reports for administrators in the following scopes: - NoEnvelopes - AllEnvelopes - OnlyOwnEnvelopes
string
When true, this account can use the Agent recipient type. Note: Only SysAdmin users can change this setting.
string
When true, a sender can allow signers to use the sign on paper option. Note: Only Admin users can change this setting.
string
The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session. Note: Only Admin users can change this setting.
string
When true, senders can set the email language to use for each recipient. Note: Only Admin users can change this setting.
string
When true, recipients can use social ids when signing
string
Specifies the time zone to use with the API. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
Valid values are: - none - life_sciences_part11
string
When true, Managed Stamps are enabled.
string
Boolean that specifies whether Docusign Admin is enabled for the account.
string
When true, the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only.
string
Deprecated.
string
string
When true, the User Sharing feature is disabled for the account.
string
Configures the Document Visibility feature for the account. Valid values are: - Off: Document Visibility is not active for the account. - MustSignToViewUnlessSenderAccount: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope. - MustSignToViewUnlessSender: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope. - SenderCanSetMustSignToViewUnlessSenderAccount: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account. Vd- SenderCanSetMustSignToViewUnlessSender: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender. Note: For this configuration to take effect, allowDocumentVisibility must be set to true.
string
When true, this account can use the Editor recipient type. Note: Only Admin users can change this setting.
string
array
Names of electronic or digital signature providers that can be used.
string
When true, signer attachments are added to the parent document that contains the attachment. The default behavior creates a new document in the envelope for every signer attachment. Note: Only Admin users can change this setting.
string
Boolean that specifies whether validations on recipient email domains are allowed.
string
Valid values are: - none - monthly
string
When true, enables validations.
string
string
“true” if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, “false” otherwise.
string
Specifies whether eNote eOriginal integration is enabled.
string
string
When true, account users can set their own time zone settings. Note: Only Admin users can change this setting.
string
Specifies whether users can use international numbers for phone authentication.
string
When true, offline signing is enabled for the account. Note: Only Admin users can change this setting.
string
When true, the recipient of an envelope sent from this account can reassign it to another person. Note: Only Admin users can change this setting.
string
Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: - Phone Authentication - SMS Authentication - Knowledge-Based ID This setting takes one of the following options: - initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account. - each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame. Note: Only Admin users can change this setting.
string
A fax number associated with the address, if one is available.
string
Specifies how data is shared for tabs with the same tabLabel. Valid values are: - document: Tabs in a document with the same label populate with the same data. - envelope: Tabs in all documents in the envelope with the same label populate with the same data. - notset: Use the global account setting. This setting applies to the following tab types: - Check box - Company - Data field - Drop-down list - Full name - Formula - Note - Title Note: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed.
string
Account Level Flag that determines the availability to use ADM Healthcare fields
string
string
Deprecated.
string
When true, enables strikethrough formatting in documents.
string
The RSA account name. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
string
string
The account-wide default font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
string
The account-wide default font size used for the information in the tab: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72
string
When true, single sign-on (SSO) is enabled.
string
string
When true, auto-navigation can be enabled for this account.
string
string
When true, the envelope correction feature is enabled. Note: Only Admin users can change this setting.
string
When true, the account can use templates.
string
Metadata that indicates whether the allowSignNow property is editable.
string
When true, Signature Stamps are enabled. Note: Only Admin users can change this setting.
string
string
The user”s city. Maximum length: 40 characters.
string
When true, sending from a mobile application is disabled. Note: Only Admin users can change this setting.
string
Specifies the version of the email templates used in an account. If new signing is selected in a member”s Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account.
string
string
When true, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as @exampledomain.com. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users. - Domains may be claimed by an organization. - When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts. - You can set domain controls for all users of the domain. - You can export information about your organization’s users that are associated with your reserved domains. Note: Only SysAdmin users can change this setting.
string
When true, Sign with Notary functionality is enabled for the account. Note: Only Admin users can change this setting.
string
When true, blockchain-based Smart Contracts are enabled. The default value is false.
string
Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).
string
The number of minutes before user authentication credentials expire.
array
Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients” identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
string
The maximum number of signing groups allowed on the account. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
string
The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are 1 to 120 minutes. The default value is 20 minutes. Note: Only Admin users can change this setting.
string
When true, signers who decline to sign an envelope sent from this account are required to provide a reason for declining. Note: Only Admin users can change this setting.
string
The account-wide default font color to use for the content of the tab. Valid values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
string
Reserved for Docusign.
string
UTC date/time format for the account.
string
When true, the configured Access Code Format page is enabled for account administrators. Note: Only Admin users can change this setting.
string
string
string
string
“true” if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, “false” otherwise.
string
string
This property determines how template anchor tabs are applied. Valid values are: - document: Anchor tabs are applied only to the document that you specify. - envelope: Anchor tabs are applied to all of the documents in the envelope associated with the template. Note: When you are using the anchorPopulationScope property with a Composite Template, the value document is supported only with a single server template and a single inline template.
string
A phone number associated with the address.
string
string
Reserved for Docusign.
string
When true, signers cannot view certificates of completion.
string
When true, the Select Style option is hidden from signers and they must draw their signature instead.
string
string
string
When true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. Note: Only Admin users can change this setting.
array
A list of ID check configuration objects.
string
string
Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.
string
Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.
string
Boolean that specifies whether an account can use Shared Template Folders.
string
When true, recipients can sign on a mobile device. Note: Only Admin users can change this setting.
string
When true, senders can only send an envelope to a recipient that has a Docusign account. Note: Only Account Administrators can change this setting.
string
When true, signers must log in to the Docusign platform to sign an envelope. Note: Only Admin users can change this setting.
string
The number of minutes that a signing session stays alive without any activity.
string
When true, the account uses an Electronic Record and Signature Disclosure Statement. Note: Only Admin users can change this setting.
string
string
string
Specifies whether the account has access to reports.
string
When true, payment processing is enabled for the account. Note: Only Admin users can change this setting.
string
Boolean that specifies whether users can override phone authentication.
string
Boolean that specifies whether a Docusign Signature Appliance can be used with the account.
string
Boolean that specifies whether Signing and App Extensions are allowed.
string
Boolean that specifies whether the signers of the envelopes from this account use a signature with a Docusign chrome around it or not.
string
When true, signers cannot upload custom image files of their signature and initials. Note: Only Admin users can change this setting.
string
string
When true, enables Advanced Payments for the account.
string
When true, calculated fields are enabled for the account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowExpression is set to true.
string
string
string
When true, scheduled releases are enabled. The default value is false.
string
Reserved for Docusign.
string
string
When true, HTML used to implement Guided Forms is enabled for the account.
string
When true, in-person signing is enabled for the account.
string
When true, a signer can create a Docusign account after signing. Note: Only Admin users can change this setting.
string
When true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.
string
When true, an agent recipient can change the email addresses of recipients later in the signing order.
string
When true, the Document Visibility feature is enabled for the account.
string
When true, the account admin can enable the Send to Intermediary feature on the account.
string
When true, envelope documents are included as a PDF file attachment to “signing completed” emails. Note: Only SysAdmin users can change this setting.
string
Reserved for Docusign.
string
The user”s country. Maximum length: 50 characters.
string
When true, account users cannot be logged into multiple sessions at the same time. Note: Only Admin users can change this setting.
string
When true, payment processing is enabled for this account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowPaymentProcessing is set.
string
When true, enables responsive signing.
string
When true, the account can use SMS authentication. Note: Only Admin users can change this setting.
string
When true, users can use the signing attachments feature to request attachments from signers. Note: Only Admin users can change this setting.
string
string
Boolean that specifies whether to hide the account address in the Certificate of Completion.
string
A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient”s response to this question is saved and can be viewed in the certificate associated with the envelope. Note: Only Admin users can change this setting.
string
When true, emails are not sent to the in-session (embedded) recipients on an envelope. Note: Only Admin users can change this setting.
string
The maximum number of custom stamps.
string
Boolean that specifies whether localized watermarks are displayed.
string
Sets the login requirements for signers. Valid values are: - login_not_required: Signers are not required to log in. - login_required_if_account_holder: If the signer has a Docusign account, they must log in to sign the document. - login_required_per_session: The sender cannot send an envelope to anyone who does not have a Docusign account. - login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a Docusign account, and the signer must also log in for each envelope they will sign. Note: Only Admin users can change this setting. If you use Direct PowerForms or captive (embedded signers), the “Account required” settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Boolean that specifies whether disclosure documents can be included in envelopes.
string
Boolean that specifies whether phone authentication is enabled for the account.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, conditional fields can be used in documents. Note: Only Admin users can change this setting.
string
When true, signers cannot view envelope history.
string
When true, enables advanced PowerForms for the account.
string
string
string
string
When true, the account can use the requireSignOnPaper option. Note: Only Admin users can change this setting.
string
string
When true, this account can use the Intermediary recipient type. Note: Only Admin users can change this setting, and only if allowSendToIntermediary is set.
string
Specifies the signature pad type. Valid values are: - none - topaz - e_padv9 - e_pad_integrisign - topaz_sigplusextlite Note: Only Admin users can change this setting.
string
string
The policy for adding a digital certificate to downloaded, printed, and emailed documents. Possible values are: - no_sign - no_sign_allow_user_override - yes_sign (Specifies that PDF files downloaded from the platform are signed.) Note: Only Admin users can change this setting.
string
When true, recipients receiving envelopes from this account can sign offline. Note: Only Admin users can change this setting.
string
When true, simplified sending is enabled for the account. The default value is false.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Specifies whether envelope custom fields are enabled.
string
When true, the account can configure and use signature pads for their recipients. Note: Only Admin users can change this setting.
string
string
string
Reserved for Docusign. This property returns the value false when listing account settings. This property is read-only.
string
When true, resource files can be uploaded in branding.
string
Boolean that specifies whether the account supports radio buttons on tabs Radio CustomTabType.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, enables Access Code Generator on the account.
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
When true, senders can specify the visibility of the documents in an envelope at the recipient level.
string
When true, signers are required to use SAFE digital signatures.
string
Specifies whether the account supports multiple brands.
string
When true, this user can include supplemental documents.
string
string
Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)
string
The user”s postal code. Maximum length: 20 characters.
string
When true and documentRetention is set, document fields and metadata are also purged after the document retention period ends. The default value is false. Note: Only Admins can change this setting.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: - not_allowed - full Note: Only SysAdmin users can change this setting.
string
When true, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account. Note: Only Admin users can change this setting, and only when envelopeIntegrationAllowed is set.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The number of active custom stamps associated with the account. Docusign calculates this number automatically. This property is only visible to the Docusign account manager.
string
string
When true, recipients are required to use a 21 CFR part 11-compliant signing experience. Note: Only Admin users can change this setting.
string
When true, do not require authentication prompt for viewing completed envelopes
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, an account administrator can override the ability of an envelope recipient to reassign it to another person. Note: Only Admin users can change this setting.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the text of comments is included in email notifications when a comment is posted. Note: If the envelope requires additional recipient authentication, comment text is not included.
string
Speficies how often to display the consumer disclosure. Valid values are: - once: Per account, the supplemental document is displayed once only per userId. - always: Per envelope, the supplemental document is displayed once only per userId. - each_access: Per envelope, the supplemental document is displayed once only per recipientId.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The maximum number of users per signing group. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
string
string
When true, a signer can draw their signature in each location where a sign or initial tab exists. This functionality is typically used for mobile signing. Note: Only Admin users can change this setting.
string
The smallest screen allowed.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Boolean that specifies whether member names can be changed in the account.
string
string
string
Specifies whether the account is able to manage rules that transfer ownership of envelopes within the same account.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the account admin can enable the Send to Certified Delivery feature on the account.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Sets the Digital Signature certificate requirements for sending envelopes. Valid values are: - none: A Digital Signature certificate is not required. - docusign_express: Signers must use a Docusign Express certificate. - docusign_personal: Signers must use a Docusign personal certificate. - safe - open_trust: Signers must use an OpenTrust certificate.
string
When true, Conditional Routing options display to senders during the sending experience.
string
Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).
string
Boolean that specifies whether the account uses the digital signature provider platform to eSign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, envelope publishing reporting is enabled. Note: Only Admin users can change this setting.
string
When true, signers are required to use Express Digital Signatures. Note: Only Admin users can change this setting.
string
Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, recipients can sign documents from the home page. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true and comments are enabled for the account, senders can disable comments for an envelope through the Advanced Options menu that appears during the sending process.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, enables fonts to be set on tags for the account.
string
When true, the template name must be unique.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the account requires external management of users. Note: Only Admin users can change this setting.
string
When true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, account users must both view and accept supplemental documents when signing.
string
When true, account users must view supplemental documents when signing.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the account can be managed on a per-user basis. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, recipients can upload multiple signer attachments with a single attachment. Note: Only Admin users can change this setting.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, push notifications are disabled for the account. Note: Only Admin users can change this setting.
string
Sets the account document upload restriction for non-account administrators. Valid values are: - no_restrictions: There are no restrictions on the type of documents that can be uploaded. - allow_pdf_only: Non-administrators can only upload PDF files. - no_upload: Non-administrators cannot upload files. Note: Only Admin users can change this setting.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, the account can use the certified deliveries recipient type.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Boolean that specifies whether or not API calls require a x509 cert in the header of the call.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, sent reminders are included in the envelope history.
string
Minimum length of the access code string.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Boolean that specifies whether a Connect configuration can use HTTP listeners.
string
When true, the account has the ability to change the Consumer Disclosure setting.
string
Boolean that specifies whether notifications can include the envelope”s signed document.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, senders can use OpenTrust signer certificates. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Account level flag that determines the availability to perform Third Party Notary (3PN) actions.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The user”s state or province. Maximum length: 40 characters.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, enables the Docusign administrator to control envelope stamping for an account (placement of the envelopeId).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, account users must accept supplemental documents when signing.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Boolean specifying whether this format configuration is required.
string
Boolean specifying whether alphabetical characters are required in the access code string.
string
Boolean specifying whether numerical characters (0-9) are required in the access code string.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Boolean that specifies whether resource files can be used for extended sending.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
Reserved for Docusign.
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, account users can set a tab order for the signing process. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
Indicates whether the property is editable. Valid values are: - editable - read_only
Reserved for Docusign.
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
An array of option strings supported by this setting.
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the initial values of all SecureFields are written to the document when it is sent. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the Templates menu is hidden from account users who are not Admins. The default value is false.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, account administrators can specify that signers are required to use SAFE-BioPharma digital signatures. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
An array of option strings supported by this setting.
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, enables conversation functionality.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, list tabs are enabled.
string
When true, note tabs are enabled.
string
Reserved for Docusign.
string
When true, text tabs are enabled.
string
When true, signers are required to use Express Digital Signatures.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, enables the account administrator to control envelope stamping for an account (stamping the envelopeId in the document margins). Note: This setting can be changed only by Admin users, and only if the account-level setting enableEnvelopeStampingByDSAdmin is set to true.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, switches Signing Order to On by default for new envelopes.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the Certificate of Completion is included in the PDF of the envelope documents when it is downloaded. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, radio button tabs are enabled.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, recipients receiving envelopes from this account can override auto-navigation functionality. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, tab locking is enabled. Note: Only Admin users can change this setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The account is enabled to allow external documents to be attached from BoxNet.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
The account is enabled to allow external documents to be attached from DropBox.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders can allow recipients to provide a phone number for the Phone Authentication process. Note: Only Admin users can change this setting.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, an “envelope complete” email is sent to an in-session (embedded) or offline signer after Docusign processes the envelope if in-session emails are not suppressed. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, checkbox tabs are enabled.
string
When true, data labels are enabled. Note: Only Admin users can change this setting.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the user can override envelope expirations.
string
When true, Conditional Routing is enabled for the account as part of Docusign”s Advanced Recipient Routing feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, enables customer satisfaction metric tracking for the account.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The account is enabled to allow external documents to be attached from OneDrive.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, setting character limits for input fields is enabled.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, regular expressions are enabled for tabs that contain data fields.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters ”<”, ”>”, ”&”, or ”#”.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The account is enabled to allow external documents to be attached from Salesforce.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
The account is enabled to allow external documents to be attached from Google Drive.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, calculated fields are enabled for tabs.
string
When true, saving custom tabs is enabled.
string
When true, shared custom tabs are enabled.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent.
string
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting. Note: Only Admin users can change this account setting.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
An integer that sets the number of days the envelope is active. For this value to be used, expireEnabled must be explicitly set to true.
string
An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0.
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, approve and decline tabs are enabled.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the envelope expires in the number of days set by expireAfter. When false or not set, the envelope expires in the number of days specified by the default expiration account setting.
string
When true, reminders are enabled. The default value is false.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Org level flag that determines the availability to perform Third Party Notary (3PN) actions.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
An integer specifying the interval in days between reminder emails. The default value is 0.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
Indicates whether the property is editable. Valid values are: - editable - read_only
Reserved for Docusign.
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
An array of option strings supported by this setting.
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_STAMP_BY_IDUpdates an existing account stamp by ID in the authenticated user’s first resolved DocuSign account, including properties such as font, size, associated users, and permissions.

Input Parameters

string
The National Association of Realtors (NAR) membership ID for a user who is a realtor.
string
The unique identifier for the DocuSign account. This can be either the external account number (an integer) or the account ID GUID. It is required to specify which account the stamp belongs to. For example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
Specificies the type of image. Valid values: - stamp_image - signature_image - initials_image
string
Boolean that specifies whether the signature is the default signature for the user.
string
Optionally specify an external identifier for the user”s signature.
string
required
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as ”&”, ”<”, ”>”) in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
string
The format of a stamp. Valid values are: - NameHanko: The stamp represents only the signer”s name. - NameDateHanko: The stamp represents the signer”s name and the date.
string
The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
string
The realtor”s last name.
string
The phonetic spelling of the signatureName.
string
The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not enums. - "1_DocuSign" - "2_DocuSign" - "3_DocuSign" - "4_DocuSign" - "5_DocuSign" - "6_DocuSign" - "7_DocuSign" - "8_DocuSign" - "Mistral" - "Rage Italic"
string
Specifies the user”s signature name.
string
Specifies the type of signature.
array
array
string
Specifies the user”s signature in initials format.
string
When true, users may not resize the stamp.
string
An optional query parameter that, when set to “true”, closes the current signature before updating it. This can be useful for ensuring a clean update process. Valid values are “true” or “false”. If not specified, the default behavior is to update the signature without closing it first.
string
The X axis position of the top-left corner.
string
The Y axis position of the top-left corner.
string
The width of the rectangle.
string
The height of the rectangle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_STAMPSUpdate existing account stamps (signatures) in a DocuSign account. Modifies properties of existing stamps by referencing their signatureId. Supports updating names, sizes, formats (NameHanko/NameDateHanko), resize permissions, phonetic names, and external IDs. Supports batch updates of multiple stamps in one request. Note: The signatureId changes after each update. Use DOCUSIGN_ADD_OR_UPDATE_ACCOUNT_STAMPS to create new stamps. At least one stamp must be included in the request.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the request URL. It should be a valid string representing either a numeric account number or a GUID format account identifier.
array
Array of stamp objects to update. Each stamp must include its signatureId to identify which stamp to modify. You can update multiple stamps in a single request. Include only the fields you want to change - unchanged fields will retain their current values. Common fields to update: signatureName, stampSizeMM, stampFormat, disallowUserResizeStamp, phoneticName, externalID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_INFORMATIONThis 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.

Input Parameters

string
The ID of the watermark.
string
The watermark’s font. Valid values: ‘courier’, ‘helvetica’, ‘timesnewroman’.
string
When ‘true’, the watermark will be applied to documents that are still in progress. When ‘false’, the watermark will not be applied. Specify as a string.
string
The watermark’s font size. Valid values: ‘30’, ‘40’, ‘50’, ‘60’, ‘70’, ‘80’, ‘90’. Specify as a string.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (string). Required parameter used to specify which account”s watermark settings are being updated.
string
The watermark’s font color. Valid values: ‘black’, ‘blue’, ‘red’, ‘gray’, ‘yellow’.
string
The Base64 representation of the watermark image. This property is read-only.
string
The display angle of the watermark. Valid values: ‘0’ (horizontal), ‘45’ (diagonal), ‘90’ (vertical). Specify as a string.
string
The transparency percentage of the watermark image. Valid values: ‘5’, ‘10’, ‘15’, ‘20’, ‘25’, ‘30’, ‘35’, ‘40’, ‘45’. Specify as a string.
string
The text to display as the watermark on in-progress documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_PREVIEWUpdates and previews watermark settings for a DocuSign account before applying them. This endpoint allows you to test watermark appearance settings including text, font, color, size, display angle, and transparency without permanently saving the configuration. Use this action when you want to preview how watermark customizations will look on documents before committing to the changes. The watermark preview shows how the settings will appear on in-progress documents. Note: All parameters are optional. If not specified, existing watermark settings will be preserved. Parameters with specific valid values (fonts, colors, angles, etc.) will use defaults if invalid values are provided.

Input Parameters

string
The unique identifier of the watermark configuration. REQUIRED for preview requests. Use the Get Account Watermark Details action to retrieve the current watermark ID before calling this endpoint.
string
The font family for the watermark text. Must be one of: ‘courier’, ‘helvetica’, or ‘timesnewroman’. Defaults to a standard font if not specified.
string
Controls whether the watermark is applied to in-progress documents. Use ‘true’ to enable watermarks or ‘false’ to disable them. Watermarks only appear on documents that are not yet completed.
string
The size of the watermark text in points. Must be one of: ‘30’, ‘40’, ‘50’, ‘60’, ‘70’, ‘80’, or ‘90’. Larger values create more prominent watermarks.
string
The DocuSign account ID (GUID format) or external account number that identifies the account. This parameter is automatically populated from your authentication credentials and typically does not need to be provided manually.
string
The color of the watermark text. Must be one of: ‘black’, ‘blue’, ‘red’, ‘gray’, or ‘yellow’. Defaults to a standard color if not specified.
string
Base64-encoded image data for a custom watermark image. Note: This field is read-only in API responses and cannot be set through this endpoint. Use text-based watermarks instead.
string
The display angle of the watermark on documents. Must be one of: ‘0’ (horizontal), ‘45’ (diagonal), or ‘90’ (vertical). Defaults to horizontal if not specified.
string
The opacity level of the watermark as a percentage. Must be one of: ‘5’, ‘10’, ‘15’, ‘20’, ‘25’, ‘30’, ‘35’, ‘40’, or ‘45’. Lower values create more transparent (less visible) watermarks, while higher values create more opaque (more visible) watermarks.
string
The text content to display as the watermark. This text will appear on in-progress documents according to the font, color, size, angle, and transparency settings specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_BILLING_PLAN_FOR_ACCOUNTUpdates 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account”s billing plan information should be updated.
string
Tax exemption identifier if the account qualifies for tax-exempt status
string
When true, pre-authorization of payment methods is enabled for the account
string
When true, customer support is provided as part of the account plan.
string
The number of seats (users) included in the plan.
string
The payment method used for the billing plan. Valid values are: - NotSupported - CreditCard - PurchaseOrder - Premium - Freemium - FreeTrial - AppStore - DigitalExternal - DirectDebit
string
The renewal status of the account. Possible values are: - auto: The account automatically renews. - queued_for_close: The account will be closed at the billingPeriodEndDate. - queued_for_downgrade: The account will be downgraded at the billingPeriodEndDate`.
string
When true, immediately process the payment for the billing plan update
string
(Optional) The user”s reason for downgrading their billing plan.
string
Reserved for Docusign.
string
The payment processor used for handling billing transactions (e.g., ‘stripe’, ‘paypal’)
string
Reserved for Docusign.
string
The fax number associated with the account.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The city associated with the address. Maximum length: 40 characters.
string
An optional query parameter that, when set to “true”, allows you to preview the changes to the billing plan without actually applying them. This is useful for checking the potential impact of updates before committing to them. The preview will return the same information as an actual update but without modifying the account. If not specified or set to “false”, the changes will be applied immediately.
string
The email address associated with the account.
string
The phone number associated with the account.
string
The state or province associated with the address. Maximum length: 40 characters.
string
The country associated with the address. Maximum length: 50 characters.
array
Reserved for Docusign.
string
Docusign”s ID for the account plan.
string
Reserved for Docusign.
string
The first line of the address. Maximum length: 100 characters.
string
The second line of the address. Maximum length: 100 characters.
string
The last name of the user associated with the account.
string
The first name of the user associated with the account. Maximum Length: 50 characters.
string
The Product ID from the AppStore.
string
The postal code associated with the address. Maximum length: 20 characters.
string
Type of identifier used in the referral information
string
Reserved for Docusign.
string
Specifies the ISO 4217 currency code for the account.
string
The name of the industry associated with the referral. Example: Accounting
string
Reserved for Docusign.
string
Promotional code applied to the referral for discounts or special offers
string
Shopper identifier for e-commerce referral tracking
string
The type of credit card. Valid values are: - visa - mastercard - amex
string
The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs).
array
Reserved for Docusign.
string
Publisher identifier for affiliate or partner referral tracking
string
The credit card number.
string
The exact name as it appears on the credit card.
array
List of authorized email domains for envelope recipients associated with this billing plan
string
Unique referral code used to track the source of this account signup
string
The name of the referrer.
array
An array of supported countries associated with the account.
string
The email address associated with the payment processor.
string
When true, customer support is provided as part of the account plan.
string
An optional external ID for the referral.
string
Group member identifier for referral tracking purposes
string
The number of seats (users) included in the plan.
string
Product ID for the downgraded plan when downgrading via AppStore
string
A fax number associated with the address, if one is available.
string
Month when the billing plan starts (e.g., ‘1’ for January, ‘12’ for December)
string
The user”s city. Maximum length: 40 characters.
string
Tokenized representation of the credit card for secure storage (instead of raw card number)
string
A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.
string
A phone number associated with the address.
string
Last 4 digits of the credit card number (read-only, returned by API)
string
The year in which the credit card expires, in 4-digit format.
string
The International Bank Account Number (IBAN). Example: DE89370400440532013000 For more information, see PeopleSoft”s guide to Setting Up Banks. Note: This number will be obfuscated.
string
The month that the credit card expires, expressed as a number from 1 to 12.
string
The email address of the user who is associated with the payment method. This field is required for POST and PUT requests. Maximum Length: 80 characters.
string
Reserved for Docusign.
string
The user”s country. Maximum length: 50 characters.
string
Reserved for Docusign.
string
Indicates whether the downgrade is a cancellation (e.g., ‘true’ or ‘false’)
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
ZIP+4 extension code (4 additional digits after the standard 5-digit ZIP code)
string
The user”s country. The system populates this value automatically.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The code or number that identifies the bank. This is also known as the sort code. Example: 200000 Maximum Length: 18 characters.
string
The name of the direct debit bank. Maximum Length: 80 characters.
string
The user”s last name. This field is required for POST and PUT requests. Maximum Length: 70 characters.
string
A fax number associated with the address, if one is available.
string
The user”s postal code. Maximum length: 20 characters.
string
The user”s first name. This field is required for POST and PUT requests. Maximum Length: 30 characters.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
Reserved for Docusign.
string
The user”s country. Maximum length: 50 characters.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
ZIP+4 extension code for payment processor address (4 additional digits after the standard 5-digit ZIP code)
string
The user”s state or province. Maximum length: 40 characters.
string
The branch code of the bank used for direct debit. Maximum Length: 10 characters.
string
The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account. Maximum Length: 4 characters.
string
The ID of the billing agreement.
string
The user”s postal code. Maximum length: 20 characters.
string
Specifies the type of direct debit transfer. The value of this field is dependent on the user”s country. This field is required for POST and PUT requests. Possible values are: - DirectDebitUK - DirectEntryAU - SEPA
string
Reserved for Docusign.
string
The user”s state or province. Maximum length: 40 characters.
string
The name on the direct debit bank account. This field is required for POST and PUT requests. Maximum Length: 60 characters.
string
The customer”s bank account number. This value will be obfuscated. This field is required for POST and PUT requests. Maximum Length: 30 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_BULK_SEND_BATCH_NAMEUpdates the name of an existing DocuSign bulk send batch. This action allows you to rename a specific bulk send batch for better organization and identification. Use this when you need to update the batch name after creation, for example to reflect the batch purpose or processing status. Key points: - Only updates the batch name; other batch properties remain unchanged - The batch name can be up to 500 characters long - Returns the updated batch status including sent/failed envelope counts - Requires a valid bulkSendBatchId from a previously created bulk send batch Note: Bulk Send is an advanced DocuSign feature available on Business Pro and Enterprise Pro plans. Ensure your account has bulk send permissions enabled.

Input Parameters

string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and must be provided in the path of the API request. It identifies the specific account for which the bulk send batch name will be updated.
string
required
The new name to assign to the bulk send batch. The maximum length is 500 characters. Use a descriptive name to easily identify and organize your bulk send batches.
string
required
The unique identifier of the bulk send batch that needs to be renamed. This parameter is required and must be provided in the path of the API request. It specifies which batch will have its name updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_CONNECT_OAUTH_CONFIGURATIONThis 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.

Input Parameters

string
The OAuth scopes that your app will request from the authorization server. Optional. Note: If you are using Azure Active Directory, this value should be the application ID URI of the specified resource with .default appended. For example: api://{{clientId}}/.default
string
The client ID assigned to your app by your authorization server or OAuth service. Required for updating the OAuth configuration.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the Connect OAuth configuration is being updated. This parameter is typically auto-populated from your authenticated DocuSign session.
string
The client secret value provided by your authorization server. Required for updating the OAuth configuration. Keep this value secure and never expose it in client-side code.
string
Optional custom parameters to include in the OAuth configuration. This can be used to pass additional OAuth-specific settings or metadata required by your authorization server.
string
The token URL for your authorization server or OAuth service (e.g., ‘https://oauth.example.com/token’). Required for updating the OAuth configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_CONTACTS_INFORMATIONThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and automatically populated from your authentication credentials.
array
A list of contacts to update. Each contact must include: contactId (to identify the contact), name, and emails array. Other fields like organization, phone numbers, and shared status are optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_CUSTOM_FIELDS_IN_ENVELOPE_DOCUMENTThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It should be a string value representing either a numeric account number or a GUID (Globally Unique Identifier) for the account.
string
required
The unique identifier for the document within the envelope. This parameter is required and must be provided in the path of the API request. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically, the first document has the ID “1”, the second document “2”, and so on. However, you can use any numbering scheme that fits within a 32-bit signed integer range (1 through 2147483647). This ID is used to associate custom fields with a specific document in the envelope.
string
required
The unique identifier for the envelope that contains the document you want to update. This parameter is required and must be provided in the path of the API request. It should be a string value representing the envelope”s GUID (Globally Unique Identifier). For example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This ID ensures that you”re updating custom fields for the correct envelope.
array
The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: * name - A string that can be a maximum of 50 characters. * value - A string that can be a maximum of 200 characters. IMPORTANT: If you are using xml, the name/value pair is contained in a nameValue element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNTThis 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.

Input Parameters

string
When true, the information in the tab is bold.
string
The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
string
string
The type of this tab. Values are: - Approve - CheckBox - Company - Date - DateSigned - Decline - Email - EmailAddress - EnvelopeId - FirstName - Formula - FullName - InitialHere - InitialHereOptional - LastName - List - Note - Number - Radio - SignerAttachment - SignHere - SignHereOptional - Ssn - Text - Title - Zip5 - Zip5Dash4
array
If the tab is a list, this represents the values that are possible for the tab.
string
The width of the tab in pixels. Must be an integer.
string
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
string
The height of the tab in pixels. Must be an integer.
string
When true, the information in the tab is italic.
string
When true, the signer cannot change the data of the custom tab.
string
When true, this custom tab is shared.
string
When true, the custom tab is editable. Otherwise the custom tab cannot be modified.
string
The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72
string
When true, the signer is required to fill out this tab.
string
When true, the radio button is selected.
string
The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
string
The unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID. It is required to specify which account the custom tab belongs to. Example: “12345” or “a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p”.
string
The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
string
The type of stamp. Valid values are: - signature: A signature image. This is the default value. - stamp: A stamp image. - null
string
When true, the information in the tab is underlined.
string
When true and shared is true, information must be entered in this field to complete the envelope.
string
Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.
string
Specifies units of the anchorXOffset and anchorYOffset. Valid units are: - pixels (default) - inches - mms - cms
string
required
The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
string
The original value of the tab.
string
The UTC DateTime this object was last modified. This is in ISO 8601 format.
string
Specifies the X axis location of the tab in anchorUnits relative to the anchorString.
string
Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.
string
string
The maximum number of entry characters supported by the custom tab.
string
string
Specifies how numerical data is validated. Valid values: - number - currency
string
The userId of the Docusign user who created this object.
string
When true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
string
When true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
string
Specifies the row number in a Salesforce table that the merge field value corresponds to.
string
If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: SHAK1 Maximum Length: 100 characters.
string
If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: Hamlet
string
Sets the object associated with the custom tab. Currently this is the Salesforce Object.
string
string
string
The message displayed if the custom tab fails input validation (either custom of embedded).
string
A regular expression used to validate input for the tab.
string
This property controls how [anchor tabs][AnchorTabs] are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false. For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters: $~><|^+= For example, the anchorString water will match on the string Fetch a pail of water. - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true. - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is i, then only one anchor tab is placed in skiing. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value). Note: You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
Reserved for Docusign.
string
When true, the text string in a document must match the value of the anchorString property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is false. For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When false, if the input is man then man, manpower, fireman, and penmanship will all match. This functionality uses the following rules: - Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters: $~><|^+= For example, the anchorString water will match on the string Fetch a pail of water. - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true. - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is i, then only one anchor tab is placed in skiing. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value). Note: You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
The user name of the Docusign user who created this object.
string
The userId of the Docusign user who last modified this object.
string
When true, data entered into the merge field during Signing will update the mapped Salesforce field.
string
When true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: The Danish play by Shakespeare Maximum Length: 100 characters.
string
When true, this tab is ignored if the anchorString is not found in the document.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
array
Reserved for Docusign.
string
This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - right: Aligns the tab’s left side with the last character of the matching anchor word. Note: You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
string
The User Name of the Docusign user who last modified this object.
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code. Supported formats: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL
array
An array of option strings supported by this setting.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
string
Optional element for field markup. When true, the signer is required to initial when they modify a shared field.
string
When true, the sender can modify the value of the mergeField tab during the sending process.
string
If you are using merge fields, this property specifies the type of the merge field. The only supported value is salesforce.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
array
An array of option strings supported by this setting.
string
When true, use the long currency format for the locale.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Indicates whether the property is editable. Valid values are: - editable - read_only
array
An array of option strings supported by this setting.
array
An array of option strings supported by this setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTSUpdates document visibility settings for multiple recipients in a DocuSign envelope. Use this action to control which documents each recipient can see and their access level (read-only or editable). This is essential for managing multi-document envelopes where different recipients should only access specific documents. Key features: - Set visibility for multiple document-recipient pairs in one request - Control access rights: read-only or editable - Hide documents from specific recipients (if no tabs assigned) Important limitations: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Some recipient types (Carbon Copy, Certified Delivery, Editor, Agent) always see all documents - The envelope must be in a state that allows modifications (typically ‘created’ status) Example use case: In a purchase agreement with financial disclosures, you might want the buyer to see the main agreement and their financial documents, while hiding the seller’s confidential financial information.

Input Parameters

string
The DocuSign account ID (GUID format). This is automatically populated from your authentication credentials. Example: ‘46c80402-3d34-43eb-b8d1-aed79c622310’
string
required
The unique identifier (GUID) of the envelope whose document visibility settings you want to update. The envelope must exist in the specified account. Example: ‘93be49ab-1234-5678-9abc-f752070d71ec’
array
required
Array of document visibility configurations, specifying which documents each recipient can see. Each item must include documentId, recipientId, and optionally visible and rights settings. You can control visibility for multiple document-recipient pairs in a single request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_DOCUSIGN_CONNECT_CONFIGURATIONThis 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.

Input Parameters

string
The name of the Connect configuration. This property is required.
array
A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the urlToPublishTo property. Set this property when you are using the JSON SIM event model. If you are instead using any of the legacy event message formats, set either the envelopeEvents property or the recipientEvents property. The possible event statuses are: * envelope-created * envelope-sent * envelope-resent * envelope-delivered * envelope-completed * envelope-declined * envelope-voided * recipient-authenticationfailed * recipient-autoresponded * recipient-declined * recipient-delivered * recipient-completed * recipient-sent * recipient-resent * template-created * template-modified * template-deleted * envelope-corrected * envelope-purge * envelope-deleted * envelope-discard * recipient-reassign * recipient-delegate * recipient-finish-later * click-agreed * click-declined
array
A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. By default, the users will be included in the configuration. If you want to exclude the users, set the allUsersExcept property to true. Note: If allUsers is set to false, then you must provide a list of user IDs.
string
When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is false. Note: If this property is false, make sure you set the userIds property to a non-empty array of user IDs.
array
string
The password for the Connect configuration. This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.
string
The name of the user.
string
The external account number (int) or account ID GUID. This parameter is required and identifies the specific DocuSign account for which the Connect configuration is being updated.
string
The ID of the Connect configuration to update. This is a required path parameter that specifies which Connect configuration will be modified. You can obtain connectId values by retrieving existing Connect configurations using the retrieve_connect_configurations action.
string
When true, Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues. You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the Logs tab in the Connect console.
array
An array of Salesforce objects.
string
string
string
The delivery mode of the configuration. Valid values: * SIM * Aggregate
string
string
The namespace of the SOAP interface. Note: If useSoapInterface is set to true, you must set this value.
string
This flag allows you to toggle between including and excluding specified users from the configuration. When false, the users corresponding to the IDs in userIds will be included in the configuration. Conversely, when true, the users will be excluded from the configuration. The default value is false.
array
A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * Delivered * Completed * Declined * Voided Note: These values are case-sensitive.
string
string
The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
array
An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the url property. When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property. The possible event statuses are: * Sent * AutoResponded * Delivered * Completed * Declined * AuthenticationFailed Note: These values are case-sensitive.
string
The ID of an external folder.
string
Reserved for Docusign.
string
When true, Mutual TLS authentication is enabled.
string
When true, the notifications are sent to your endpoint as SOAP requests.
string
The type of the configuration. Valid values: * custom: Creates an account-level configuration * customrecipient: Creates a Recipient Connect configuration * salesforce * eOriginal This property is required.
string
Reserved for Docusign.
string
string
Set this property to restv2.1 to return event data in JSON. If the property is not set, the event data will be returned in XML by default.
string
string
The label for an external folder.
string
Set this value to true to enable the webhook. The default property is false.
string
The version of the Salesforce API that you are using.
string
string
When true, the Document Fields associated with the envelope”s documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.
string
array
This property sets the items that are available for selection when adding or editing Connect objects.
string
When true, Docusign sends data to the designated Salesforce account through Connect. The default value is true.
array
A string array of the data to be included. The default is the empty array []. - attachments: Include attachments associated with the envelope. - custom_fields: Include the custom fields associated with the envelope. - documents: Include the documents associated with the envelope. - extensions: Include information about the email settings associated with the envelope. - folders: Include the folder where the envelope exists. - payment_tabs: Include the payment tabs associated with the envelope. - powerform: Include the PowerForms associated with the envelope. - prefill_tabs: Include the pre-filled tabs associated with the envelope. - recipients: Include the recipients associated with the envelope. - tabs: Include the tabs associated with the envelope.
string
When true, event delivery acknowledgements are enabled for your Connect configuration. Docusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back. #### When true and Send Individual Messages (SIM) mode is activated If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down. The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason Pending. When a message succeeds, all queued messages for the configuration will be tried immediately, in order. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When true and SIM mode is not activated If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. #### When false When requiresAcknowledgement is set to false and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.
string
When true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
string
When true, Connect will include the envelope time zone information.
string
When true, the Connect Service includes the Certificate of Completion with completed envelopes.
string
When true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer”s web server) during the TLS handshake protocol.
string
When true, Connect will include the sender account as Custom Field in the data.
string
When true, Docusign can use documents in your Salesforce account for sending and signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ELECTRONIC_RECORD_DISCLOSUREUpdates the Electronic Record and Signature Disclosure (ERSD) for a DocuSign account. Allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. Only account administrators can use this method. Changes may require unsigned recipients to accept a new disclosure version before signing documents.

Input Parameters

string
Deprecated. The pdfId property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored.
string
When true, indicates that the consumer disclosure is a custom disclosure. The default is false.
string
required
The code for the signer language version of the disclosure that you want to update. This parameter is required and supports a wide range of language codes, including “ar” for Arabic, “en” for English US, “fr” for French, etc. You can also use “browser” to automatically detect and display the disclosure in the viewer”s browser language. This allows for multilingual support in consumer disclosures.
string
When true, specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. When false (default), or if the signing brand does not specify a company name, the account name is used instead. Note: This substitution only works if you use the default legal disclosure or if you apply the companyName to the merge fields in a custom ERSD.
string
The external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the consumer disclosure is being updated. It is required for the API call.
string
The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the companyName. It also includes the HTML tags used for formatting. Note: If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.
string
If the customer needs to change their email address, this is the email address to which they should the change request. Maximum length: 100 characters.
string
Specifies the company name used in the disclosure. The default value is the account name. However, if your account uses signing brands that specify a company name, you can substitute the brand”s company name by setting the useBrand property to true. Whenever an envelope is sent from the account that uses a signing brand with a specified companyName, that value is used in email notifications and in the signing experience. Note: This substitution only works if you use the default legal disclosure or if you apply the companyName to the merge fields in a custom ERSD. You must also set the value of the useBrand property to true.
string
When true (default), indicates that eSign is enabled.
string
The phone number of the company associated with the consumer disclosure, as a free-formatted string.
string
The code for the language version of the disclosure. The following languages are supported: - Arabic (ar) - Bulgarian (bg) - Czech (cs) - Chinese Simplified (zh_CN) - Chinese Traditional (zh_TW) - Croatian (hr) - Danish (da) - Dutch (nl) - English US (en) - English UK (en_GB) - Estonian (et) - Farsi (fa) - Finnish (fi) - French (fr) - French Canadian (fr_CA) - German (de) - Greek (el) - Hebrew (he) - Hindi (hi) - Hungarian (hu) - Bahasa Indonesian (id) - Italian (it) - Japanese (ja) - Korean (ko) - Latvian (lv) - Lithuanian (lt) - Bahasa Melayu (ms) - Norwegian (no) - Polish (pl) - Portuguese (pt) - Portuguese Brazil (pt_BR) - Romanian (ro) - Russian (ru) - Serbian (sr) - Slovak (sk) - Slovenian (sl) - Spanish (es) - Spanish Latin America (es_MX) - Swedish (sv) - Thai (th) - Turkish (tr) - Ukrainian (uk) - Vietnamese (vi) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to browser.
string
Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters.
string
Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
string
Contains any other information needed to withdraw consent. Maximum length: 255 characters. Example: We do not need any other information from you to withdraw consent.
string
Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string. Maximum length: 20 characters.
string
Contains the state of the postal address to which a customer can send a consent withdrawal notification. Example: PA
string
The GUID of the account associated with the consumer disclosure.
string
The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate companyName and other specifics. It also includes the HTML tags used for formatting.
string
When true, indicates that the customer can withdraw consent by postal mail. The default is false.
string
When true, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is false. Note: Only Admin users can change this setting.
string
The cost per page if the customer requests paper copies. Example: 0.0000
string
When true (default), indicates that the customer can withdraw consent by email.
string
When true, indicates that the customer can withdraw consent by phone. The default is false.
string
Other information about the requirements for the user to change their email address. Maximum length: 255 characters. Example: We do not require any other information from you to change your email address.
string
The email address to which the customer should send a request for copies of a document. Maximum length: 100 characters.
string
An optional query parameter that, when set to “true”, includes metadata in the response indicating which properties are editable. This can be useful for understanding which fields can be modified in the consumer disclosure. The default value is not specified, implying “false” if not explicitly set.
string
When true, the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting consumerDisclosureFrequency and the user”s actions.
string
Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters.
string
Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
string
Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
string
Text indicating the consequences of withdrawing consent. Maximum length: 255 characters.
string
Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum length: 255 characters. Example: We will bill you for any fees at that time, if any.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENOTE_INTEGRATION_CONFIGUpdates 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.

Input Parameters

string
API key for the eNote integration. Optional parameter used to authenticate with the eNote service.
string
The user”s encrypted password hash.
string
The user”s username.
string
The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is required to specify which account”s eNote configuration should be updated. The value must be a valid DocuSign account identifier string.
string
The name of the organization.
string
When false, the user must configure eNote for the feature to work. Note: In the account settings, allowENoteEOriginal must be true to make changes to the configuration.
string
When false, the user must configure Connect and eOriginal for the integration to work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_ATTACHMENTUpdates 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.

Input Parameters

string
A Base64-encoded string representation of the attachment file content. Use this to update the attachment data. File attachments may be up to 50 MB in size. Note: Either ‘data’ or ‘remoteUrl’ can be provided, but not both.
string
The display name of the attachment file (e.g., ‘contract.pdf’, ‘terms.txt’). This is the filename shown to users accessing the attachment.
string
A descriptive label for the attachment. Common values include: guidedForm for guided forms that provide step-by-step mobile-ready experiences, or eventNotifications for envelope-level event status notifications.
string
The external account number (integer) or account ID GUID. This parameter identifies the DocuSign account associated with the envelope. It is required and must be provided in the path of the request URL.
string
The URL of a previously staged chunked upload. Use this for large files that were uploaded via the chunked upload API. The remoteUrl references the staged content without re-uploading. Cannot be used with ‘data’ parameter. Note: remoteUrl is for uploads only and cannot be used for downloads.
string
required
The envelope”s GUID (Globally Unique Identifier). This parameter is required and must be provided in the path of the request URL. It identifies the specific envelope containing the attachment to be updated. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
The unique identifier for the attachment to be updated. This parameter is required and must be provided in the path of the request URL. It specifies which attachment within the envelope should be modified.
string
Controls who can view the attachment. Valid values are: sender (only the sender can view) and senderAndAllRecipients (both sender and all recipients can view the attachment).
string
Specifies the MIME type or file type of the attachment (e.g., ‘application/pdf’, ‘text/plain’, ‘image/png’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_CUSTOM_FIELDSThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID of the DocuSign account. This parameter is auto-populated from your connected DocuSign account and does not need to be provided. It uniquely identifies the account for which the envelope custom fields are being updated.
string
required
The unique identifier (GUID) of the envelope for which custom fields are being updated. This parameter is required and must be provided in the path of the API request. It should be a string in the format of a GUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
array
An array of list custom fields.
array
An array of text custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_DELAYED_ROUTING_RULESUpdates 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.

Input Parameters

array
User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required to specify which account the envelope belongs to.
string
required
The unique identifier for the envelope. This should be a GUID (Globally Unique Identifier) in the format of a string, e.g., “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. It is required to specify which envelope”s workflow step is being updated.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
string
required
The unique identifier for the specific workflow step within the envelope that you want to update. This is required to target the correct step in the envelope”s workflow for applying the delayed routing rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_DOC_GEN_FORM_FIELDSThis 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. The envelope’s template must be configured with document generation capabilities; this method has no effect on standard envelopes without doc-gen templates.

Input Parameters

string
required
The DocuSign account ID (GUID format) or external account number. Example: ‘46c80402-3d34-43eb-b8d1-aed79c622310’
string
required
The envelope’s GUID that contains DocGen form fields. The envelope must be in ‘created’ (draft) status. Example: ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’
array
required
List of documents with their DocGen form fields to update. Each entry specifies a documentId and the form fields (name-value pairs) to populate. Use DOCUSIGN_GET_ENVELOPE_DOC_GEN_FORM_FIELDS to retrieve available field names first.
boolean
When false or omitted, the documents are regenerated with new documentIds. When true, only the form field values are updated without regenerating documents (documentIds stay the same). Default: false (documents will be regenerated).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_EMAIL_SETTINGSUpdates 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.

Input Parameters

string
The external account number (integer) or account ID GUID of the DocuSign account. This parameter is automatically extracted from the authenticated connection and typically does not need to be provided explicitly. If not provided, the account ID from your authentication credentials will be used.
string
required
The unique identifier of the envelope whose email settings are to be updated. This parameter is required and must be provided in the path. It should be a valid GUID (Globally Unique Identifier) format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
array
An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. While this property is an array, note that it takes only a single email address. Note: Only users with the canManageAccount setting set to true can use this option. Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. Example: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.
string
The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.
string
The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_NOTIFICATION_SETTINGSUpdates 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. When not provided, the account ID is automatically extracted from your authentication credentials.
string
required
The unique identifier for the envelope whose notification settings are being updated. This is a required parameter and must be provided in the path of the API request. It should be in GUID format, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
Whether to use account default notification settings instead of custom settings. Set to ‘true’ to override any custom reminder/expiration settings with account defaults, or ‘false’ to use the custom settings provided in this request.
string
Number of days before expiration to send a warning email to recipients (e.g., ‘7’ for one week notice). Set to ‘0’ to disable warning emails. Must be a non-negative integer as a string.
string
Number of days the envelope remains active before expiring (e.g., ‘120’ for 120 days). Only used when expireEnabled is set to ‘true’. Must be a positive integer as a string.
string
Number of days to wait after the envelope is sent before sending the first reminder email (e.g., ‘5’ to send the first reminder after 5 days). Must be a non-negative integer as a string.
string
Enable custom expiration settings for this envelope. Set to ‘true’ to use the expireAfter value, or ‘false’ to use the account’s default expiration settings.
string
Enable or disable reminder emails for this envelope. Set to ‘true’ to enable reminders, or ‘false’ to disable them. When enabled, uses reminderDelay and reminderFrequency settings.
string
Interval in days between subsequent reminder emails (e.g., ‘2’ to send reminders every 2 days). Only used when reminderEnabled is ‘true’. Must be a positive integer as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_SCHEDULED_SENDING_RULESUpdates 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.

Input Parameters

array
User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
string
Status of the scheduled sending job. Valid values: * pending: The envelope has not yet been sent and the scheduled sending delay has not been initiated. * started: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient. * completed: The delay has elapsed and the envelope has been sent to the first recipient. This property is read-only.
string
The external account number (integer) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the envelope”s scheduled sending rules are being updated. It is required for all API calls to ensure operations are performed on the correct account.
string
The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
string
required
The envelope”s GUID (Globally Unique Identifier). This is a required parameter that specifically identifies the envelope whose scheduled sending rules are being updated. The GUID is a 32-character hexadecimal string, typically presented in 5 groups separated by hyphens. Example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”
string
The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_DEFINITIONUpdates 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.

Input Parameters

string
The external account number (integer) or account ID GUID. This parameter is required and must be provided in the path to identify the DocuSign account for which the envelope workflow is being updated.
string
required
The envelope”s GUID (Globally Unique Identifier). This parameter is required and must be provided in the path to specify which envelope”s workflow is being updated. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep. This property is read-only.
array
An array of workflow steps.
string
The status of the workflow: - paused if the workflow is paused - in_progress if the workflow is in progress
string
The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object.
array
User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
string
Status of the scheduled sending job. Valid values: * pending: The envelope has not yet been sent and the scheduled sending delay has not been initiated. * started: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient. * completed: The delay has elapsed and the envelope has been sent to the first recipient. This property is read-only.
string
The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
string
The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_STEPUpdates 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.

Input Parameters

string
Indicates the action to perform. Valid values: - pause_before: The workflow should pause before the trigger described by triggerOnItem is reached.
string
The identifier of the item that triggers this workflow step. When triggerOnItem is set to routing_order, this should be the routing order number (as a string) where the workflow step action should occur. For example, setting itemId to “1” with action as “pause_before” will pause the envelope before it reaches routing order 1.
string
The status of the step. Valid values: - inactive - in_progress - paused - pending - completed This property is read-only.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It ensures that the API operation is performed within the context of the correct account.
string
required
The unique identifier for the envelope whose workflow step is being updated. This GUID is required and must be provided in the path. It should be in the format of a UUID, for example: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”. This parameter specifies which envelope”s workflow is being modified.
string
The timestamp of when the workflow step transitioned to completed status. This property is read-only.
string
The type of item that triggers this workflow step. Valid values: * routing_order
string
The timestamp of when the workflow step transitioned to in_progress status. This property is read-only.
string
required
A unique identifier for this workflow step. This property is read-only.
array
User-specified rules indicating how and when the envelope should be sent for the workflow step and its associated recipients. Only one rule may be specified. Each rule can contain either a delay (timespan in format d.hh:mm:ss) or a resumeDate (ISO 8601 datetime string), but not both.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
array
An array of conditional recipient configurations for advanced recipient routing. Conditional recipients allow you to control envelope flow by specifying different recipients based on conditions such as tab values or recipient actions. Each conditional recipient definition includes conditions that determine when the recipients should be used, along with the recipient group details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_GROUP_INFORMATIONUpdates group information for one or more user groups in a DocuSign account. This action allows you to modify group properties such as group name and permission profile assignments. Required Parameters: - groups: A list of group objects to update. Each group must include: - groupId: The DocuSign group ID identifying which group to update - At least one field to update (e.g., groupName or permissionProfileId) Common Use Cases: - Rename one or more groups - Change the permission profile assigned to a group - Update multiple groups in a single API call Note: The accountId parameter is automatically populated from authentication metadata. To get group IDs, first use the GET_GROUPS_INFORMATION_FOR_ACCOUNT action to list existing groups.

Input Parameters

array
A list of group objects containing information about the groups to update. Each group should include a groupId (to identify which group to update) and the fields to update (e.g., groupName, permissionProfileId).
string
The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from authentication metadata and specifies which account”s groups are being updated.
string
The last index position in the result set.
string
The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
string
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
string
The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
string
The starting index position of the current result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_LOCK_FOR_ENVELOPEUpdates lock settings for an already-locked DocuSign envelope, such as the lock duration or locking application identifier. The response can include updated lock information, including the token and expiration time.

Input Parameters

string
The type of lock. Currently only ‘edit’ is supported by DocuSign. This parameter is typically not changed during an update and can be omitted.
string
The DocuSign account identifier. Automatically populated from authentication if not provided. Can be either the external account number (e.g., ‘12345’) or account ID GUID (e.g., ‘8a9de7e5-xxxx-xxxx-xxxx-f7e816a180e1’). Specifies which account contains the envelope whose lock will be updated.
string
required
Required. The envelope ID (GUID) whose lock you want to update. The envelope must already be locked before calling this endpoint. Format: GUID string like ‘93be49ab-xxxx-xxxx-xxxx-f752070d71ec’. Only the user or application that created the lock can update it.
string
A friendly name identifying the application managing the lock (e.g., ‘MyApp v1.0’). This name appears in error messages when lock conflicts occur, helping users identify which application holds the lock. If not specified, the existing app name is retained.
string
When true, a scratchpad is used to edit information.
string
The password for the template. If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the templatePassword to save the changes.
string
The new duration for the lock in seconds. Must be between 1 and 1800 (30 minutes maximum). This extends or reduces the lock time. For example, use ‘600’ to set a 10-minute lock. If not specified, the lock duration remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_NOTARY_JURISDICTION_INFOUpdates 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.

Input Parameters

string
The county that the commission is valid in.
string
The seal type used for this jurisdiction. Valid values: not_available, system_created, user_uploaded.
string
The notary’s commission identification. This varies from jurisdiction to jurisdiction.
string
required
The unique identifier for the notary jurisdiction to be updated. Must be a string representing one of the supported jurisdictions (e.g., “5” for California, “6” for Colorado). The value must match the jurisdictionId in the request body and correspond to a jurisdiction the notary is registered for. Required parameter.
string
The registered name of the notary.
string
The name of the jurisdiction. Typically the state name.
string
The expiration date of the notary’s commission in format: MM/DD/YYYY.
string
The county of the jurisdiction.
string
A brief message describing the error condition.
string
When true, this jurisdiction is enabled.
string
The code associated with the error condition.
string
When true, the county name appears in the seal.
string
The ID of the jurisdiction. The following jurisdictions are supported: - 5 - California - 6 - Colorado - 9 - Florida - 10 - Georgia - 12 - Idaho - 13 - Illinois - 14 - Indiana - 15 - Iowa - 17 - Kentucky - 23 - Minnesota - 25 - Missouri - 30 - New Jersey - 32 - New York - 33 - North Carolina - 35 - Ohio - 37 - Oregon - 38 - Pennsylvania - 40 - South Carolina - 43 - Texas - 44 - Utah - 47 - Washington - 48 - West Virginia - 49 - Wisconsin - 62 - Florida Commissioner of Deeds
string
When true, the name of the state appears in the seal.
string
When true, the notary’s commissionId appears in the seal.
string
When true, the name of the notary appears in the seal.
string
When true, the seal can be uploaded by the user.
string
When true, the seal can be generated by the platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_PERMISSION_PROFILE_SETTINGSThis 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.

Input Parameters

array
A list of user objects containing information about the users who are associated with the account permission profile.
string
An optional query parameter that specifies additional properties to return in the response. Currently, the only valid value for this parameter is “metadata”, which returns metadata indicating whether the properties associated with the account permission profile are editable. This parameter is not required and should be used when detailed information about property editability is needed.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the URL path. It should be a valid string representing either a numeric account number or a GUID format account identifier.
string
The total number of users in the group associated with the account permission profile.
string
The date and time when the permission profile was last modified.
string
The username of the user who last modified the permission profile.
string
string
required
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
The name of the account permission profile. Example: Account Administrator
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The PowerForms rights associated with the account permission profile. Valid values are: - none - user - admin
string
When true, users can manage documents by using the API.
string
When true, auto-tagging is enabled for the account.
string
When true, bulk sending is enabled for users.
string
string
Reserved for Docusign.
string
When true, users can access the Other Actions menu.
string
When true, users can add electronic seal (eSeal) recipients.
string
When true, users can send envelopes.
string
string
string
Specifies the level of access that users have to account templates. Valid values are: - none - use - create - share
string
When true, users cannot upload documents.
string
When true, users have full administrative access to the account.
string
When true, users can add requests for attachments from signers.
string
string
Reserved for Docusign.
string
When true, users can access the account by using the eSignature API.
string
When true, users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis.
string
string
When true, API request logging is enabled. Note: Logging limits apply.
string
Specifies the level of access that users have to the account”s address book. Valid values are: - personal - useShared - usePersonalAndShared - personalAndShared
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users may specify sequential signing recipients when they send documents by using the API.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the Docusign Desktop Client is enabled for users.
string
When true, senders can include supplemental documents.
string
string
When true, the tagger palette is visible during the sending and correct flows and users can add tabs to documents.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders can require recipients to read supplemental documents.
string
When true, users can require recipients to view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, users can send envelopes on behalf of others.
string
string
When true, senders can require recipients to accept supplemental documents.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sequential signing user interface is enabled.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders are notified when recipients view the documents that they send.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, users can be recipients of envelopes transferred to them by administrators of other accounts.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, senders can set the language of the email that is sent to recipients.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Indicates whether the property is editable. Valid values are: - editable - read_only
Reserved for Docusign.
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
An array of option strings supported by this setting.
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
When true, senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, PowerForm Administrators can access all of the PowerForm envelopes associated with the account.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_RECIPIENT_DOCUMENT_VISIBILITYThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. Required parameter that must be provided in the path to specify which account the operation is being performed on.
string
required
The unique identifier for the envelope containing the documents and recipients. This is a GUID (Globally Unique Identifier) that DocuSign assigns to each envelope. Required parameter that must be provided in the path to specify which envelope”s recipient document visibility is being updated. Example format: “93be49ab-xxxx-xxxx-xxxx-f752070d71ec”.
string
required
A local reference used to identify the recipient within the envelope. This can be either an integer or a GUID and must be unique within the envelope. Required parameter that must be provided in the path to specify which recipient”s document visibility is being updated. For example, many envelopes assign the first recipient a recipientId of “1”.
array
An array of documentVisibility objects that specifies which documents are visible to which recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_SIGNING_GROUP_DETAILSUpdates 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.

Input Parameters

array
User management information.
string
The UTC DateTime when the signing group was created. This property is read-only.
string
The UTC DateTime when the signing group was last modified. This property is read-only.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request.
string
The name of the user who created the signing group. This property is read-only.
string
The name of the group.
string
The type of the group. The only valid value for this request is sharedSigningGroup.
string
The email address for the signing group. You can use a group email address to email all of the group members at the same time.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
required
The ID of the signing group.
string
A brief message describing the error condition.
string
The code associated with the error condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_SIGNING_GROUP_NAMESUpdates one or more existing DocuSign signing groups. Group objects can include names, email addresses, and member information as well as signing group IDs.

Input Parameters

array
A list of group objects containing the signing group IDs and the new names to update. Each group object must include ‘signingGroupId’ (the ID of the group to update) and ‘groupName’ (the new name for the group).
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your connected DocuSign account and does not need to be provided manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_CUSTOM_FIELDSUpdates 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. It is required to specify which account”s template is being updated. The value must be a non-empty string and is typically provided by the DocuSign system when setting up the account.
string
required
The unique identifier for the template within the specified DocuSign account. This ID is required to target the specific template whose custom fields are being updated. The value must be a non-empty string and is typically a GUID provided by DocuSign when the template was created or retrieved from a previous API call.
array
An array of list custom fields.
array
An array of text custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_DELAYED_ROUTING_RULESThis 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.

Input Parameters

array
User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API call. It ensures that the template being modified belongs to the correct account.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
string
required
The unique identifier of the template for which the delayed routing rules are being updated. This parameter is required and must be provided in the path of the API call. It specifies which template”s workflow step will be modified.
string
required
The unique identifier of the specific workflow step within the template that is being updated. This parameter is required and must be provided in the path of the API call. It determines which step in the template”s workflow will have its delayed routing rules modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account”s template document fields should be updated.
string
required
The unique identifier of the document within the template. This parameter is required and must be provided in the path of the API request. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically, the first document has the ID “1”, the second document “2”, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). This ID specifies which document”s custom fields should be updated within the template.
string
required
The unique identifier of the template containing the document whose custom fields need to be updated. This parameter is required and must be provided in the path of the API request. It specifies which template should be modified.
array
The array of custom document fields to update. Each field contains name/value pairs that represent metadata for the document. Custom document field information is returned in API responses but is not used by DocuSign internally - it’s purely for your application’s use. Each field can have: * name: The field identifier (maximum 50 characters) * value: The field value to set (maximum 200 characters) * originalValue: Optional previous value for reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_DOC_VISIBILITYThis 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.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the integer external account number or the account ID GUID. If not provided, the account ID will be automatically extracted from the authentication context.
string
required
The unique identifier for the template within the specified DocuSign account. This required path parameter is used to target the specific template whose recipient document visibility settings you want to update.
array
An array of document visibility settings that specify which documents are visible to which recipients. Each object should include documentId, recipientId, and visible fields to control document access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_LOCK_INFORMATIONThis 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.

Input Parameters

string
The type of lock. Currently edit is the only supported type.
string
The unique identifier for the DocuSign account. This can be either the account number (integer) or the account ID GUID (string). It is a required path parameter used to specify which account the template belongs to.
string
required
The lock token returned from the lock creation (POST) or get lock (GET) endpoint. This token proves ownership of the lock and must be provided in the X-DocuSign-Edit header to update the lock. Required for updating an existing lock.
string
required
The unique identifier for the template within the specified account. This is a required path parameter and must be a valid template ID string. It determines which template”s lock information will be updated.
string
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
string
When true, a scratchpad is used to edit information.
string
The password for the template. If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the templatePassword to save the changes.
string
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds. This extends or modifies the lock duration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_NOTIFICATION_SETTINGSThis 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.

Input Parameters

string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It is used to specify which account”s template should be updated.
string
required
The unique identifier of the template whose notification settings are to be updated. This parameter is required and must be provided in the path of the API request. It should be a string value representing the specific template ID within the specified account.
string
When true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When false, the reminders and expirations settings specified in this request are used. The default value is false.
string
An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent.
string
An integer that sets the number of days the envelope is active. For this value to be used, expireEnabled must be explicitly set to true.
string
An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0.
string
When true, the envelope expires in the number of days set by expireAfter. When false or not set, the envelope expires in the number of days specified by the default expiration account setting.
string
When true, reminders are enabled. The default value is false.
string
An integer specifying the interval in days between reminder emails. The default value is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYUpdates document visibility settings for a specific recipient in a DocuSign template. This endpoint allows you to control which documents a particular recipient can see in a template with multiple documents. Use this when you need to: - Restrict certain documents from specific recipients for security or privacy - Customize the signing experience by showing only relevant documents to each recipient - Modify document access after a template has been created Important Constraints: - Documents with tabs assigned to a recipient cannot be hidden from that recipient - Carbon Copy, Certified Delivery, Editor, and Agent recipients always see all documents - The recipientId must exist in the template before updating visibility Use Case Example: In a multi-document employment contract template, you might want to hide salary details from HR coordinators while showing them to the hiring manager and the candidate.

Input Parameters

string
The unique identifier for the DocuSign account. This can be either the integer external account number or the account ID GUID. If not provided, the account ID will be automatically extracted from the authentication context.
string
required
The unique identifier for the template in which you want to update recipient document visibility. This is the template ID GUID. Required parameter.
string
required
A unique identifier for the recipient within the template whose document visibility you want to update. This can be either an integer or a GUID and must be unique within the template. For example, the first recipient is often assigned a recipientId of “1”. Required parameter.
array
An array of document visibility settings that specify which documents are visible to this recipient. Each object should include documentId, recipientId, and visible fields to control document access. Note: documents with tabs assigned to this recipient cannot be hidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_SCHEDULED_SENDING_RULESUpdates the scheduled sending rules for a DocuSign template, controlling when envelopes created from this template are automatically sent. Use this to set up either a relative delay (e.g., send 2 days after creation) or an absolute future date/time. This is useful for: - Automating timed document delivery workflows - Coordinating envelope sending with business events - Allowing review periods before automatic sending - Managing bulk send operations with scheduled timing Note: Maximum delay is 30 days. Requires Standard plan or higher. Only one rule (either delay or resumeDate) can be specified per template.

Input Parameters

array
User-specified rules indicating how and when envelopes created from this template should be scheduled for sending. Only one rule may be specified. Each rule must contain either a ‘delay’ (e.g., ‘2.00:00:00’ for 2 days) OR a ‘resumeDate’ (ISO 8601 datetime), but not both. Maximum delay/future date is 30 days.
string
Status of the scheduled sending configuration. This is a read-only field returned in responses. Valid values: ‘pending’ (schedule set but not started), ‘started’ (delay counting down), ‘completed’ (envelope sent). This field should typically not be included in request bodies.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. If not provided, it will be auto-resolved from your authentication token. This ensures that the template being updated belongs to the correct account.
string
The ID of the bulk send list to use with scheduled sending. This is optional and only needed when coordinating scheduled sending with bulk send operations. When provided, the scheduled sending rules apply to the bulk send job.
string
The timestamp of when envelopes created from this template are scheduled to be sent, in ISO 8601 format (e.g., ‘2026-02-15T14:30:00Z’). This is a read-only field that reflects the computed send time based on the rules. To set scheduled sending, use the ‘rules’ parameter instead.
string
required
The unique identifier of the template for which the scheduled sending rules are being updated. This parameter is required and must be provided in the path of the API call. It specifies which template”s sending rules will be modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_TEMPLATE_WORKFLOW_DEFINITIONUpdates 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.

Input Parameters

string
The external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and is used to identify the specific account for which the template workflow is being updated.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep. This property is read-only.
string
required
The unique identifier of the template whose workflow definition is being updated. This parameter is required and must correspond to an existing template within the specified account.
array
An array of workflow steps.
string
The status of the workflow: - paused if the workflow is paused - in_progress if the workflow is in progress
string
The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object.
array
User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
string
Status of the scheduled sending job. Valid values: * pending: The envelope has not yet been sent and the scheduled sending delay has not been initiated. * started: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient. * completed: The delay has elapsed and the envelope has been sent to the first recipient. This property is read-only.
string
The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
string
The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_ACCOUNT_SETTINGSThis 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.

Input Parameters

string
The user”s locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
string
The ID of the user to access. This parameter is optional and defaults to the authenticated user’s ID from the OAuth token. Users can only access their own information. Even a user with Admin rights cannot access another user’s settings using this endpoint. If not provided, it will be automatically populated with the current user’s ID from the authentication token.
string
When true, this user can use the bulk send feature for the account.
string
string
The external account number (int) or account ID GUID. This parameter is required and identifies the specific DocuSign account for which the user settings are being updated. It must be a valid account identifier within the DocuSign system.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
Reserved for Docusign.
string
When true, daylight savings time is in effect for this user”s time zone.
string
The date on which this user record was last modified.
string
Note referencing the page that modified this user record.
string
The custom DateTime format setting for this user.
string
Indicates the specified Vaulting mode: - none - estored - electronic_original
string
Indicates the Power Form mode setting for the user: - none - admin - user
string
When true, this user can export authoritative copy for the account.
string
When true, Vaulting is enabled for the account.
string
The timezone offset for the user. Valid values: - tz_01_afghanistan - tz_02_alaskan - tz_03_arab - tz_04_arabian - tz_05_arabic - tz_06_argentina - tz_07_atlantic - tz_08_aus_central - tz_09_aus_eastern - tz_10_azerbaijan - tz_11_azores - tz_12_bangladesh - tz_13_canada_central - tz_14_cape_verde - tz_15_caucasus - tz_16_central_australia - tz_17_central_america - tz_18_central_asia - tz_19_central_brazilian - tz_20_central_europe - tz_21_central_european - tz_22_central_pacific - tz_23_central - tz_24_central_mexico - tz_25_china - tz_26_dateline - tz_27_east_africa - tz_28_east_australia - tz_29_east_europe - tz_30_east_south_america - tz_31_eastern - tz_32_egypt - tz_33_ekaterinburg - tz_34_fiji - tz_35_fli - tz_36_georgian - tz_37_gmt - tz_38_greenland - tz_39_greenwich - tz_40_gtb - tz_41_hawaiian - tz_42_india - tz_43_iran - tz_44_israel - tz_45_jordan - tz_46_kaliningrad - tz_47_kamchatka - tz_48_korea - tz_49_magadan - tz_50_mauritius - tz_51_mid_atlantic - tz_52_middle_east - tz_53_montevideo - tz_54_morocco - tz_55_mountain - tz_56_mountain_mexico - tz_57_myanmar - tz_58_north_central_asia - tz_59_namibia - tz_60_nepal - tz_61_new_zealand - tz_62_new_foundland - tz_63_north_asia_east - tz_64_north_asia - tz_65_pacific_sa - tz_66_pacific - tz_67_pacific_mexico - tz_68_pakistan - tz_69_paraguay - tz_70_romance - tz_71_russian - tz_72_sa_eastern - tz_73_sa_pacific - tz_74_sa_western - tz_75_samoa - tz_76_se_asia - tz_77_singapore - tz_78_south_africa - tz_79_sriLanka - tz_80_syria - tz_81_taipei - tz_82_tasmania - tz_83_tokyo - tz_84_tonga - tz_85_turkey - tz_86_ulaanbaatar - tz_87_us_eastern - tz_88_us_mountain - tz_89_venezuela - tz_90_vladivostok - tz_91_west_australia - tz_92_west_central_africa - tz_93_west_europe - tz_94_west_asia - tz_95_west_pacific - tz_96_yakutsk
string
When true, this user can send envelopes on the account.
string
When true, this user can sign envelopes.
string
When false, this user can apply tabs to documents during the sending experience.
array
Information about the seals associated with this user.
string
When true, the API returns suggested tabs for documents for this user.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is an administrator for the account.
string
When true, this user can use a scratchpad to edit information.
string
string
When true, this user can manage templates for the account.
string
When true, this user can send API requests on the account.
string
When true, this user can send envelopes “on behalf of” other users through the API.
string
An optional query parameter that, when set to true, allows the use of all languages supported by DocuSign for this user. When false or not specified, the user is restricted to the default language set for their account. This parameter is particularly useful for multinational organizations or those requiring multilingual support.
string
When true, this user can access the Other Actions menu.
string
When true, the system notifies this user before applying a matching template.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
string
When true, indicates that this user can send envelope-specific API requests on the account.
string
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create and manage Clickwraps.
string
When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
string
When true, this user is prohibited from uploading documents during sending.
string
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
When true, a new template is created each time the user sends an envelope.
string
When true, this user can participate in envelope transfers on the account.
string
string
When true, this user can use the signing attachments feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can edit the shared address book for the account.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users see template matching functionality.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can include supplemental documents.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user receives notifications when envelopes are viewed.
string
Percentage used when matching templates.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user must both view and accept supplemental documents.
string
When true, this user must view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, this user must accept supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user gets supplemental documents when downloading documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
True if the user can manage users.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
When true, the sender receives notification that a recipient viewed the envelope.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage administrators.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
True if the user can manage sharing.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage reporting.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notification that he or she is a member of the signing group.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
True if the user can manage signing groups.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the user receives notification that document markup has been activated.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
True if the user can manage account settings.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage account security settings.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_AUTHORIZATION_DATESUpdates 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.

Input Parameters

string
required
The ID of the principal user for whom the authorization is being updated. This parameter is required and must be provided in the path. It should be a string value representing the unique identifier of the user in the DocuSign system.
string
The end date for the user authorization. The default value is the max UTC value: 9999-12-31T23:59:59.0000000+00:00.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path. It should be a string value representing either a numeric account ID or a GUID format string.
string
The start date for the user authorization. The default value is the current date and time.
string
required
The unique identifier of the user authorization to be updated. This parameter is required and must be provided in the path. It should be a string value representing the specific authorization ID within the DocuSign system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_INFORMATION_FOR_SPECIFIED_USERThe 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.

Input Parameters

string
A URI containing the user ID.
string
The user”s email address.
string
The title of the user.
string
The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user”s settings.
string
The name of the user”s company.
string
When true, the user is an administrator.
string
The user”s job title.
string
The user”s last name. Maximum Length: 50 characters.
string
The user”s encrypted password hash.
string
The name of the user.
string
The type of user, for example CompanyUser.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the URL path. It should be a string value representing either a numeric account number or a GUID (Globally Unique Identifier) for the account.
string
The user”s first name. Maximum Length: 50 characters.
array
A list of the group information for groups to add the user to. Use UserGroups: listGroups to get information about groups. When setting a user”s group, only the groupId is required.
string
This property has been deprecated.
string
string
The user”s middle name. Limit: 50 characters.
string
The suffix for the user”s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
string
Status of the user”s account. One of: - ActivationRequired - ActivationSent - Active - Closed - Disabled
string
The two-letter code for the user”s country.
string
Boolean value that indicates whether the user is currently logged in or not.
string
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
array
The name/value pair information for the user custom setting.
string
The UTC DateTime when the item was created.
boolean
string
The URL for retrieving the user”s profile image.
string
The default account ID associated with the user.
string
A fax number associated with the address, if one is available.
string
The URI for retrieving the image of the user”s initials.
string
When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
string
A fax number associated with the address, if one is available.
string
The user”s city. Maximum length: 40 characters.
string
An endpoint URI that you can use to retrieve the user”s signature image.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
If password expiration is enabled, the date-time when the user”s password expires.
string
A phone number associated with the address.
string
An optional query parameter that affects language settings. The schema does not provide specific information about its purpose or valid values. When using this parameter, consult the DocuSign API documentation for its exact functionality and accepted values.
string
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following these steps.
string
Access code provided to the user to activate the account.
string
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
string
The user”s country. Maximum length: 50 characters.
string
The user”s locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
string
The user”s country. Maximum length: 50 characters.
array
Object representing the user”s custom Connect configuration.
string
A brief message describing the error condition.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
The name of the account permission profile. Example: Account Administrator
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
When true, this user can use the bulk send feature for the account.
string
string
The code associated with the error condition.
string
The user”s postal code. Maximum length: 20 characters.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The user”s postal code. Maximum length: 20 characters.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
Reserved for Docusign.
string
When true, daylight savings time is in effect for this user”s time zone.
string
The date and time that the user was added to the account.
string
The date on which this user record was last modified.
string
Note referencing the page that modified this user record.
string
The custom DateTime format setting for this user.
string
Indicates the specified Vaulting mode: - none - estored - electronic_original
string
The date and time that the user”s profile was last modified.
string
Indicates the Power Form mode setting for the user: - none - admin - user
string
The user”s state or province. Maximum length: 40 characters.
string
When true, specifies that an additional activation email be sent if user”s log on fails before the account is activated.
string
When true, this user can export authoritative copy for the account.
string
When true, Vaulting is enabled for the account.
string
The timezone offset for the user. Valid values: - tz_01_afghanistan - tz_02_alaskan - tz_03_arab - tz_04_arabian - tz_05_arabic - tz_06_argentina - tz_07_atlantic - tz_08_aus_central - tz_09_aus_eastern - tz_10_azerbaijan - tz_11_azores - tz_12_bangladesh - tz_13_canada_central - tz_14_cape_verde - tz_15_caucasus - tz_16_central_australia - tz_17_central_america - tz_18_central_asia - tz_19_central_brazilian - tz_20_central_europe - tz_21_central_european - tz_22_central_pacific - tz_23_central - tz_24_central_mexico - tz_25_china - tz_26_dateline - tz_27_east_africa - tz_28_east_australia - tz_29_east_europe - tz_30_east_south_america - tz_31_eastern - tz_32_egypt - tz_33_ekaterinburg - tz_34_fiji - tz_35_fli - tz_36_georgian - tz_37_gmt - tz_38_greenland - tz_39_greenwich - tz_40_gtb - tz_41_hawaiian - tz_42_india - tz_43_iran - tz_44_israel - tz_45_jordan - tz_46_kaliningrad - tz_47_kamchatka - tz_48_korea - tz_49_magadan - tz_50_mauritius - tz_51_mid_atlantic - tz_52_middle_east - tz_53_montevideo - tz_54_morocco - tz_55_mountain - tz_56_mountain_mexico - tz_57_myanmar - tz_58_north_central_asia - tz_59_namibia - tz_60_nepal - tz_61_new_zealand - tz_62_new_foundland - tz_63_north_asia_east - tz_64_north_asia - tz_65_pacific_sa - tz_66_pacific - tz_67_pacific_mexico - tz_68_pakistan - tz_69_paraguay - tz_70_romance - tz_71_russian - tz_72_sa_eastern - tz_73_sa_pacific - tz_74_sa_western - tz_75_samoa - tz_76_se_asia - tz_77_singapore - tz_78_south_africa - tz_79_sriLanka - tz_80_syria - tz_81_taipei - tz_82_tasmania - tz_83_tokyo - tz_84_tonga - tz_85_turkey - tz_86_ulaanbaatar - tz_87_us_eastern - tz_88_us_mountain - tz_89_venezuela - tz_90_vladivostok - tz_91_west_australia - tz_92_west_central_africa - tz_93_west_europe - tz_94_west_asia - tz_95_west_pacific - tz_96_yakutsk
string
The user”s state or province. Maximum length: 40 characters.
string
When true, this user can send envelopes on the account.
string
When true, this user can sign envelopes.
string
When false, this user can apply tabs to documents during the sending experience.
array
Information about the seals associated with this user.
string
When true, the API returns suggested tabs for documents for this user.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is an administrator for the account.
string
When true, this user can use a scratchpad to edit information.
string
string
When true, this user can manage templates for the account.
string
When true, this user can send API requests on the account.
string
When true, this user can send envelopes “on behalf of” other users through the API.
string
When true, this user can access the Other Actions menu.
string
When true, the system notifies this user before applying a matching template.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
string
When true, indicates that this user can send envelope-specific API requests on the account.
string
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create and manage Clickwraps.
string
When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
string
When true, this user is prohibited from uploading documents during sending.
string
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
When true, a new template is created each time the user sends an envelope.
string
When true, this user can participate in envelope transfers on the account.
string
string
When true, this user can use the signing attachments feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can edit the shared address book for the account.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users see template matching functionality.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
True if the user can manage signing groups.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can include supplemental documents.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user receives notifications when envelopes are viewed.
string
Percentage used when matching templates.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
True if the user can manage account security settings.
string
True if the user can manage account settings.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user must both view and accept supplemental documents.
string
When true, this user must view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, this user must accept supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
The answer to the first forgotten password challenge question.
string
The answer to the second forgotten password challenge question.
string
The answer to the third forgotten password challenge question.
string
The answer to the fourth forgotten password challenge question.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives notification that document markup has been activated.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
The first challenge question presented to a user who has forgotten their password.
string
The second challenge question presented to a user who has forgotten their password.
string
The third challenge question presented to a user who has forgotten their password.
string
The fourth challenge question presented to a user who has forgotten their password.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user gets supplemental documents when downloading documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage users.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives notification that a recipient viewed the envelope.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage administrators.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
True if the user can manage sharing.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
True if the user can manage reporting.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notification that he or she is a member of the signing group.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_NOTARY_INFORMATIONUpdates the current user’s DocuSign notary profile and settings, including visibility and user information.

Input Parameters

string
The date the this object was created.
string
When true, this notary is searchable.
string
The creation date of the account in UTC timedate format.
string
A URI containing the user ID.
string
The user”s email address.
string
The title of the user.
string
The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user”s settings.
string
The name of the user”s company.
string
When true, the user is an administrator.
string
The user”s job title.
string
The user”s last name. Maximum Length: 50 characters.
string
The user”s encrypted password hash.
string
The name of the user.
string
The type of user, for example CompanyUser.
string
The user”s first name. Maximum Length: 50 characters.
array
A list of the group information for groups to add the user to. Use UserGroups: listGroups to get information about groups. When setting a user”s group, only the groupId is required.
string
This property has been deprecated.
string
string
The user”s middle name. Limit: 50 characters.
string
The suffix for the user”s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
string
Status of the user”s account. One of: - ActivationRequired - ActivationSent - Active - Closed - Disabled
string
The two-letter code for the user”s country.
string
Boolean value that indicates whether the user is currently logged in or not.
string
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
array
The name/value pair information for the user custom setting.
string
The UTC DateTime when the item was created.
boolean
string
The URL for retrieving the user”s profile image.
string
The default account ID associated with the user.
string
A fax number associated with the address, if one is available.
string
The URI for retrieving the image of the user”s initials.
string
When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
string
A fax number associated with the address, if one is available.
string
The user”s city. Maximum length: 40 characters.
string
An endpoint URI that you can use to retrieve the user”s signature image.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
If password expiration is enabled, the date-time when the user”s password expires.
string
A phone number associated with the address.
string
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following these steps.
string
Access code provided to the user to activate the account.
string
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
string
The user”s country. Maximum length: 50 characters.
string
The user”s locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
string
The user”s country. Maximum length: 50 characters.
array
Object representing the user”s custom Connect configuration.
string
A brief message describing the error condition.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
The name of the account permission profile. Example: Account Administrator
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
When true, this user can use the bulk send feature for the account.
string
string
The code associated with the error condition.
string
The user”s postal code. Maximum length: 20 characters.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The user”s postal code. Maximum length: 20 characters.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
Reserved for Docusign.
string
When true, daylight savings time is in effect for this user”s time zone.
string
The date and time that the user was added to the account.
string
The date on which this user record was last modified.
string
Note referencing the page that modified this user record.
string
The custom DateTime format setting for this user.
string
Indicates the specified Vaulting mode: - none - estored - electronic_original
string
The date and time that the user”s profile was last modified.
string
Indicates the Power Form mode setting for the user: - none - admin - user
string
The user”s state or province. Maximum length: 40 characters.
string
When true, specifies that an additional activation email be sent if user”s log on fails before the account is activated.
string
When true, this user can export authoritative copy for the account.
string
When true, Vaulting is enabled for the account.
string
The timezone offset for the user. Valid values: - tz_01_afghanistan - tz_02_alaskan - tz_03_arab - tz_04_arabian - tz_05_arabic - tz_06_argentina - tz_07_atlantic - tz_08_aus_central - tz_09_aus_eastern - tz_10_azerbaijan - tz_11_azores - tz_12_bangladesh - tz_13_canada_central - tz_14_cape_verde - tz_15_caucasus - tz_16_central_australia - tz_17_central_america - tz_18_central_asia - tz_19_central_brazilian - tz_20_central_europe - tz_21_central_european - tz_22_central_pacific - tz_23_central - tz_24_central_mexico - tz_25_china - tz_26_dateline - tz_27_east_africa - tz_28_east_australia - tz_29_east_europe - tz_30_east_south_america - tz_31_eastern - tz_32_egypt - tz_33_ekaterinburg - tz_34_fiji - tz_35_fli - tz_36_georgian - tz_37_gmt - tz_38_greenland - tz_39_greenwich - tz_40_gtb - tz_41_hawaiian - tz_42_india - tz_43_iran - tz_44_israel - tz_45_jordan - tz_46_kaliningrad - tz_47_kamchatka - tz_48_korea - tz_49_magadan - tz_50_mauritius - tz_51_mid_atlantic - tz_52_middle_east - tz_53_montevideo - tz_54_morocco - tz_55_mountain - tz_56_mountain_mexico - tz_57_myanmar - tz_58_north_central_asia - tz_59_namibia - tz_60_nepal - tz_61_new_zealand - tz_62_new_foundland - tz_63_north_asia_east - tz_64_north_asia - tz_65_pacific_sa - tz_66_pacific - tz_67_pacific_mexico - tz_68_pakistan - tz_69_paraguay - tz_70_romance - tz_71_russian - tz_72_sa_eastern - tz_73_sa_pacific - tz_74_sa_western - tz_75_samoa - tz_76_se_asia - tz_77_singapore - tz_78_south_africa - tz_79_sriLanka - tz_80_syria - tz_81_taipei - tz_82_tasmania - tz_83_tokyo - tz_84_tonga - tz_85_turkey - tz_86_ulaanbaatar - tz_87_us_eastern - tz_88_us_mountain - tz_89_venezuela - tz_90_vladivostok - tz_91_west_australia - tz_92_west_central_africa - tz_93_west_europe - tz_94_west_asia - tz_95_west_pacific - tz_96_yakutsk
string
The user”s state or province. Maximum length: 40 characters.
string
When true, this user can send envelopes on the account.
string
When true, this user can sign envelopes.
string
When false, this user can apply tabs to documents during the sending experience.
array
Information about the seals associated with this user.
string
string
When true, the API returns suggested tabs for documents for this user.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is an administrator for the account.
string
When true, this user can use a scratchpad to edit information.
string
string
True if the user can manage users.
string
When true, this user can manage templates for the account.
string
When true, this user can send API requests on the account.
string
True if the user can manage administrators.
string
string
string
When true, this user can send envelopes “on behalf of” other users through the API.
string
When true, this user can access the Other Actions menu.
string
When true, the system notifies this user before applying a matching template.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
True if the user can manage sharing.
string
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
string
When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
string
When true, indicates that this user can send envelope-specific API requests on the account.
string
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create and manage Clickwraps.
string
When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
string
When true, this user is prohibited from uploading documents during sending.
string
True if the user can manage reporting.
string
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
When true, a new template is created each time the user sends an envelope.
string
string
True if the user can manage signing groups.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can participate in envelope transfers on the account.
string
string
When true, this user can use the signing attachments feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can edit the shared address book for the account.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
True if the user can manage account security settings.
string
True if the user can manage account settings.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users see template matching functionality.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can include supplemental documents.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, the sender receives notification that a recipient viewed the envelope.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user receives notifications when envelopes are viewed.
string
Percentage used when matching templates.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user must both view and accept supplemental documents.
string
When true, this user must view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives notification that document markup has been activated.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, this user must accept supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The answer to the first forgotten password challenge question.
string
The answer to the second forgotten password challenge question.
string
The answer to the third forgotten password challenge question.
string
The answer to the fourth forgotten password challenge question.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives only comments that mention their own user name.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notification that he or she is a member of the signing group.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
The first challenge question presented to a user who has forgotten their password.
string
The second challenge question presented to a user who has forgotten their password.
string
The third challenge question presented to a user who has forgotten their password.
string
The fourth challenge question presented to a user who has forgotten their password.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user gets supplemental documents when downloading documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_PROFILE_IMAGEUpdates a user’s DocuSign profile image by uploading a GIF, PNG, JPEG, or BMP file under 200KB; dimensions of no more than 79x79 pixels are recommended. Users can only update their own image, and the authenticated user ID is used when none is supplied.

Input Parameters

object
required
The profile image file to upload. Supported formats: gif, png, jpeg, bmp. The file must be less than 200KB. For best results, DocuSign recommends the image be no more than 79 pixels wide and high.
string
The unique identifier of the user whose profile image is being updated. This is automatically set to the authenticated user’s ID. Users can only update their own profile image. Leave empty to use the current user.
string
The external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is automatically populated from your authenticated account and typically does not need to be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_PROFILE_INFORMATIONUpdates a user’s DocuSign profile, including personal details, privacy and ID card settings, locale preferences, and account settings. Users can only update their own information, and some settings may require administrator rights. The update normally targets the first account associated with the authenticated user, rather than the supplied account ID.

Input Parameters

string
The title of the user.
string
required
The unique identifier for the user whose profile is being updated. This is a required path parameter that specifies which user”s information will be modified. Note that users can only access and modify their own information, even if they have administrative rights. The userId must be a valid user ID within the specified account.
string
The external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This is a required path parameter used to specify which account the user profile belongs to. It must be a valid account identifier within the DocuSign system.
string
The name of the user”s company.
string
A fax number associated with the address, if one is available.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
When true, the user”s ID card can be viewed from signed documents and envelope history.
string
The URL for retrieving the user”s profile image.
string
The user”s country. Maximum length: 50 characters.
string
A URI containing the user ID.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
The user”s email address.
string
The title of the user.
string
The user”s postal code. Maximum length: 20 characters.
string
When true, the user”s address and phone number display on the ID card.
string
When true, the user”s usage information displays on the ID card.
string
The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user”s settings.
string
The name of the user”s company.
string
When true, the user is an administrator.
array
Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
string
The user”s job title.
string
The user”s last name. Maximum Length: 50 characters.
string
The user”s encrypted password hash.
string
The name of the user.
string
The type of user, for example CompanyUser.
string
The user”s first name. Maximum Length: 50 characters.
array
A list of the group information for groups to add the user to. Use UserGroups: listGroups to get information about groups. When setting a user”s group, only the groupId is required.
string
This property has been deprecated.
string
string
When true, the user”s company and title information display on the ID card.
string
The number of envelopes the user has sent.
string
The user”s middle name. Limit: 50 characters.
string
The suffix for the user”s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
string
Status of the user”s account. One of: - ActivationRequired - ActivationSent - Active - Closed - Disabled
string
The user”s state or province. Maximum length: 40 characters.
string
The two-letter code for the user”s country.
string
Boolean value that indicates whether the user is currently logged in or not.
string
The number of envelopes the user has signed.
string
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
array
The name/value pair information for the user custom setting.
string
The date and time that the user”s profile was last modified.
string
The UTC DateTime when the item was created.
boolean
string
The URL for retrieving the user”s profile image.
string
The default account ID associated with the user.
string
A fax number associated with the address, if one is available.
string
The URI for retrieving the image of the user”s initials.
string
When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
string
A fax number associated with the address, if one is available.
string
The date and time the user last sent an envelope.
string
The user”s city. Maximum length: 40 characters.
string
An endpoint URI that you can use to retrieve the user”s signature image.
string
The user”s city. Maximum length: 40 characters.
string
A phone number associated with the address.
string
If password expiration is enabled, the date-time when the user”s password expires.
string
A phone number associated with the address.
string
The date and time the user last signed an envelope.
string
The ID of the permission profile. Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
string
This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following these steps.
string
Access code provided to the user to activate the account.
string
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
string
The user”s country. Maximum length: 50 characters.
string
The user”s locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
string
The user”s country. Maximum length: 50 characters.
array
Object representing the user”s custom Connect configuration.
string
A brief message describing the error condition.
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
The name of the account permission profile. Example: Account Administrator
string
The first line of the user”s address. Maximum length: 100 characters.
string
The second line of the user”s address. Maximum length: 100 characters.
string
string
When true, this user can use the bulk send feature for the account.
string
string
The code associated with the error condition.
string
The user”s postal code. Maximum length: 20 characters.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
The user”s postal code. Maximum length: 20 characters.
string
The user ID (GUID) of the user who last modified this user record. This property is read-only.
string
Reserved for Docusign.
string
When true, daylight savings time is in effect for this user”s time zone.
string
The date and time that the user was added to the account.
string
The date on which this user record was last modified.
string
Note referencing the page that modified this user record.
string
The custom DateTime format setting for this user.
string
Indicates the specified Vaulting mode: - none - estored - electronic_original
string
string
Determines how negative currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
0 - OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar
($1,234,567.89) - Minus_CSym_1_Comma_234_Comma_567_Period_89
-$1,234,567.89 - Minus_CSym_Space_1_Period_234_Period_567_Comma_89
-$ 1.234.567,89 - CSym_Space_Minus_1_Period_234_Period_567_Comma_89
$ -1.234.567,89 - Minus_1_Period_234_Period_567_Comma_89_Space_CSym
-1.234.567,89 $ - OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar
(1 234 567,89 $) - Minus_1_Space_234_Space_567_Comma_89_Space_CSym
-1 234 567,89 $ - CSym_Minus_1_Quote_234_Quote_567_Period_89
$-1"234"567.89 - Minus_CSym_1_Period_234_Period_567_Comma_89
-$1.234.567,89 - Minus_CSym_1_Comma_234_Comma_567
-$1,234,567 - Minus_CSym_12_Comma_34_Comma_567_Period_89
-$12,34,567.89 - OPar_CSym_Space_1234_Comma_567_Period_89_CPar
($ 1234,567.89) - CSym_Space_Minus_12_Comma_34_Comma_567_Period_89
$ -12,34,567.89 - CSym_Minus_12_Comma_34_Comma_567_Period_89
$-1,234,567.89 - CSym_Space_Minus_1_Space_234_Space_567_Comma_89
$ -1 234 567,89 - CSym_Space_Minus_1_Space_234_Space_567_Period_89
$ -1 234 567.89 - Minus_CSym_Space_1_Space_234_Space_567_Comma_89
-$ 1 234 567,89 - Minus_1_Space_234_Space_567_Comma_89_CSym
-1 234 567,89$ - Minus_1_Space_234_Space_567_Period_89_Space_CSym
-1 234 567.89 $ - OPar_CSym_1_Period_234_Period_567_CPar
(1.234.567) - OPar_CSym_1_Comma_234_Comma_567_CPar
($1,234,567) - Minus_1_Comma_234_Comma_567_Period_89_Space_CSym
-1,234,567.89 $ - Minus_CSym_Space_1_Comma_234_Comma_567_Period_89
-$ 1,234,567.89 - OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar
($ 1.234.567,89) - OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar
($ 1"234"567.89) - OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar
($ 1 234 567,89) - OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar
($ 1 234 567.89) - OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar
($12,34,567.89) - OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar
($ 12,34,567.89) - OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar
(1,234,567.89 $) - OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar
(1.234.567,89 $) - OPar_1_Space_234_Space_567_Comma_89_CSym_CPar
(1 234 567,89$) - OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar
(1 234 567.89 $) - OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar
($ 1,234,567.89) - Minus_CSym_1_Period_234_Period_567
-$ 1.234.567 - Minus_CSym_Space_1_Quote_234_Quote_567_Period_89
-$ 1"234"567.89 - Minus_CSym_Space_1_Space_234_Space_567_Period_89
-$ 1 234 567.89 - CSym_Minus_1_Comma_234_Comma_567
$-1,234,567 - CSym_Minus_1_Period_234_Period_567
$-1.234.567 - CSym_Space_Minus_1_Quote_234_Quote_567_Period_89
$ -1"234"567.89 - CSym_Space_Minus_1_Comma_234_Comma_567_Period_89
$ -1,234,567.89 - Minus_CSym_Space_12_Comma_34_Comma_567_Period_89
-$ 12,34,567.89 - Minus_1_Period_234_Period_567_Space_CSym
-123.456.789 $ - CSym_Minus_1_Space_234_Space_567_Comma_89
$-123 456 789,00 - Minus_1_Quote_234_Quote_567_Period_89_Space_CSym
-123"456"789.00 $ - CSym_1_Comma_234_Comma_567_Period_89_Minus
$123,456,789.00- - CSym_Minus_1_Period_234_Period_567_Comma_89
$-123.456.789,00 - OPar_CSym_1_Period_234_Period_567_Comma_89_CPar
($123.456.789,00) - Minus_CSym_1234_Comma_567_Period_89
-$123456,789.00 - Minus_CSym_1_Space_234_Space_567_Comma_89
-$123 456 789,00
string
Determines how positive currency values are displayed. In most cases, you should not need to change this value. See Explicitly define formatting. Valid values: - Default
Uses the current locale. - CSym_1_Comma_234_Comma_567_Period_89
$1,234,567.89 - CSym_Space_1_Period_234_Period_567_Comma_89
$ 1.234.567,89 - Leading_1_Period_234_Period_567_Comma_89_Space_CSym
1.234.567,89 $ - Leading_1_Space_234_Space_567_Comma_89_Space_CSym
1 234 567,89 $ - CSym_Space_1_Quote_234_Quote_567_Period_89
$ 1"234"567.89 - CSym_1_Comma_234_Comma_567
$1,234,567 - CSym_Space_12_Comma_34_Comma_567_Period_89
$ 12,34,567.89 - CSym_12_Comma_34_Comma_567_Period_89
$12,34,567.89 - CSym_Space_1234_Comma_567_Period_89
$ 1234,567.89 - Leading_1_Space_234_Space_567_Period_89_Space_CSym
1 234 567.89 $ - CSym_Space_1_Space_234_Space_567_Comma_89
$ 1 234 567,89 - CSym_Space_1_Space_234_Space_567_Period_89
$ 1 234 567.89 - Leading_1_Space_234_Space_567_Comma_89_CSym
1 234 567,89$ - CSym_1_Period_234_Period_567
$1.234.567 - Leading_1_Comma_234_Comma_567_Period_89_Space_CSym
1,234,567. $ (New Armenian) - CSym_Space_1_Comma_234_Comma_567_Period_89
$ 1,234,567.89 (Persian) - CSym_1_Period_234_Period_567_Comma_89
$123.456.789,00 (es-CO) - Leading_1_Quote_234_Quote_567_Period_89_Space_CSym
123"456"789.00 $ (fr-ch) - CSym_1234_Comma_567_Period_89
$123456,789.00 (es-PR) - Leading_1_Period_234_Period_567_Space_CSym
123.456.789 $ - CSym_1_Space_234_Space_567_Comma_89
$123 456 789,00 (en-ZA, es-CR)
string
The date and time that the user”s profile was last modified.
string
Indicates the Power Form mode setting for the user: - none - admin - user
string
The user”s state or province. Maximum length: 40 characters.
string
When true, specifies that an additional activation email be sent if user”s log on fails before the account is activated.
string
When true, this user can export authoritative copy for the account.
string
When true, Vaulting is enabled for the account.
string
The timezone offset for the user. Valid values: - tz_01_afghanistan - tz_02_alaskan - tz_03_arab - tz_04_arabian - tz_05_arabic - tz_06_argentina - tz_07_atlantic - tz_08_aus_central - tz_09_aus_eastern - tz_10_azerbaijan - tz_11_azores - tz_12_bangladesh - tz_13_canada_central - tz_14_cape_verde - tz_15_caucasus - tz_16_central_australia - tz_17_central_america - tz_18_central_asia - tz_19_central_brazilian - tz_20_central_europe - tz_21_central_european - tz_22_central_pacific - tz_23_central - tz_24_central_mexico - tz_25_china - tz_26_dateline - tz_27_east_africa - tz_28_east_australia - tz_29_east_europe - tz_30_east_south_america - tz_31_eastern - tz_32_egypt - tz_33_ekaterinburg - tz_34_fiji - tz_35_fli - tz_36_georgian - tz_37_gmt - tz_38_greenland - tz_39_greenwich - tz_40_gtb - tz_41_hawaiian - tz_42_india - tz_43_iran - tz_44_israel - tz_45_jordan - tz_46_kaliningrad - tz_47_kamchatka - tz_48_korea - tz_49_magadan - tz_50_mauritius - tz_51_mid_atlantic - tz_52_middle_east - tz_53_montevideo - tz_54_morocco - tz_55_mountain - tz_56_mountain_mexico - tz_57_myanmar - tz_58_north_central_asia - tz_59_namibia - tz_60_nepal - tz_61_new_zealand - tz_62_new_foundland - tz_63_north_asia_east - tz_64_north_asia - tz_65_pacific_sa - tz_66_pacific - tz_67_pacific_mexico - tz_68_pakistan - tz_69_paraguay - tz_70_romance - tz_71_russian - tz_72_sa_eastern - tz_73_sa_pacific - tz_74_sa_western - tz_75_samoa - tz_76_se_asia - tz_77_singapore - tz_78_south_africa - tz_79_sriLanka - tz_80_syria - tz_81_taipei - tz_82_tasmania - tz_83_tokyo - tz_84_tonga - tz_85_turkey - tz_86_ulaanbaatar - tz_87_us_eastern - tz_88_us_mountain - tz_89_venezuela - tz_90_vladivostok - tz_91_west_australia - tz_92_west_central_africa - tz_93_west_europe - tz_94_west_asia - tz_95_west_pacific - tz_96_yakutsk
string
The user”s state or province. Maximum length: 40 characters.
string
True if the user can manage users.
string
When true, this user can send envelopes on the account.
string
When true, this user can sign envelopes.
string
When false, this user can apply tabs to documents during the sending experience.
array
Information about the seals associated with this user.
string
True if the user can manage administrators.
string
string
string
When true, the API returns suggested tabs for documents for this user.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is an administrator for the account.
string
When true, this user can use a scratchpad to edit information.
string
string
True if the user can manage sharing.
string
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, this user can manage templates for the account.
string
When true, this user can send API requests on the account.
string
True if the user can manage reporting.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can send envelopes “on behalf of” other users through the API.
string
When true, this user can access the Other Actions menu.
string
When true, the system notifies this user before applying a matching template.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
True if the user can manage signing groups.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
string
When true, indicates that this user can send envelope-specific API requests on the account.
string
string
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can create and manage Clickwraps.
string
When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user is prohibited from uploading documents during sending.
string
True if the user can manage account security settings.
string
True if the user can manage account settings.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if the signer changes.
string
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the time zone. Valid values: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
string
When true, a new template is created each time the user sends an envelope.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the sender receives an email notification if envelope delivery fails.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, the user receives notification that the envelope has been voided.
string
When true, the user receives an email notification when a document purge occurs.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can participate in envelope transfers on the account.
string
string
When true, this user can use the signing attachments feature.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the sender receives notification that a recipient viewed the envelope.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user can edit the shared address book for the account.
string
Specifies the date format. Valid values: - default
used the UI”s - longformat
use the UI”s long format - dd_mm_yy
dd-MM-yy - dd_mmm_yy
dd-MMM-yy - dd_mm_yyyy
dd-MM-yyyy - dd_mmm_yyyy
dd-MMM-yyyy - ddmmmmyyyy
dd MMMM yyyy - ddmmyyyy
dd/MM/yyyy - ddmmyyyy_de
dd.MM.yyyy - dmyyyy
d/M/yyyy - d_m_yyyy
d-M-yyyy - mmmd_yyyy
MMM d, yyyy - mmm_dd_yyyy
MMM-dd-yyyy - mmmmd_yyyy
MMMM d, yyyy - mm_dd_yyyy
MM-dd-yyyy - mdyyyy
M/d/yyyy - yyyy_mmm_dd
yyyy-MMM-dd - yyyy_mm_dd
yyyy-MM-dd - yyyymmdd
yyyy/MM/dd - yyyymd
yyyy/M/d - custom
Customer set own value - mmddyyyy
MM/dd/yyyy - mmddyy
MM/dd/yy - yyyy_mmmm_d
yyyy MMMM d
string
Describes how names are displayed. Valid values: - first_middle_last
William Henry Gates - full
Mr William Henry Gates III - last_first
Gates William - lastfirst
GatesWilliam - last_first_cjk
Gates William only with CJK characters - lastfirst_cjk
GatesWilliam only with CJK characters {/* Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 */}
string
Specifies the time format. Valid values: - none
None - hh_mm
hh:mm - hhmm
HH:mm - hhmmss
HH:mm:ss - hhmmsstt
HH:mm:ss tt - hhmmtt
HH:mm tt - hmm
h:mm - hmmss
h:mm:ss - hmmsstt
h:mm:ss tt - hmmtt
h:mm tt - custom
Customer-set format {/* Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 */}
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives an email notification when the envelope has been completed.
When true, the user receives an email notification if consent is withdrawn.
string
When true, the user receives an email notification when the envelope has been completed.
string
When true, the user receives notification that the envelope has been declined.
string
When true, the user receives notification that the envelope has been reassigned.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the Docusign application. Note: Only SysAdmin users can change this setting.
string
When true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting.
string
string
The two letter ISO 639-1 language code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, users see template matching functionality.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives agent notification emails.
string
When true, the user receives notification that the envelope has been corrected.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can include supplemental documents.
string
string
When true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting.
string
Specifies the type of calendar. Valid values: - gregorian - japanese - buddhist
string
The ISO 4217 currency code.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives all comments.
string
When true, the user receives all comments.
string
When true, the user receives notification that the envelope has been activated.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Specifies the address format. Valid values: - en_us - ja_jp - zh_cn_tw
string
When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for “William Henry Gates”. - first1last1
“WG” - last2
“GA” - first2
“WI” - last2_cjk
first two characters from last name in CJK characters. {/* Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs */}
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user receives notifications when envelopes are viewed.
string
Percentage used when matching templates.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, the user receives notification that document markup has been activated.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user gets supplemental documents when downloading documents.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The format for the signature date. Valid values are: - d/M/yyyy - dd-MM-yy - dd-MMM-yy - dd-MM-yyyy - dd.MM.yyyy - dd-MMM-yyyy - dd MMMM yyyy - M/d/yyyy - MM-dd-yyyy - MM/dd/yyyy - MM/dd/yy - MMM-dd-yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy-MM-dd - yyyy-MMM-dd - yyyy/MM/dd - yyyy MMMM d Note: Only Admin users can change this setting.
string
The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives an email notification if offline signing failed.
string
When true, the user receives an email notification if offline signing failed.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, this user must both view and accept supplemental documents.
string
When true, this user must view supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, the user receives only comments that mention their own user name.
string
When true, the sender receives notification that the envelope was declined.
string
When true, the user receives notifications of carbon copy deliveries.
string
When true, the user receives notifications of certified deliveries.
string
When true, the user receives only comments that mention their own user name.
string
When true, the user receives notification that he or she is a member of the signing group.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
When true, this user must accept supplemental documents.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Sets how self-signed documents are presented to the email recipients. Valid values are: - include_pdf: A PDF of the completed document is attached to the email. - include_link: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The answer to the first forgotten password challenge question.
string
The answer to the second forgotten password challenge question.
string
The answer to the third forgotten password challenge question.
string
The answer to the fourth forgotten password challenge question.
string
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
The first challenge question presented to a user who has forgotten their password.
string
The second challenge question presented to a user who has forgotten their password.
string
The third challenge question presented to a user who has forgotten their password.
string
The fourth challenge question presented to a user who has forgotten their password.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
array
An array of option strings supported by this setting.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
string
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
Indicates whether the property is editable. Valid values are: - editable - read_only
string
Reserved for Docusign.
string
Reserved for Docusign.
string
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_USER_SIGNATURE_BY_IDUpdates or creates the authenticated user’s DocuSign signature and initials, with options for font, stamp format, and date stamp properties. The operation targets the connected account selected for the authenticated user, overriding any supplied account ID.

Input Parameters

string
The National Association of Realtors (NAR) membership ID for a user who is a realtor.
string
The ID of the user whose signature is being updated or created. This parameter is required and must match the authenticated user”s ID. Users can only access and modify their own signature information, even those with admin rights cannot access another user”s settings. If not provided, the userId will be automatically extracted from the authentication token.
string
The external account number (integer) or account ID GUID. This parameter is required and identifies the specific DocuSign account for which the signature is being updated or created. It must be a valid account identifier associated with the authenticated user.
string
Specificies the type of image. Valid values: - stamp_image - signature_image - initials_image
string
Boolean that specifies whether the signature is the default signature for the user.
string
Optionally specify an external identifier for the user”s signature.
string
required
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as ”&”, ”<”, ”>”) in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
string
The format of a stamp. Valid values are: - NameHanko: The stamp represents only the signer”s name. - NameDateHanko: The stamp represents the signer”s name and the date.
string
The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
string
The realtor”s last name.
string
The phonetic spelling of the signatureName.
string
The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not enums. - "1_DocuSign" - "2_DocuSign" - "3_DocuSign" - "4_DocuSign" - "5_DocuSign" - "6_DocuSign" - "7_DocuSign" - "8_DocuSign" - "Mistral" - "Rage Italic"
string
Specifies the user”s signature name.
string
Specifies the type of signature.
string
Specifies the user”s signature in initials format.
string
When true, users may not resize the stamp.
string
An optional query parameter. When set to “true”, it closes the current signature before creating or updating a new one. This can be useful when replacing an existing signature entirely. The parameter accepts a string value, where “true” (case-insensitive) enables this behavior.
string
The X axis position of the top-left corner.
string
The Y axis position of the top-left corner.
string
The width of the rectangle.
string
The height of the rectangle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_WORKFLOW_STEP_FOR_TEMPLATEThis 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.

Input Parameters

string
Indicates the action to perform. Valid values: - pause_before: The workflow should pause before the trigger described by triggerOnItem is reached.
string
The unique ID of the item being triggered.
string
The status of the step. Valid values: - inactive - in_progress - paused - pending - completed This property is read-only.
string
The external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the template workflow step is being updated. It is required for the API call and must be a valid string representing either the numeric account ID or the account”s GUID.
string
required
The ID of the template. This parameter specifies the unique identifier of the DocuSign template containing the workflow step to be updated. It is required for the API call and must be a valid string representing the template”s ID within the specified account.
string
The timestamp of when the workflow step transitioned to completed status. This property is read-only.
string
The type of item that triggers this workflow step. Valid values: * routing_order
string
The timestamp of when the workflow step transitioned to in_progress status. This property is read-only.
string
required
A unique identifier for this workflow step. This property is read-only.
array
User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
string
Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step”s recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step”s recipients. This property is read-only.
string
The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_WORKSPACE_INFORMATIONUpdates 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.

Input Parameters

string
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
string
The UTC DateTime when the workspace user authorization was created.
string
The external account number (integer) or account ID GUID. This parameter is required and must be provided in the path to identify the DocuSign account associated with the workspace being updated.
string
required
The ID of the workspace, always populated.
string
Utc date and time the comment was last updated (can only be done by creator.)
string
The relative URI for accessing the workspace.
string
The name of the workspace.
string
The relative URL for accessing the workspace.
string
The ID of the account to bill.
string
Text describing the purpose of the workspace.
string
Type of the user. Valid values: type_owner, type_participant.
string
The workspace user”s email address.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
When true, commenting on the documents in the workspace is allowed.
string
The UTC DateTime when the workspace user was created.
string
Type of the user. Valid values: type_owner, type_participant.
string
The name of workspace user.
string
The workspace user”s email address.
string
The account ID associated with the workspace user.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
The UTC DateTime when the workspace user was created.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
The name of workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
The account ID associated with the workspace user.
string
Type of the user. Valid values: type_owner, type_participant.
string
The workspace user”s email address.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
string
The ID of the workspace user.
string
The ID of the workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
The UTC DateTime when the workspace user was created.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The name of workspace user.
string
The account ID associated with the workspace user.
string
The ID of the workspace user.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The name of the account that the workspace user belongs to.
string
The UTC DateTime when the user joined the workspace.
string
The ID of the user who created this workspace user.
string
The ID of the workspace.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
The UTC DateTime that the workspace user was last modified.
string
A brief message describing the error condition.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
The ID of the workspace user.
string
A brief message describing the error condition.
string
The ID of the user who last modified the workspace user.
string
The URI for accessing the workspace user.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.
string
The text of the workspace invitation email message sent to the user.
string
The URL for accessing the workspace user.
string
A brief message describing the error condition.
string
The subject line of the workspace invitation email message sent to the user.
string
The code associated with the error condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSIGN_UPDATE_WORKSPACE_ITEM_METADATAUpdates the metadata for a specific file in a DocuSign workspace. This endpoint allows you to modify file properties such as name, content type, extension, and visibility settings without changing the actual file content. Use this action when you need to rename a file, update its MIME type, or change its public/private access settings. The file content itself remains unchanged; only its metadata attributes are modified. This is particularly useful for organizing and managing workspace files, correcting metadata, or adjusting file visibility.

Input Parameters

string
The new name for the file. Use this to rename the file without changing its content or location.
string
required
The unique identifier for the file within the workspace folder. This parameter is required and specifies which file’s metadata will be updated.
string
required
The unique identifier for the folder containing the file. This parameter is required and specifies the parent folder of the file being updated.
string
When set to ‘true’, the file is publicly accessible. When set to ‘false’, the file is private and requires authentication to access.
string
The external account number (integer) or account ID GUID. This parameter identifies the DocuSign account associated with the workspace.
string
The file extension (e.g., ‘pdf’, ‘docx’, ‘jpg’). This should match the file’s content type.
string
The MIME type of the file (e.g., ‘application/pdf’, ‘image/jpeg’). This metadata helps identify the file format.
string
required
The unique identifier for the workspace. This parameter is required and specifies which workspace contains the file to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: DOCUSIGN_ENVELOPE_COMPLETEDType: webhookTriggers when every recipient has finished and the agreement is executed. Watch Recipient Completed instead to react as each individual signer finishes.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_CREATEDType: webhookTriggers when a draft envelope is created, either in the eSignature UI or by an API call that sets the envelope’s status to created. Drafts only: watch Envelope Sent for the moment it goes out.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_DECLINEDType: webhookTriggers when a recipient declines to sign, which declines the whole envelope.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_DELETEDType: webhookTriggers when an already-sent envelope is deleted. An envelope still in the created state fires Envelope Discarded instead.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_DELIVEREDType: webhookTriggers when every recipient has opened the envelope in the DocuSign signing site. This is not email delivery: it fires when recipients click Continue, and where an electronic record and signature disclosure is required, after they accept it.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_DISCARDEDType: webhookTriggers when a draft envelope is deleted or discarded in the tagging UI. An envelope that was already sent fires Envelope Deleted instead.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_PURGE_QUEUEDType: webhookTriggers when an envelope is queued for purging. envelopeSummary.purgeState says which purge was requested, so this is the event to hang document- retention compliance off. Watch Envelope Permanently Removed for the purge actually completing.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_RESENTType: webhookTriggers when the envelope is resent to its recipients from the UI or the API. Watch Recipient Resent for a resend aimed at one recipient.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_SENTType: webhookTriggers when an envelope is sent to at least one recipient, including when a routing order moves on to the next recipient. This is the mainline “a contract went out” event.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_ENVELOPE_VOIDEDType: webhookTriggers when the sender voids the envelope or it expires. envelopeSummary.voidedReason tells the two apart.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_AUTORESPONDEDType: webhookTriggers when email delivery to a recipient fails, either a bad address or an auto-response from their mail system. This is the bounced-signer event.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_COMPLETEDType: webhookTriggers when a specific recipient finishes their actions, usually but not always by signing. This is what a multi-party workflow branches on; watch Envelope Completed for the whole agreement being executed.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_DECLINEDType: webhookTriggers when a specific recipient declines to sign.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_DELIVEREDType: webhookTriggers when a specific recipient opens the documents in the DocuSign signing site. This is not email delivery.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_FINISHED_LATERType: webhookTriggers when a recipient chooses Other Actions then Finish Later, leaving the session without completing. This is the stalled-signature event.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_RESENTType: webhookTriggers when the envelope is resent to one specific recipient. Watch Envelope Resent for a resend to everyone.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_RECIPIENT_SENTType: webhookTriggers when a specific recipient is emailed that it is their turn to sign. Under DocuSign’s individual-message delivery this arrives before the envelope-level Envelope Sent.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
required
Id of the envelope the event is about.
object
A DocuSign envelope — the agreement the event is about.
string
required
Id of the recipient the event is about.
string
The DocuSign user whose action produced the event — the sender or initiator.
Slug: DOCUSIGN_TEMPLATE_CREATEDType: webhookTriggers when a template is created, in the UI or through the API.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
UTC timestamp the template was created.
string
The template’s name.
string
required
Id of the template.
string
The DocuSign user whose action produced the event.
Slug: DOCUSIGN_TEMPLATE_DELETEDType: webhookTriggers when a template is deleted. The payload still carries the template’s id and name, so a workflow can act on something it can no longer fetch.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
UTC timestamp the template was created.
string
The template’s name.
string
required
Id of the template.
string
The DocuSign user whose action produced the event.
Slug: DOCUSIGN_TEMPLATE_MODIFIEDType: webhookTriggers when a template is modified. The payload names the template but not what changed, so re-fetch the template if you need the detail.

Configuration

string
The DocuSign account to watch. Leave empty to use your default account — most logins have exactly one. Supply an id only if you belong to several DocuSign accounts and want a non-default one. Use DOCUSIGN_LIST_OAUTH_USERINFO to find your account ids.

Payload

string
UTC timestamp the template was created. This is its creation time, not the time of this edit — the event carries no modification timestamp.
string
The template’s name.
string
required
Id of the template.
string
The DocuSign user whose action produced the event.