DocuSign
docusignDocuSign provides eSignature and digital agreement solutions, enabling businesses to send, sign, track, and manage documents electronically
Acciones disponibles (342)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add contacts to contacts listDOCUSIGN_ADD_CONTACTS_TO_CONTACTS_LISTAcciónAdds 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.
DOCUSIGN_ADD_CONTACTS_TO_CONTACTS_LISTAcciónAdds 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.
Parámetros de entrada
accountIdstringThe 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 contacts are being added. It should be a valid string representing either an integer account number or a GUID (Globally Unique Identifier) for the account.
contactListobject[]A list of contacts.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
AddemailoverridestoenvelopeDOCUSIGN_ADD_EMAIL_OVERRIDES_TO_ENVELOPEAcciónAdds 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.
DOCUSIGN_ADD_EMAIL_OVERRIDES_TO_ENVELOPEAcciónAdds 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
bccEmailAddressesobject[]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.
replyEmailNameOverridestringThe name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.
replyEmailAddressOverridestringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add envelope attachmentsDOCUSIGN_ADD_ENVELOPE_ATTACHMENTSAcciónAdds 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.
DOCUSIGN_ADD_ENVELOPE_ATTACHMENTSAcciónAdds 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.
Parámetros de entrada
accountIdstringThe 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 to specify which account the envelope belongs to.
envelopeIdstringObligatorioThe 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.
attachmentsobject[]An object that contains information about the attachment.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add existing brand to groupDOCUSIGN_ADD_EXISTING_BRAND_TO_GROUPAcciónThis 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.
DOCUSIGN_ADD_EXISTING_BRAND_TO_GROUPAcciónThis 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.
Parámetros de entrada
brandsobject[]A list of brands.
groupIdstringObligatorioThe 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.
accountIdstringThe external account number (int) or account ID GUID. This is a required parameter used to identify the DocuSign account for which the group brand association is being updated. It must be a valid account identifier within your organization"s DocuSign environment.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
AddfiletoworkspaceDOCUSIGN_ADD_FILE_TO_WORKSPACEAcciónThis 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.
DOCUSIGN_ADD_FILE_TO_WORKSPACEAcciónThis 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.
Parámetros de entrada
folderIdstringObligatorioThe 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.
accountIdstringThe 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".
workspaceIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add members to signing groupDOCUSIGN_ADD_MEMBERS_TO_SIGNING_GROUPAcciónThis 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.
DOCUSIGN_ADD_MEMBERS_TO_SIGNING_GROUPAcciónThis 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.
Parámetros de entrada
usersobject[]User management information.
accountIdstringThe 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.
signingGroupIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add new users to a specified accountDOCUSIGN_ADD_NEW_USERS_TO_A_SPECIFIED_ACCOUNTAcciónThis endpoint adds new users to a specified docusign account, allowing bulk creation of up to 500 users in a single call. it's ideal for quickly setting up multiple users with customized permissions and settings. the endpoint requires at least a username and email for each user, but supports additional configuration options. it returns detailed information about created users, including ids and status.
DOCUSIGN_ADD_NEW_USERS_TO_A_SPECIFIED_ACCOUNTAcciónThis endpoint adds new users to a specified docusign account, allowing bulk creation of up to 500 users in a single call. it's ideal for quickly setting up multiple users with customized permissions and settings. the endpoint requires at least a username and email for each user, but supports additional configuration options. it returns detailed information about created users, including ids and status.
Parámetros de entrada
newUsersobject[]A list of one or more new users.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
AddorupdateaccountstampsDOCUSIGN_ADD_OR_UPDATE_ACCOUNT_STAMPSAcciónThis endpoint allows you to add or update one or more account stamps in a docusign account. it provides a comprehensive way to manage signature and stamp settings, including image properties, user associations, and stamp-specific details. use this endpoint when you need to create new stamps or modify existing ones for an account. it's particularly useful for bulk operations on multiple stamps. note that this endpoint doesn't handle the actual process of signing documents, but rather manages the stamps available for use in the signing process.
DOCUSIGN_ADD_OR_UPDATE_ACCOUNT_STAMPSAcciónThis endpoint allows you to add or update one or more account stamps in a docusign account. it provides a comprehensive way to manage signature and stamp settings, including image properties, user associations, and stamp-specific details. use this endpoint when you need to create new stamps or modify existing ones for an account. it's particularly useful for bulk operations on multiple stamps. note that this endpoint doesn't handle the actual process of signing documents, but rather manages the stamps available for use in the signing process.
Parámetros de entrada
accountIdstringThe 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 stamps are being modified. The value must be a non-empty string representing a valid DocuSign account identifier.
decode_onlystringAn optional query parameter that, when provided, indicates that the request should only decode the input without performing any operations. The specific behavior when this parameter is used is not detailed in the schema. It accepts a string value, but the exact format or valid values are not specified. Use this parameter with caution and refer to additional documentation for its precise usage.
accountSignaturesobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add or update user custom settingsDOCUSIGN_ADD_OR_UPDATE_USER_CUSTOM_SETTINGSAcciónAdds or updates custom user settings for a specified docusign user. this endpoint allows for flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard docusign account settings. it supports grouping of settings using the x-docusign-user-settings-key header for more organized management. the endpoint has a 4,000 character limit for all custom settings per user, including xml and json structure.
DOCUSIGN_ADD_OR_UPDATE_USER_CUSTOM_SETTINGSAcciónAdds or updates custom user settings for a specified docusign user. this endpoint allows for flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard docusign account settings. it supports grouping of settings using the x-docusign-user-settings-key header for more organized management. the endpoint has a 4,000 character limit for all custom settings per user, including xml and json structure.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose custom settings are being added or updated. This parameter is required and must be provided in the path of the API request. Note that users can only access and modify their own settings, even if they have admin rights.
accountIdstringThe 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.
customSettingsobject[]The name/value pair information for the user custom setting.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
AddorupdateusersignatureDOCUSIGN_ADD_OR_UPDATE_USER_SIGNATUREAcciónThis 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.
DOCUSIGN_ADD_OR_UPDATE_USER_SIGNATUREAcciónThis 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.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose signature is being added or updated. This parameter is required and must be provided in the path of the API call. It"s important to note that users can only access and modify their own signature information, even if they have administrative rights.
accountIdstringThe 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 signature operation is performed within the correct account context.
userSignaturesobject[]An array of `userSignature` objects.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add part to chunked uploadDOCUSIGN_ADD_PART_TO_CHUNKED_UPLOADAcciónAdds 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.
DOCUSIGN_ADD_PART_TO_CHUNKED_UPLOADAcciónAdds 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.
Parámetros de entrada
datastringA 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.
accountIdstringThe 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.
chunkedUploadIdstringObligatorioThe ID of the chunked upload. **Note:** This property is ignored in requests, and overridden with an auto-generated value in responses.
chunkedUploadPartSeqstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add step to envelope workflowDOCUSIGN_ADD_STEP_TO_ENVELOPE_WORKFLOWAcciónThis 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.
DOCUSIGN_ADD_STEP_TO_ENVELOPE_WORKFLOWAcciónThis 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.
Parámetros de entrada
actionstringIndicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
itemIdstringThe unique ID of the item being triggered.
statusstringThe status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only.
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
completedDatestringThe timestamp of when the workflow step transitioned to `completed` status. This property is read-only.
triggerOnItemstringThe type of item that triggers this workflow step. Valid values: * `routing_order`
triggeredDatestringThe timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only.
workflowStepIdstringA unique identifier for this workflow step. This property is read-only.
delayedRouting__rulesobject[]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.
delayedRouting__statusstringStatus 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.
delayedRouting__resumeDatestringThe 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.
recipientRouting__rules__conditionalRecipientsobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add templates to document in envelopeDOCUSIGN_ADD_TEMPLATES_TO_DOCUMENT_IN_ENVELOPEAcciónThis 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.
DOCUSIGN_ADD_TEMPLATES_TO_DOCUMENT_IN_ENVELOPEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
documentTemplatesobject[]preserve_template_recipientstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add templates to envelopeDOCUSIGN_ADD_TEMPLATES_TO_ENVELOPEAcciónThis 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.
DOCUSIGN_ADD_TEMPLATES_TO_ENVELOPEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
documentTemplatesobject[]preserve_template_recipientstringAn optional query parameter that determines whether to preserve or remove envelope recipients when applying the template. 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add user signature and initials imagesDOCUSIGN_ADD_USER_SIGNATURE_AND_INITIALS_IMAGESAcciónThis endpoint allows you to add or update a user's signature and/or initials images in the docusign system. it supports both creating default signatures based on the user's name and uploading custom signature images. the endpoint can be used with either json or multipart form data, depending on whether you're creating a default signature or uploading custom images. it's particularly useful when setting up new users or updating existing user signatures. note that each update may generate a new signatureid, so applications should rely on the signature name for consistent identification.
DOCUSIGN_ADD_USER_SIGNATURE_AND_INITIALS_IMAGESAcciónThis endpoint allows you to add or update a user's signature and/or initials images in the docusign system. it supports both creating default signatures based on the user's name and uploading custom signature images. the endpoint can be used with either json or multipart form data, depending on whether you're creating a default signature or uploading custom images. it's particularly useful when setting up new users or updating existing user signatures. note that each update may generate a new signatureid, so applications should rely on the signature name for consistent identification.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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 and is required for the API call.
userSignaturesobject[]An array of `userSignature` objects.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add users to existing groupDOCUSIGN_ADD_USERS_TO_EXISTING_GROUPAcciónAdds 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.
DOCUSIGN_ADD_USERS_TO_EXISTING_GROUPAcciónAdds 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.
Parámetros de entrada
usersobject[]An array of `userInfo` objects containing information about the users in the group.
groupIdstringObligatorioThe 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.
accountIdstringThe 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 is used to specify the account context for the group user addition operation. The value should be a valid DocuSign account identifier, typically a UUID format for the GUID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ApplyactiontobulksendenvelopesDOCUSIGN_APPLY_ACTION_TO_BULK_SEND_ENVELOPESAcciónThis 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.
DOCUSIGN_APPLY_ACTION_TO_BULK_SEND_ENVELOPESAcciónThis 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.
Parámetros de entrada
actionstringThe action to apply. Valid values: * `Resend` * `Correct` * `Void` This property is required and case-sensitive. The value must correspond to the `bulkAction` query parameter.
accountIdstringThe 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.
bulkActionstringObligatorioThe action to apply to the bulk send batch. This parameter is required and must be one of the following case-sensitive string values: "resend" (to resend failed or undelivered envelopes), "correct" (to make corrections to the envelopes in the batch), or "void" (to cancel and void all envelopes in the batch). The chosen action will be applied to all envelopes in the specified batch.
voidReasonstringA string explaining why the envelope is voided. This value is shown in a message to the recipients. This property is required if `action` is `Void`.
bulkSendBatchIdstringObligatorioThe 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.
notification__useAccountDefaultsstringWhen **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.**
notification__expirations__expireWarnstringAn 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.
notification__expirations__expireAfterstringAn integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**
notification__reminders__reminderDelaystringAn 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.
notification__expirations__expireEnabledstringWhen **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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html).
notification__reminders__reminderEnabledstringWhen **true,** reminders are enabled. The default value is **false.**
notification__reminders__reminderFrequencystringAn integer specifying the interval in days between reminder emails. The default value is 0.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ChangeusersinaccountDOCUSIGN_CHANGE_USERS_IN_ACCOUNTAcciónThis 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.
DOCUSIGN_CHANGE_USERS_IN_ACCOUNTAcciónThis 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.
Parámetros de entrada
usersobject[]User management information.
nextUristringThe 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.
accountIdstringThe 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.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
allow_all_languagesstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CloseusersinaccountDOCUSIGN_CLOSE_USERS_IN_ACCOUNTAcciónCloses 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.
DOCUSIGN_CLOSE_USERS_IN_ACCOUNTAcciónCloses 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.
Parámetros de entrada
usersobject[]An array of `userInfo` objects containing information about the users in the group.
deletestringAn 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.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Commit chunked upload for envelopesDOCUSIGN_COMMIT_CHUNKED_UPLOAD_FOR_ENVELOPESAcciónThis 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.
DOCUSIGN_COMMIT_CHUNKED_UPLOAD_FOR_ENVELOPESAcciónThis 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.
Parámetros de entrada
actionstringA query parameter that specifies the action to be performed on the chunked upload. For this endpoint, the only valid value is "commit", which instructs the API to validate and prepare the chunked upload for use with other API calls. While marked as optional in the schema, it is actually required for the commit operation. The value must be the string "commit" (case-sensitive).
accountIdstringThe 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 chunked upload belongs to. The value must be a non-empty string representing a valid DocuSign account identifier.
chunkedUploadIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Configure cloud storage redirect urlDOCUSIGN_CONFIGURE_CLOUD_STORAGE_REDIRECT_URLAcciónThis endpoint configures the redirect url information for one or more cloud storage providers associated with a specific user in docusign. it allows setting up the authentication flow between docusign and various cloud storage services, enabling secure access to documents stored in these cloud providers. the endpoint should be used when integrating cloud storage services with docusign for a user, ensuring proper authentication and redirection after the cloud storage provider authenticates the user. it's important to note that the redirect url must be within the docusign.com or docusign.net domains for security reasons. the endpoint returns the configured storage providers with their respective authentication urls, which are crucial for completing the authentication process.
DOCUSIGN_CONFIGURE_CLOUD_STORAGE_REDIRECT_URLAcciónThis endpoint configures the redirect url information for one or more cloud storage providers associated with a specific user in docusign. it allows setting up the authentication flow between docusign and various cloud storage services, enabling secure access to documents stored in these cloud providers. the endpoint should be used when integrating cloud storage services with docusign for a user, ensuring proper authentication and redirection after the cloud storage provider authenticates the user. it's important to note that the redirect url must be within the docusign.com or docusign.net domains for security reasons. the endpoint returns the configured storage providers with their respective authentication urls, which are crucial for completing the authentication process.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose cloud storage settings are being configured. This parameter is required and must be provided in the path of the API request. Note that users can only access and modify their own information, even if they have administrative rights.
accountIdstringThe 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.
storageProvidersobject[]An Array containing the storage providers associated with the user.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create account custom fieldDOCUSIGN_CREATE_ACCOUNT_CUSTOM_FIELDAcciónCreates 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.
DOCUSIGN_CREATE_ACCOUNT_CUSTOM_FIELDAcciónCreates 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.
Parámetros de entrada
namestringThe name of the custom field.
showstringWhen **true,** the custom field displays at the top of the Certificate of Completion.
valuestringSpecifies the value of the custom field. Maximum Length: 2,000 characters.
fieldIdstringThe ID of the custom field.
requiredstringWhen **true,** the signer must complete the custom field.
accountIdstringThe 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 custom field should be created for.
listItemsstring[]For a list custom field, this is an array of strings that represent the items in a list. Maximum Length: 2,000 characters.
customFieldTypestringThe type of custom field. Valid values are: - `text` (default) - `list`
apply_to_templatesstringAn optional boolean parameter that, when set to true, applies the newly created custom field to all existing templates in the account. If not specified or set to false, the custom field will only be available for new envelopes and not affect existing templates. Use this parameter when you want to retroactively add the custom field to all templates.
errorDetails__messagestringA brief message describing the error condition.
errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a collaborative workspaceDOCUSIGN_CREATE_A_COLLABORATIVE_WORKSPACEAcciónThis endpoint creates a new collaborative workspace in docusign, providing a shared area for document management and workflow collaboration. it should be used when setting up a new project or team that requires a centralized space for file sharing and collaborative work. the workspace creation process includes specifying workspace details, settings, and initial user information. note that this endpoint only creates the workspace; adding members and files are separate operations.
DOCUSIGN_CREATE_A_COLLABORATIVE_WORKSPACEAcciónThis endpoint creates a new collaborative workspace in docusign, providing a shared area for document management and workflow collaboration. it should be used when setting up a new project or team that requires a centralized space for file sharing and collaborative work. the workspace creation process includes specifying workspace details, settings, and initial user information. note that this endpoint only creates the workspace; adding members and files are separate operations.
Parámetros de entrada
statusstringIndicates 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.
createdstringThe UTC DateTime when the workspace user authorization was created.
accountIdstringThe external account number (integer) or account ID GUID that identifies the DocuSign account for which the workspace is being created. This parameter is required and must be provided in the path of the API request. It ensures that the workspace is associated with the correct account in DocuSign"s system.
workspaceIdstringThe ID of the workspace, always populated.
lastModifiedstringUtc date and time the comment was last updated (can only be done by creator.)
workspaceUristringThe relative URI for accessing the workspace.
workspaceNamestringThe name of the workspace.
workspaceBaseUrlstringThe relative URL for accessing the workspace.
billableAccountIdstringThe ID of the account to bill.
workspaceDescriptionstringText describing the purpose of the workspace.
callerInformation__typestringType of the user. Valid values: type_owner, type_participant.
callerInformation__emailstringThe workspace user"s email address.
callerInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
callerInformation__userIdstringThe ID of the workspace user.
settings__commentsAllowedstringWhen **true,** commenting on the documents in the workspace is allowed.
callerInformation__createdstringThe UTC DateTime when the workspace user was created.
createdByInformation__typestringType of the user. Valid values: type_owner, type_participant.
callerInformation__userNamestringThe name of workspace user.
createdByInformation__emailstringThe workspace user"s email address.
callerInformation__accountIdstringThe account ID associated with the workspace user.
createdByInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
createdByInformation__userIdstringThe ID of the workspace user.
createdByInformation__createdstringThe UTC DateTime when the workspace user was created.
callerInformation__accountNamestringThe name of the account that the workspace user belongs to.
callerInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
callerInformation__createdByIdstringThe ID of the user who created this workspace user.
callerInformation__workspaceIdstringThe ID of the workspace.
createdByInformation__userNamestringThe name of workspace user.
callerInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
createdByInformation__accountIdstringThe account ID associated with the workspace user.
lastModifiedByInformation__typestringType of the user. Valid values: type_owner, type_participant.
lastModifiedByInformation__emailstringThe workspace user"s email address.
createdByInformation__accountNamestringThe name of the account that the workspace user belongs to.
createdByInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
createdByInformation__createdByIdstringThe ID of the user who created this workspace user.
createdByInformation__workspaceIdstringThe ID of the workspace.
lastModifiedByInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
lastModifiedByInformation__userIdstringThe ID of the workspace user.
callerInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
lastModifiedByInformation__createdstringThe UTC DateTime when the workspace user was created.
callerInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
callerInformation__workspaceUserUristringThe URI for accessing the workspace user.
lastModifiedByInformation__userNamestringThe name of workspace user.
lastModifiedByInformation__accountIdstringThe account ID associated with the workspace user.
createdByInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
createdByInformation__workspaceUserUristringThe URI for accessing the workspace user.
lastModifiedByInformation__accountNamestringThe name of the account that the workspace user belongs to.
lastModifiedByInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
lastModifiedByInformation__createdByIdstringThe ID of the user who created this workspace user.
lastModifiedByInformation__workspaceIdstringThe ID of the workspace.
callerInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
callerInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
callerInformation__errorDetails__messagestringA brief message describing the error condition.
callerInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
callerInformation__errorDetails__errorCodestringThe code associated with the error condition.
createdByInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
createdByInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__errorDetails__messagestringA brief message describing the error condition.
lastModifiedByInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
lastModifiedByInformation__workspaceUserUristringThe URI for accessing the workspace user.
createdByInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
createdByInformation__errorDetails__errorCodestringThe code associated with the error condition.
lastModifiedByInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
lastModifiedByInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__errorDetails__messagestringA brief message describing the error condition.
lastModifiedByInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
lastModifiedByInformation__errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatebccemailarchiveconfigurationDOCUSIGN_CREATE_BCC_EMAIL_ARCHIVE_CONFIGURATIONAcciónCreates a bcc email archive configuration for a docusign account, enabling automatic archiving of docusign-generated emails. this endpoint allows you to set up a bcc email address that will receive copies of all docusign notifications for the specified account. it's particularly useful for organizations that need to maintain comprehensive email records for compliance or auditing purposes. the method supports adding one bcc email address at a time, with a limit of up to five active and pending email archive addresses per account.
DOCUSIGN_CREATE_BCC_EMAIL_ARCHIVE_CONFIGURATIONAcciónCreates a bcc email archive configuration for a docusign account, enabling automatic archiving of docusign-generated emails. this endpoint allows you to set up a bcc email address that will receive copies of all docusign notifications for the specified account. it's particularly useful for organizations that need to maintain comprehensive email records for compliance or auditing purposes. the method supports adding one bcc email address at a time, with a limit of up to five active and pending email archive addresses per account.
Parámetros de entrada
uristringThe helper URI for retrieving the BCC email archive.
emailstringThe BCC email address to use for archiving Docusign messages. Example: customer_bcc@example.com
statusstringThe status of the BCC email address. Possible values are: - `activation_sent`: An activation link has been sent to the BCC email address. - `active`: The BCC email address is actively used for archiving. - `closed`: The BCC email address is no longer used for archiving.
createdstringThe UTC DateTime when the BCC email archive configuration was created.
modifiedstringThe UTC DateTime when the BCC email archive configuration was last modified.
accountIdstringThe ID of the account that owns the BCC email archive configuration.
createdBy__uristringA URI containing the user ID.
modifiedBy__uristringA URI containing the user ID.
createdBy__emailstringThe user"s email address.
bccEmailArchiveIdstringThe ID of the BCC email archive configuration.
createdBy__userIdstringThe ID of the user to access.
modifiedBy__emailstringThe user"s email address.
modifiedBy__userIdstringThe ID of the user to access.
createdBy__userNamestringThe name of the user.
createdBy__userTypestringThe type of user, for example `CompanyUser`.
emailNotificationIdstringThe GUID of the activation email message sent to the BCC email address.
createdBy__accountIdstringThe account ID associated with the envelope.
createdBy__ipAddressstringmodifiedBy__userNamestringThe name of the user.
modifiedBy__userTypestringThe type of user, for example `CompanyUser`.
createdBy__userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
modifiedBy__accountIdstringThe account ID associated with the envelope.
modifiedBy__ipAddressstringcreatedBy__accountNamestringThe name on the account.
createdBy__loginStatusstringWhen **true,** indicates that the user is logged in. This is a read-only property.
modifiedBy__userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
createdBy__membershipIdstringThe user"s membership ID.
modifiedBy__accountNamestringThe name on the account.
modifiedBy__loginStatusstringWhen **true,** indicates that the user is logged in. This is a read-only property.
modifiedBy__membershipIdstringThe user"s membership ID.
createdBy__sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
createdBy__activationAccessCodestringAccess code provided to the user to activate the account.
modifiedBy__sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
createdBy__errorDetails__messagestringA brief message describing the error condition.
modifiedBy__activationAccessCodestringAccess code provided to the user to activate the account.
modifiedBy__errorDetails__messagestringA brief message describing the error condition.
createdBy__errorDetails__errorCodestringThe code associated with the error condition.
modifiedBy__errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create brand profiles for accountDOCUSIGN_CREATE_BRAND_PROFILES_FOR_ACCOUNTAcciónThis endpoint creates brand profile files for a docusign account, customizing visual and textual elements. it allows setting company name, languages, colors, and landing pages. use it for new branding or major changes. requires 'canselfbrandsign' or 'canselfbrandsend' enabled. logos must be added separately. supports multiple brands and locales.
DOCUSIGN_CREATE_BRAND_PROFILES_FOR_ACCOUNTAcciónThis endpoint creates brand profile files for a docusign account, customizing visual and textual elements. it allows setting company name, languages, colors, and landing pages. use it for new branding or major changes. requires 'canselfbrandsign' or 'canselfbrandsend' enabled. logos must be added separately. supports multiple brands and locales.
Parámetros de entrada
linksobject[]An array of `brandLink` objects that contain information about the links that the brand uses.
colorsobject[]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
brandIdstringThe ID used to identify a specific brand in API calls.
accountIdstringThe 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 the brand profiles will be created. It should be a valid string representing either an integer account number or a GUID (Globally Unique Identifier).
brandNamestringThe name of the brand.
brandCompanystringThe name of the company associated with the brand.
emailContentobject[]Deprecated.
landingPagesobject[]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.
logos__emailstringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
brandLanguagesstring[]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`)
logos__primarystringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
isSendingDefaultbooleanWhen **true,** the sending brand is the default brand for sending new envelopes.
isSigningDefaultbooleanWhen **true,** the siging brand is the default brand for the signing experience.
logos__secondarystringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
resources__emailstringThe URI for the email resource file that the brand uses.
resources__sendingstringThe URI for the sending resource file that the brand uses.
resources__signingstringThe URI for the signing resource file that the brand uses.
isOrganizationBrandstringdefaultBrandLanguagestringThe 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`)
errorDetails__messagestringA brief message describing the error condition.
organizationBrandLogostringerrorDetails__errorCodestringThe code associated with the error condition.
isOverridingCompanyNamebooleanWhen **true,** the `brandCompany` property is overriding the name of the company in the account settings.
resources__signingCaptivestringThe URI for the captive (embedded) signing resource file that the brand uses.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create bulk send requestDOCUSIGN_CREATE_BULK_SEND_REQUESTAcciónThis endpoint initiates a bulk send process for docusign, allowing users to send a single envelope or template to multiple recipients efficiently. it uses an existing bulk send list and a specified envelope or template to create a batch of envelopes for distribution. the endpoint is ideal for scenarios requiring large-scale document distribution, such as sending contracts to numerous clients or distributing company-wide notices. it's recommended to test the compatibility of the bulk send list with the envelope using the createbulksendtestrequest method before actual sending. upon successful queuing, a batchid is provided for tracking the status of the bulk send operation. note that this process is asynchronous, and the entire batch is queued for processing rather than individual envelopes.
DOCUSIGN_CREATE_BULK_SEND_REQUESTAcciónThis endpoint initiates a bulk send process for docusign, allowing users to send a single envelope or template to multiple recipients efficiently. it uses an existing bulk send list and a specified envelope or template to create a batch of envelopes for distribution. the endpoint is ideal for scenarios requiring large-scale document distribution, such as sending contracts to numerous clients or distributing company-wide notices. it's recommended to test the compatibility of the bulk send list with the envelope using the createbulksendtestrequest method before actual sending. upon successful queuing, a batchid is provided for tracking the status of the bulk send operation. note that this process is asynchronous, and the entire batch is queued for processing rather than individual envelopes.
Parámetros de entrada
accountIdstringThe 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.
batchNamestringThe human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object.
bulkSendListIdstringObligatorioThe GUID of the bulk send list to be used for this bulk send operation. This required path parameter is created after posting a new bulk send list. It must be a valid, existing bulk send list ID associated with the specified account.
envelopeOrTemplateIdstringThe GUID of the envelope or template that you want to send in bulk.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create bulk send test requestDOCUSIGN_CREATE_BULK_SEND_TEST_REQUESTAcciónThis 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.
DOCUSIGN_CREATE_BULK_SEND_TEST_REQUESTAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
batchNamestringThe human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object.
bulkSendListIdstringObligatorioThe 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.
envelopeOrTemplateIdstringThe GUID of the envelope or template that you want to send in bulk.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create connect configuration for accountDOCUSIGN_CREATE_CONNECT_CONFIGURATION_FOR_ACCOUNTAcciónThis 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.
DOCUSIGN_CREATE_CONNECT_CONFIGURATION_FOR_ACCOUNTAcciónThis 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.
Parámetros de entrada
namestringThe name of the Connect configuration. This property is required.
eventsstring[]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](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property. The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) 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`
userIdsstring[]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.
allUsersstringWhen **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.
groupIdsstring[]passwordstringThe password for the Connect configuration. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.
userNamestringThe name of the user.
accountIdstringThe 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.
connectIdstringThe Docusign-generated ID for the Connect configuration. This property is read-only.
enableLogstringWhen **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.
sfObjectsobject[]An array of Salesforce objects.
disabledBystringincludeHMACstringdeliveryModestringThe delivery mode of the configuration. Valid values: * `SIM` * `Aggregate`
includeOAuthstringsoapNamespacestringThe namespace of the SOAP interface. **Note:** If `useSoapInterface` is set to **true,** you must set this value.
allUsersExceptstringThis 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.**
envelopeEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `Delivered` * `Completed` * `Declined` * `Voided` **Note:** These values are case-sensitive.
senderOverridestringurlToPublishTostringThe web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
recipientEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `AutoResponded` * `Delivered` * `Completed` * `Declined` * `AuthenticationFailed` **Note:** These values are case-sensitive.
externalFolderIdstringThe ID of an external folder.
includeDocumentsstringReserved for Docusign.
requireMutualTlsstringWhen **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled.
useSoapInterfacestringWhen **true,** the notifications are sent to your endpoint as SOAP requests.
configurationTypestringThe type of the configuration. Valid values: * `custom`: Creates an account-level configuration * `customrecipient`: Creates a Recipient Connect configuration * `salesforce` * `eOriginal` This property is required.
eventData__formatstringReserved for Docusign.
integratorManagedstringeventData__versionstringSet 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.
salesforceAuthcodestringexternalFolderLabelstringThe label for an external folder.
allowEnvelopePublishstringSet this value to **true** to enable the webhook. The default property is **false.**
salesforceApiVersionstringThe version of the Salesforce API that you are using.
includeCertSoapHeaderstringincludeDocumentFieldsstringWhen **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.
salesforceCallBackUrlstringsenderSelectableItemsstring[]This property sets the items that are available for selection when adding or editing Connect objects.
allowSalesforcePublishstringWhen **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.**
eventData__includeDatastring[]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](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope. - `recipients`: Include the recipients associated with the envelope. - `tabs`: Include the tabs associated with the envelope.
requiresAcknowledgementstringWhen **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.
includeEnvelopeVoidReasonstringWhen **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
includeTimeZoneInformationstringWhen **true,** Connect will include the envelope time zone information.
includeCertificateOfCompletionstringWhen **true,** the Connect Service includes the Certificate of Completion with completed envelopes.
signMessageWithX509CertificatestringWhen **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.
includeSenderAccountasCustomFieldstringWhen **true,** Connect will include the sender account as Custom Field in the data.
salesforceDocumentsAsContentFilesstringWhen **true,** Docusign can use documents in your Salesforce account for sending and signing.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create custom document fields in envelopeDOCUSIGN_CREATE_CUSTOM_DOCUMENT_FIELDS_IN_ENVELOPEAcciónCreates 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.
DOCUSIGN_CREATE_CUSTOM_DOCUMENT_FIELDS_IN_ENVELOPEAcciónCreates 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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".
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create custom fields for envelopeDOCUSIGN_CREATE_CUSTOM_FIELDS_FOR_ENVELOPEAcciónThis 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.
DOCUSIGN_CREATE_CUSTOM_FIELDS_FOR_ENVELOPEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create custom fields in template documentDOCUSIGN_CREATE_CUSTOM_FIELDS_IN_TEMPLATE_DOCUMENTAcciónCreates 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.
DOCUSIGN_CREATE_CUSTOM_FIELDS_IN_TEMPLATE_DOCUMENTAcciónCreates 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe unique identifier for the document within the envelope. 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.
templateIdstringObligatorioThe 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.
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatecustomtabwithpropertiesDOCUSIGN_CREATE_CUSTOM_TAB_WITH_PROPERTIESAcciónCreates 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.
DOCUSIGN_CREATE_CUSTOM_TAB_WITH_PROPERTIESAcciónCreates 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.
Parámetros de entrada
boldstringWhen **true,** the information in the tab is bold.
fontstringThe 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
namestringtypestringThe 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`
itemsstring[]If the tab is a list, this represents the values that are possible for the tab.
widthstringThe width of the tab in pixels. Must be an integer.
anchorstringAn optional string that is used to auto-match tabs to strings located in the documents of an envelope.
heightstringThe height of the tab in pixels. Must be an integer.
italicstringWhen **true,** the information in the tab is italic.
lockedstringWhen **true,** the signer cannot change the data of the custom tab.
sharedstringWhen **true,** this custom tab is shared.
editablestringWhen **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.
fontSizestringThe 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
requiredstringWhen **true,** the signer is required to fill out this tab.
selectedstringWhen **true,** the radio button is selected.
tabLabelstringThe 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.
accountIdstringThe 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.
fontColorstringThe font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
stampTypestringThe type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null
underlinestringWhen **true,** the information in the tab is underlined.
requireAllstringWhen **true** and shared is true, information must be entered in this field to complete the envelope.
scaleValuestringSets 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.
anchorUnitsstringSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
customTabIdstringThe 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.
initialValuestringThe original value of the tab.
lastModifiedstringThe UTC DateTime this object was last modified. This is in ISO 8601 format.
anchorXOffsetstringSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetstringSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
collaborativestringmaximumLengthstringThe maximum number of entry characters supported by the custom tab.
numericalValuestringvalidationTypestringSpecifies how numerical data is validated. Valid values: - `number` - `currency`
createdByUserIdstringThe userId of the Docusign user who created this object.
disableAutoSizestringWhen **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.
includedInEmailstringWhen **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
mergeField__rowstringSpecifies the row number in a Salesforce table that the merge field value corresponds to.
paymentItemCodestringIf 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.
paymentItemNamestringIf 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`
mergeField__pathstringSets the object associated with the custom tab. Currently this is the Salesforce Object.
maxNumericalValuestringminNumericalValuestringvalidationMessagestringThe message displayed if the custom tab fails input validation (either custom of embedded).
validationPatternstringA regular expression used to validate input for the tab.
anchorCaseSensitivestringThis 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/
signatureProviderIdstringReserved for Docusign.
anchorMatchWholeWordstringWhen **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/
createdByDisplayNamestringThe user name of the Docusign user who created this object.
lastModifiedByUserIdstringThe userId of the Docusign user who last modified this object.
mergeField__writeBackstringWhen **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
concealValueOnDocumentstringWhen **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.
localePolicy__timeZonestringSpecifies 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`
paymentItemDescriptionstringIf 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.
anchorIgnoreIfNotPresentstringWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
mergeField__pathExtendedobject[]Reserved for Docusign.
anchorHorizontalAlignmentstringThis 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/
lastModifiedByDisplayNamestringThe User Name of the Docusign user who last modified this object.
localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
stampTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/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`
stampTypeMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
requireInitialOnSharedChangestringOptional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
mergeField__allowSenderToEditstringWhen **true,** the sender can modify the value of the `mergeField` tab during the sending process.
mergeField__configurationTypestringIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
localePolicy__customDateFormatstringlocalePolicy__customTimeFormatstringmergeField__rowMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__pathMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__rowMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__pathMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__useLongCurrencyFormatstringWhen **true,** use the long currency format for the locale.
localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
mergeField__writeBackMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__writeBackMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__pathExtendedMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__pathExtendedMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__allowSenderToEditMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__configurationTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__allowSenderToEditMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__configurationTypeMetadata__optionsstring[]An array of option strings supported by this setting.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatedocumentresponsivehtmlpreviewDOCUSIGN_CREATE_DOCUMENT_RESPONSIVE_HTML_PREVIEWAcciónCreates a preview of the responsive html version of a specific document within a docusign envelope. this endpoint allows users to visualize how a pdf document will appear as responsive html across various device types before sending it for signature. it's particularly useful for ensuring optimal document presentation and user experience across different screen sizes and devices. the preview can help identify any formatting issues or display problems that may occur during the conversion process, allowing for adjustments before the document is finalized and sent to recipients.
DOCUSIGN_CREATE_DOCUMENT_RESPONSIVE_HTML_PREVIEWAcciónCreates a preview of the responsive html version of a specific document within a docusign envelope. this endpoint allows users to visualize how a pdf document will appear as responsive html across various device types before sending it for signature. it's particularly useful for ensuring optimal document presentation and user experience across different screen sizes and devices. the preview can help identify any formatting issues or display problems that may occur during the conversion process, allowing for adjustments before the document is finalized and sent to recipients.
Parámetros de entrada
sourcestringSpecifies 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](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
accountIdstringThe 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.
documentIdstringObligatorioSpecifies the document ID number that the tab is placed on. This must refer to an existing Document"s ID attribute.
envelopeIdstringObligatorioThe 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.
headerLabelstringHeader text or an HTML tag to place above the responsive HTML block.
displayOrderstringThe position on the page where the display section appears.
documentGuidstringThe GUID of the document.
displayAnchorsobject[]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](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
maxScreenWidthstringIf 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.
removeEmptyTagsstringHolds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
displayPageNumberstringThe number of the page on which the display section appears.
displayAnchorPrefixstringContains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
showMobileOptimizedTogglestringWhen **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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Envelope From TemplateDOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATEAcciónCreates and sends an envelope using a template. allows multiple recipients with different roles and routing orders.
DOCUSIGN_CREATE_ENVELOPE_FROM_TEMPLATEAcciónCreates and sends an envelope using a template. allows multiple recipients with different roles and routing orders.
Parámetros de entrada
statusstringenumThe desired status of the envelope: 'sent' or 'created'
createdsentaccount_idstringObligatorioThe DocuSign account ID
template_idstringObligatorioID of the template to use. Example: '1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'
email_subjectstringObligatorioSubject line for the email
template_rolesobject[]ObligatorioList of recipients and their roles
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreategroupsforaccountDOCUSIGN_CREATE_GROUPS_FOR_ACCOUNTAcciónCreates 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.
DOCUSIGN_CREATE_GROUPS_FOR_ACCOUNTAcciónCreates 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.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
nextUristringThe 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.
accountIdstringThe 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.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreateidproofresourcetokenforrecipientDOCUSIGN_CREATE_IDPROOF_RESOURCE_TOKEN_FOR_RECIPIENTAcciónCreates a resource token that allows a sender to retrieve identification data for a specific recipient using docusign's id evidence api. this endpoint is part of the envelope recipient management process and is specifically designed for identity verification purposes. it should be used when a sender needs to access and verify a recipient's identification information securely. the generated token provides a controlled and time-limited access to the recipient's id data, enhancing security in the document signing process. this api is currently in beta, which means it may undergo changes and its usage might be subject to limitations or additional scrutiny. the endpoint does not directly provide the identification data but instead returns the necessary credentials (resource token and base uri) to access it through the id evidence api.
DOCUSIGN_CREATE_IDPROOF_RESOURCE_TOKEN_FOR_RECIPIENTAcciónCreates a resource token that allows a sender to retrieve identification data for a specific recipient using docusign's id evidence api. this endpoint is part of the envelope recipient management process and is specifically designed for identity verification purposes. it should be used when a sender needs to access and verify a recipient's identification information securely. the generated token provides a controlled and time-limited access to the recipient's id data, enhancing security in the document signing process. this api is currently in beta, which means it may undergo changes and its usage might be subject to limitations or additional scrutiny. the endpoint does not directly provide the identification data but instead returns the necessary credentials (resource token and base uri) to access it through the id evidence api.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This is a required parameter and must be provided to specify which account the envelope and recipient belong to. The accountId is typically a string of alphanumeric characters.
envelopeIdstringObligatorioThe globally unique identifier (GUID) for the envelope containing the recipient whose identification data needs to be accessed. This is a required parameter. It should be provided in the format of a UUID, for example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". The envelopeId is crucial for identifying the specific document or set of documents associated with the recipient.
recipientIdstringObligatorioThe unique identifier for the recipient within the specified envelope. This is a required parameter, referred to as "recipientIdGuid" in the API. It is used to pinpoint the exact recipient whose identification data will be accessed using the generated resource token.
token_scopesstringAn optional parameter that specifies the scopes or permissions for the generated resource token. While the schema doesn"t provide detailed information about possible values, this parameter likely controls what types of identification data can be accessed with the token. If not provided, default scopes may be applied.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatenewaccountpermissionprofileDOCUSIGN_CREATE_NEW_ACCOUNT_PERMISSION_PROFILEAcciónThis endpoint creates a new permission profile for a docusign account, defining specific sets of permissions for user groups. it allows administrators to establish role-based access control within their docusign environment. the profile controls a wide range of user capabilities, from basic envelope sending to advanced account management functions. use this endpoint when setting up new roles or modifying existing permission structures. note that creating a profile doesn't automatically assign users to it; separate actions are required for user assignment.
DOCUSIGN_CREATE_NEW_ACCOUNT_PERMISSION_PROFILEAcciónThis endpoint creates a new permission profile for a docusign account, defining specific sets of permissions for user groups. it allows administrators to establish role-based access control within their docusign environment. the profile controls a wide range of user capabilities, from basic envelope sending to advanced account management functions. use this endpoint when setting up new roles or modifying existing permission structures. note that creating a profile doesn't automatically assign users to it; separate actions are required for user assignment.
Parámetros de entrada
usersobject[]A list of user objects containing information about the users who are associated with the account permission profile.
includestringA 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.
accountIdstringThe 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.
userCountstringThe total number of users in the group associated with the account permission profile.
modifiedDateTimestringThe date and time when the permission profile was last modified.
modifiedByUsernamestringThe username of the user who last modified the permission profile.
settings__webFormsstringpermissionProfileIdstringThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
permissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
settings__vaultingModestringReserved for Docusign.
settings__allowVaultingstringReserved for Docusign.
settings__powerFormRolestringThe PowerForms rights associated with the account permission profile. Valid values are: - `none` - `user` - `admin`
settings__allowApiAccessstringWhen **true,** users can manage documents by using the API.
settings__allowAutoTaggingstringWhen **true,** auto-tagging is enabled for the account.
settings__allowBulkSendingstringWhen **true,** bulk sending is enabled for users.
settings__allowTransactionsstringsettings__canCreateWorkspacesstringReserved for Docusign.
settings__disableOtherActionsstringWhen **true,** users can access the **Other Actions** menu.
settings__allowESealRecipientsstringWhen **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients.
settings__allowEnvelopeSendingstringWhen **true,** users can send envelopes.
settings__canCreateTransactionstringsettings__canDeleteTransactionstringsettings__allowedTemplateAccessstringSpecifies the level of access that users have to account templates. Valid values are: - `none` - `use` - `create` - `share`
settings__disableDocumentUploadstringWhen **true,** users cannot upload documents.
settings__allowAccountManagementstringWhen **true,** users have full administrative access to the account.
settings__allowSignerAttachmentsstringWhen **true,** users can add requests for attachments from signers.
settings__canSendEnvelopesViaSMSstringsettings__useNewSendingInterfacestringReserved for Docusign.
settings__allowApiAccessToAccountstringWhen **true,** users can access the account by using the eSignature API.
settings__allowWetSigningOverridestringWhen **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.
settings__allowedClickwrapsAccessstringsettings__enableApiRequestLoggingstringWhen **true,** API request logging is enabled. **Note:** Logging limits apply.
settings__allowedAddressBookAccessstringSpecifies the level of access that users have to the account"s address book. Valid values are: - `personal` - `useShared` - `usePersonalAndShared` - `personalAndShared`
settings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__webFormsMetadata__uiHintstringReserved for Docusign.
settings__webFormsMetadata__uiTypestringReserved for Docusign.
settings__allowApiSequentialSigningstringWhen **true,** users may specify sequential signing recipients when they send documents by using the API.
settings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__webFormsMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientstringWhen **true,** the Docusign Desktop Client is enabled for users.
settings__allowSupplementalDocumentsstringWhen **true,** senders can include supplemental documents.
settings__allowedOrchestrationAccessstringsettings__allowTaggingInSendAndCorrectstringWhen **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents.
settings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__vaultingModeMetadata__uiHintstringReserved for Docusign.
settings__vaultingModeMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowVaultingMetadata__uiHintstringReserved for Docusign.
settings__allowVaultingMetadata__uiTypestringReserved for Docusign.
settings__powerFormRoleMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__powerFormRoleMetadata__uiHintstringReserved for Docusign.
settings__powerFormRoleMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustReadstringWhen **true,** senders can require recipients to read supplemental documents.
settings__supplementalDocumentsMustViewstringWhen **true,** users can require recipients to view supplemental documents.
settings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
settings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiAccessMetadata__uiHintstringReserved for Docusign.
settings__allowApiAccessMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowVaultingMetadata__uiOrderstringReserved for Docusign.
settings__powerFormRoleMetadata__optionsstring[]An array of option strings supported by this setting.
settings__powerFormRoleMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiAccessMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersstringWhen **true,** users can send envelopes on behalf of others.
settings__canDeleteDocumentsInTransactionstringsettings__supplementalDocumentsMustAcceptstringWhen **true,** senders can require recipients to accept supplemental documents.
settings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowAutoTaggingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowAutoTaggingMetadata__uiHintstringReserved for Docusign.
settings__allowAutoTaggingMetadata__uiTypestringReserved for Docusign.
settings__allowBulkSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowBulkSendingMetadata__uiHintstringReserved for Docusign.
settings__allowBulkSendingMetadata__uiTypestringReserved for Docusign.
settings__enableSequentialSigningInterfacestringWhen **true,** the sequential signing user interface is enabled.
settings__signingUiVersionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__signingUiVersionMetadata__uiHintstringReserved for Docusign.
settings__signingUiVersionMetadata__uiTypestringReserved for Docusign.
settings__allowAutoTaggingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowAutoTaggingMetadata__uiOrderstringReserved for Docusign.
settings__allowBulkSendingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowBulkSendingMetadata__uiOrderstringReserved for Docusign.
settings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
settings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
settings__enableTransactionPointIntegrationstringReserved for Docusign.
settings__signingUiVersionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__signingUiVersionMetadata__uiOrderstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfacestringReserved for Docusign.
settings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
settings__canCreateWorkspacesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canCreateWorkspacesMetadata__uiHintstringReserved for Docusign.
settings__canCreateWorkspacesMetadata__uiTypestringReserved for Docusign.
settings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
settings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
settings__enableRecipientViewingNotificationsstringWhen **true,** senders are notified when recipients view the documents that they send.
settings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowESealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowESealRecipientsMetadata__uiHintstringReserved for Docusign.
settings__allowESealRecipientsMetadata__uiTypestringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowEnvelopeSendingMetadata__uiHintstringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientstringWhen **true,** users can be recipients of envelopes transferred to them by administrators of other accounts.
settings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
settings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
settings__canCreateWorkspacesMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canCreateWorkspacesMetadata__uiOrderstringReserved for Docusign.
settings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
settings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
settings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
settings__powerFormRoleMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowApiAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowESealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowESealRecipientsMetadata__uiOrderstringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowEnvelopeSendingMetadata__uiOrderstringReserved for Docusign.
settings__allowedTemplateAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedTemplateAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedTemplateAccessMetadata__uiTypestringReserved for Docusign.
settings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
settings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
settings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
settings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
settings__allowAccountManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowAccountManagementMetadata__uiHintstringReserved for Docusign.
settings__allowAccountManagementMetadata__uiTypestringReserved for Docusign.
settings__allowSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
settings__allowSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
settings__allowedTemplateAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedTemplateAccessMetadata__uiOrderstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
settings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
settings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__useNewSendingInterfaceMetadata__uiHintstringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__uiTypestringReserved for Docusign.
settings__allowAccountManagementMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowAccountManagementMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiAccessToAccountMetadata__uiHintstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__uiTypestringReserved for Docusign.
settings__allowAutoTaggingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowBulkSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguagestringWhen **true,** senders can set the language of the email that is sent to recipients.
settings__allowSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
settings__allowWetSigningOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowWetSigningOverrideMetadata__uiHintstringReserved for Docusign.
settings__allowWetSigningOverrideMetadata__uiTypestringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedClickwrapsAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__uiTypestringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableApiRequestLoggingMetadata__uiHintstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__uiTypestringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypestringsettings__signingUiVersionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__useNewSendingInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__useNewSendingInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiAccessToAccountMetadata__uiOrderstringReserved for Docusign.
settings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowWetSigningOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowWetSigningOverrideMetadata__uiOrderstringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedAddressBookAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__uiTypestringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedClickwrapsAccessMetadata__uiOrderstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableApiRequestLoggingMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiSequentialSigningMetadata__uiHintstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__uiTypestringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedAddressBookAccessMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiSequentialSigningMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowDocuSignDesktopClientMetadata__uiHintstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__uiTypestringReserved for Docusign.
settings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
settings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
settings__canCreateWorkspacesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowDocuSignDesktopClientMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowDocuSignDesktopClientMetadata__uiOrderstringReserved for Docusign.
settings__allowESealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowEnvelopeSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
settings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowTaggingInSendAndCorrectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowTaggingInSendAndCorrectMetadata__uiHintstringReserved for Docusign.
settings__allowTaggingInSendAndCorrectMetadata__uiTypestringReserved for Docusign.
settings__allowedTemplateAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowAccountManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowTaggingInSendAndCorrectMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowTaggingInSendAndCorrectMetadata__uiOrderstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowApiAccessToAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowWetSigningOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedClickwrapsAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableApiRequestLoggingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiSendingOnBehalfOfOthersMetadata__uiHintstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__uiTypestringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
settings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksstringWhen **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.
settings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiSendingOnBehalfOfOthersMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableSequentialSigningInterfaceMetadata__uiHintstringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesstringWhen **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account.
settings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableSequentialSigningInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableSequentialSigningInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableTransactionPointIntegrationMetadata__uiHintstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__uiTypestringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__useNewDocuSignExperienceInterfaceMetadata__uiHintstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__uiTypestringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableTransactionPointIntegrationMetadata__uiOrderstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__useNewDocuSignExperienceInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__allowTaggingInSendAndCorrectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableRecipientViewingNotificationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableRecipientViewingNotificationsMetadata__uiHintstringReserved for Docusign.
settings__enableRecipientViewingNotificationsMetadata__uiTypestringReserved for Docusign.
settings__allowedToBeEnvelopeTransferRecipientMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiHintstringReserved for Docusign.
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiTypestringReserved for Docusign.
settings__enableRecipientViewingNotificationsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableRecipientViewingNotificationsMetadata__uiOrderstringReserved for Docusign.
settings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiHintstringReserved for Docusign.
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiTypestringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiOrderstringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__useNewDocuSignExperienceInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableRecipientViewingNotificationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiHintstringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiTypestringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__optionsstring[]An array of option strings supported by this setting.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiOrderstringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiHintstringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiTypestringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiOrderstringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatenotaryjurisdictionobjectDOCUSIGN_CREATE_NOTARY_JURISDICTION_OBJECTAcciónCreates a new notary jurisdiction object in the docusign system. this endpoint is used to register or update information about a notary's commission, including their jurisdiction, seal type, and specific details required by different states. it supports multiple us jurisdictions and allows for detailed configuration of notary seals and commission information. the created object serves as a record of the notary's authority and defines how they can operate within the docusign platform for electronic notarization. this endpoint should be used when onboarding new notaries or updating existing notary information in the system. it's important to note that the jurisdiction object is read-only once created, so accurate information should be provided during the initial creation.
DOCUSIGN_CREATE_NOTARY_JURISDICTION_OBJECTAcciónCreates a new notary jurisdiction object in the docusign system. this endpoint is used to register or update information about a notary's commission, including their jurisdiction, seal type, and specific details required by different states. it supports multiple us jurisdictions and allows for detailed configuration of notary seals and commission information. the created object serves as a record of the notary's authority and defines how they can operate within the docusign platform for electronic notarization. this endpoint should be used when onboarding new notaries or updating existing notary information in the system. it's important to note that the jurisdiction object is read-only once created, so accurate information should be provided during the initial creation.
Parámetros de entrada
countystringThe county that the commission is valid in.
sealTypestringThe seal type used for this juridiction. - `not_available` - `system_created` - `user_uploaded`
commissionIdstringThe notary"s commission identification. This varies from jurisdiction to jurisdiction.
registeredNamestringThe registered name of the notary.
jurisdiction__namestringThe name of the jurisdiction. Typically the state name.
commissionExpirationstringThe expiration date of the notary"s commission in format: `MM/DD/YYYY`.
jurisdiction__countystringThe county of the jurisdiction.
errorDetails__messagestringA brief message describing the error condition.
jurisdiction__enabledstringWhen **true,** this jurisdiction is enabled.
errorDetails__errorCodestringThe code associated with the error condition.
jurisdiction__countyInSealstringWhen **true,** the county name appears in the seal.
jurisdiction__jurisdictionIdstringThe 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`
jurisdiction__stateNameInSealstringWhen **true,** the name of the state appears in the seal.
jurisdiction__commissionIdInSealstringWhen **true,** the notary"s `comissionId` appears in the seal.
jurisdiction__notaryPublicInSealstringWhen **true,** the name of the notary appears in the seal.
jurisdiction__allowUserUploadedSealstringWhen **true,** the seal can be uploaded by the user.
jurisdiction__allowSystemCreatedSealstringWhen **true,** the seal can be generated by the platform.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreateorupdateuserauthorizationsDOCUSIGN_CREATE_OR_UPDATE_USER_AUTHORIZATIONSAcciónCreates or updates multiple user authorizations in docusign, allowing an agent user to perform specific actions on behalf of a principal user. this endpoint enables bulk management of user permissions, including sending, managing, signing, or editing documents. it's particularly useful for setting up or modifying access rights across multiple users efficiently. the endpoint requires account administrator privileges or must be called by the principal user themselves. note that for signing permissions, the account must have the 'allowdelegationsigning' setting enabled, and each principal user can only share signing permission with one agent user.
DOCUSIGN_CREATE_OR_UPDATE_USER_AUTHORIZATIONSAcciónCreates or updates multiple user authorizations in docusign, allowing an agent user to perform specific actions on behalf of a principal user. this endpoint enables bulk management of user permissions, including sending, managing, signing, or editing documents. it's particularly useful for setting up or modifying access rights across multiple users efficiently. the endpoint requires account administrator privileges or must be called by the principal user themselves. note that for signing permissions, the account must have the 'allowdelegationsigning' setting enabled, and each principal user can only share signing permission with one agent user.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
authorizationsobject[]The list of user authorizations to create and/or update.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatepreviewofresponsivehtmlDOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTMLAcciónCreates 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.
DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTMLAcciónCreates 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.
Parámetros de entrada
sourcestringSpecifies 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](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
accountIdstringThe external account number (integer) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the template document preview is being created. It is required and must be provided in the path of the API request.
documentIdstringObligatorioSpecifies the document ID number that the tab is placed on. This must refer to an existing Document"s ID attribute.
templateIdstringObligatorioThe 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.
headerLabelstringHeader text or an HTML tag to place above the responsive HTML block.
displayOrderstringThe position on the page where the display section appears.
documentGuidstringThe GUID of the document.
displayAnchorsobject[]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](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
maxScreenWidthstringIf 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.
removeEmptyTagsstringHolds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
displayPageNumberstringThe number of the page on which the display section appears.
displayAnchorPrefixstringContains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
showMobileOptimizedTogglestringWhen **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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatepreviewofresponsivehtmlinenvelopeDOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTML_IN_ENVELOPEAcciónCreates 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.
DOCUSIGN_CREATE_PREVIEW_OF_RESPONSIVE_HTML_IN_ENVELOPEAcciónCreates 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.
Parámetros de entrada
sourcestringSpecifies 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](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
accountIdstringThe external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and used to identify the specific account for which the responsive HTML preview is being created. It should be a valid string representation of either the numeric account ID or the GUID format account identifier.
documentIdstringSpecifies the document ID number that the tab is placed on. This must refer to an existing Document"s ID attribute.
envelopeIdstringObligatorioThe 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.
headerLabelstringHeader text or an HTML tag to place above the responsive HTML block.
displayOrderstringThe position on the page where the display section appears.
documentGuidstringThe GUID of the document.
displayAnchorsobject[]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](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
maxScreenWidthstringIf 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.
removeEmptyTagsstringHolds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
displayPageNumberstringThe number of the page on which the display section appears.
displayAnchorPrefixstringContains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
showMobileOptimizedTogglestringWhen **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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreaterecipientmanualreviewlinkDOCUSIGN_CREATE_RECIPIENT_MANUAL_REVIEW_LINKAcciónCreates a url for manually reviewing a recipient's identity in docusign. this endpoint is used when automatic identity verification has failed and manual review is required. it returns a url that allows the sender to access a page for manually verifying the recipient's id. this method should only be used for recipients in workflows that support manual review and whose automatic verification has failed with a specific status code. the returned url is essential for completing the identity verification process in cases where automatic methods were insufficient.
DOCUSIGN_CREATE_RECIPIENT_MANUAL_REVIEW_LINKAcciónCreates a url for manually reviewing a recipient's identity in docusign. this endpoint is used when automatic identity verification has failed and manual review is required. it returns a url that allows the sender to access a page for manually verifying the recipient's id. this method should only be used for recipients in workflows that support manual review and whose automatic verification has failed with a specific status code. the returned url is essential for completing the identity verification process in cases where automatic methods were insufficient.
Parámetros de entrada
accountIdstringA unique identifier for your DocuSign account. This value is automatically generated by DocuSign when you create an account. It can be found in the "API Account ID" field on the Apps and Keys page of your DocuSign account. Required parameter.
envelopeIdstringObligatorioThe globally unique identifier (GUID) for the envelope containing the recipient that requires manual review. This GUID is assigned by DocuSign when the envelope is created. Format example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". Required parameter.
recipientIdstringObligatorioA globally unique identifier (GUID) assigned by DocuSign to identify the specific recipient within the envelope that requires manual review. This recipient must belong to a workflow that allows manual review of IDs, and their automatic verification status must be "Failed" with a "vendorFailureStatusCode" of "MANUAL_REVIEW_STARTED". Required parameter.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreaterecipientpreviewforenvelopeDOCUSIGN_CREATE_RECIPIENT_PREVIEW_FOR_ENVELOPEAcciónCreates 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.
DOCUSIGN_CREATE_RECIPIENT_PREVIEW_FOR_ENVELOPEAcciónCreates 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.
Parámetros de entrada
pingUrlstringThe 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.
accountIdstringThe 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.
returnUrlstringThe URL to which the user will be redirected 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. This property is required.
envelopeIdstringObligatorioThe 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".
assertionIdstringA unique identifier of the authentication event executed by the client application.
recipientIdstringUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
pingFrequencystringOnly 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.
xFrameOptionsstringSpecifies 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.
securityDomainstringThe domain in which the user authenticated.
authenticationMethodstringRequired. 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.
clientURLs__onCancelstringauthenticationInstantstringA sender-generated value that indicates the date and time that the signer was authenticated.
clientURLs__onDeclinestringclientURLs__onExceptionstringclientURLs__onFaxPendingstringclientURLs__onTTLExpiredstringxFrameOptionsAllowFromUrlstringWhen 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.
clientURLs__onIdCheckFailedstringclientURLs__onSessionTimeoutstringclientURLs__onSigningCompletestringclientURLs__onViewingCompletestringclientURLs__onAccessCodeFailedstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreaterecipientviewurlDOCUSIGN_CREATE_RECIPIENT_VIEW_URLAcciónCreates a url for embedding the docusign recipient view ui within an application, allowing users to sign documents directly in the app. this endpoint is specifically used for envelopes in the 'sent' status and generates a temporary url that expires after 5 minutes. it provides a seamless way to integrate electronic signature capabilities into your workflow, ensuring a secure and legally binding signing process. the method requires proper authentication of the recipient's identity and offers various customization options for the embedded experience.
DOCUSIGN_CREATE_RECIPIENT_VIEW_URLAcciónCreates a url for embedding the docusign recipient view ui within an application, allowing users to sign documents directly in the app. this endpoint is specifically used for envelopes in the 'sent' status and generates a temporary url that expires after 5 minutes. it provides a seamless way to integrate electronic signature capabilities into your workflow, ensuring a secure and legally binding signing process. the method requires proper authentication of the recipient's identity and offers various customization options for the embedded experience.
Parámetros de entrada
emailstring(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
userIdstringThe user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user.
pingUrlstringThe 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.
userNamestringThe username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
accountIdstringThe external account number (int) or account ID GUID. This is a required path parameter that identifies the DocuSign account associated with the envelope.
returnUrlstring(Required) 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.
envelopeIdstringObligatorioThe 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.
assertionIdstringA unique identifier of the authentication event executed by the client application.
recipientIdstringUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
clientUserIdstringA 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.
displayFormatstringpingFrequencystringOnly 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.
xFrameOptionsstringSpecifies 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.
frameAncestorsstring[]An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-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"]`
messageOriginsstring[]The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`.
securityDomainstringThe domain in which the user authenticated.
authenticationMethodstringRequired. 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.
clientURLs__onCancelstringauthenticationInstantstringA sender-generated value that indicates the date and time that the signer was authenticated.
clientURLs__onDeclinestringclientURLs__onExceptionstringclientURLs__onFaxPendingstringclientURLs__onTTLExpiredstringxFrameOptionsAllowFromUrlstringWhen 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.
clientURLs__onIdCheckFailedstringclientURLs__onSessionTimeoutstringclientURLs__onSigningCompletestringclientURLs__onViewingCompletestringclientURLs__onAccessCodeFailedstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create sender view url for envelopeDOCUSIGN_CREATE_SENDER_VIEW_URL_FOR_ENVELOPEAcciónCreates 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.
DOCUSIGN_CREATE_SENDER_VIEW_URL_FOR_ENVELOPEAcciónCreates 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.
Parámetros de entrada
accountIdstringThe 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.
returnUrlstringIdentifies 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).
envelopeIdstringObligatorioThe 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".
viewAccessstringSet 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.
settings__lockTokenstringIf your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
settings__showBackButtonstringDetermines 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.
settings__startingScreenstringDetermines the starting screen for the sender view. Valid values: * `Prepare` (default) * `Tagger`
settings__backButtonActionstringSets 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
settings__sendButtonActionstringSets 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`.
settings__showDiscardActionstringWhen **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
settings__showHeaderActionsstringDetermines 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`.
settings__showAdvancedOptionsstringReserved for Docusign.
settings__taggerSettings__paletteDefaultstringWhen `paletteSections` is set to `custom`, this property selects the tagger palette. Valid values: * `custom` (default) * `merge` * `notary` * `seals` * `smartContracts` * `annotations` * `smartSections`
settings__documentSettings__showEditPagesstringsettings__recipientSettings__showBulkSendstringReserved for Docusign.
settings__taggerSettings__paletteSectionsstringValid values: * `default` (default): The default tagger palette UX * `none`: No tagger palette * `custom`: Set by `paletteDefault`
settings__recipientSettings__showEditMessagestringReserved for Docusign.
settings__documentSettings__showEditDocumentsstringWhen **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**
settings__recipientSettings__showContactsListstringsettings__recipientSettings__showEditRecipientsstringsettings__documentSettings__showEditDocumentVisibilitystringsettings__taggerSettings__paletteSettings__merge__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__seals__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__custom__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__notary__showstringReserved for Docusign.
settings__templateSettings__showMatchingTemplatesPromptstringReserved for Docusign.
settings__documentSettings__showSaveAsDocumentCustomFieldstringReserved for Docusign.
settings__taggerSettings__paletteSettings__annotations__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartSections__showstringReserved for Docusign.
settings__envelopeCustomFieldSettings__showEnvelopeCustomFieldsstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartContracts__showstringReserved for Docusign.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create signing groupDOCUSIGN_CREATE_SIGNING_GROUPAcciónCreates 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.
DOCUSIGN_CREATE_SIGNING_GROUPAcciónCreates 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.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatetemplatedocumentcustomfieldsDOCUSIGN_CREATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSAcciónThis endpoint creates custom document fields in an existing docusign template. it allows users to add both list-type and text-type custom fields to enhance template functionality and capture additional data during the envelope creation and sending process. the endpoint is useful for customizing templates with specific metadata requirements or for integrating with external systems like salesforce. it should be used when templates need to be enhanced with custom data entry options or when preparing templates for specific workflows that require additional information.
DOCUSIGN_CREATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSAcciónThis endpoint creates custom document fields in an existing docusign template. it allows users to add both list-type and text-type custom fields to enhance template functionality and capture additional data during the envelope creation and sending process. the endpoint is useful for customizing templates with specific metadata requirements or for integrating with external systems like salesforce. it should be used when templates need to be enhanced with custom data entry options or when preparing templates for specific workflows that require additional information.
Parámetros de entrada
accountIdstringThe 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 template belongs to and where the custom fields will be created.
templateIdstringObligatorioThe 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.
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create template recipient preview urlDOCUSIGN_CREATE_TEMPLATE_RECIPIENT_PREVIEW_URLAcciónThis endpoint generates a url that allows senders to preview the experience of a specific recipient for a docusign template. it's useful for checking how the template will appear to the recipient before actually sending it. the preview url can be embedded in your application, enabling a seamless workflow for template creation and verification. this tool should be used when you need to validate the recipient's view of a template or when you want to provide a preview feature in your template management interface. note that this is specifically for templates and not for regular documents or envelopes.
DOCUSIGN_CREATE_TEMPLATE_RECIPIENT_PREVIEW_URLAcciónThis endpoint generates a url that allows senders to preview the experience of a specific recipient for a docusign template. it's useful for checking how the template will appear to the recipient before actually sending it. the preview url can be embedded in your application, enabling a seamless workflow for template creation and verification. this tool should be used when you need to validate the recipient's view of a template or when you want to provide a preview feature in your template management interface. note that this is specifically for templates and not for regular documents or envelopes.
Parámetros de entrada
pingUrlstringThe 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.
accountIdstringThe external account number (integer) or account ID GUID of the DocuSign account. This parameter is required and must be provided in the path. It uniquely identifies the account for which the template recipient preview is being created.
returnUrlstringThe URL to which the user will be redirected 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. This property is required.
templateIdstringObligatorioThe unique identifier of the template for which the recipient preview is being created. This parameter is required and must be provided in the path. It should be a valid template ID within the specified DocuSign account.
assertionIdstringA unique identifier of the authentication event executed by the client application.
recipientIdstringUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
pingFrequencystringOnly 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.
xFrameOptionsstringSpecifies 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.
securityDomainstringThe domain in which the user authenticated.
authenticationMethodstringRequired. 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.
clientURLs__onCancelstringauthenticationInstantstringA sender-generated value that indicates the date and time that the signer was authenticated.
clientURLs__onDeclinestringclientURLs__onExceptionstringclientURLs__onFaxPendingstringclientURLs__onTTLExpiredstringxFrameOptionsAllowFromUrlstringWhen 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.
clientURLs__onIdCheckFailedstringclientURLs__onSessionTimeoutstringclientURLs__onSigningCompletestringclientURLs__onViewingCompletestringclientURLs__onAccessCodeFailedstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreatetemplateresponsivehtmlpreviewDOCUSIGN_CREATE_TEMPLATE_RESPONSIVE_HTML_PREVIEWAcciónCreates 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.
DOCUSIGN_CREATE_TEMPLATE_RESPONSIVE_HTML_PREVIEWAcciónCreates 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.
Parámetros de entrada
sourcestringSpecifies 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](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
accountIdstringThe 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.
documentIdstringSpecifies the document ID number that the tab is placed on. This must refer to an existing Document"s ID attribute.
templateIdstringObligatorioThe 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.
headerLabelstringHeader text or an HTML tag to place above the responsive HTML block.
displayOrderstringThe position on the page where the display section appears.
documentGuidstringThe GUID of the document.
displayAnchorsobject[]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](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
maxScreenWidthstringIf 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.
removeEmptyTagsstringHolds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
displayPageNumberstringThe number of the page on which the display section appears.
displayAnchorPrefixstringContains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
showMobileOptimizedTogglestringWhen **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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create template workflow stepDOCUSIGN_CREATE_TEMPLATE_WORKFLOW_STEPAcciónThis endpoint adds a new workflow step to an existing docusign template. it allows users to define complex routing and conditional recipient rules within the template's workflow. the endpoint is used to create automated processes for document routing, including actions like pausing the workflow, implementing delayed sending, and setting up conditional recipient routing based on specific criteria. it's particularly useful for templates that require sophisticated, multi-stage approval or review processes. the created workflow step can control the timing and conditions under which documents are sent to different recipients, enhancing the flexibility and automation of the document signing process. however, users should be aware that the complexity of the workflow increases with each added step, and careful planning is required to ensure the desired document flow is achieved.
DOCUSIGN_CREATE_TEMPLATE_WORKFLOW_STEPAcciónThis endpoint adds a new workflow step to an existing docusign template. it allows users to define complex routing and conditional recipient rules within the template's workflow. the endpoint is used to create automated processes for document routing, including actions like pausing the workflow, implementing delayed sending, and setting up conditional recipient routing based on specific criteria. it's particularly useful for templates that require sophisticated, multi-stage approval or review processes. the created workflow step can control the timing and conditions under which documents are sent to different recipients, enhancing the flexibility and automation of the document signing process. however, users should be aware that the complexity of the workflow increases with each added step, and careful planning is required to ensure the desired document flow is achieved.
Parámetros de entrada
actionstringIndicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
itemIdstringThe unique ID of the item being triggered.
statusstringThe status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only.
accountIdstringThe 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 template workflow step should be created for.
templateIdstringObligatorioThe unique identifier of the template for which the workflow step is being created. This parameter is required and must be provided in the path of the API request. It determines which specific template within the account will have the new workflow step added to it.
completedDatestringThe timestamp of when the workflow step transitioned to `completed` status. This property is read-only.
triggerOnItemstringThe type of item that triggers this workflow step. Valid values: * `routing_order`
triggeredDatestringThe timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only.
workflowStepIdstringA unique identifier for this workflow step. This property is read-only.
delayedRouting__rulesobject[]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.
delayedRouting__statusstringStatus 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.
delayedRouting__resumeDatestringThe 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.
recipientRouting__rules__conditionalRecipientsobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreateurlfortemplateeditviewDOCUSIGN_CREATE_URLFOR_TEMPLATE_EDIT_VIEWAcciónCreates 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.
DOCUSIGN_CREATE_URLFOR_TEMPLATE_EDIT_VIEWAcciónCreates 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.
Parámetros de entrada
accountIdstringThe 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.
returnUrlstringIdentifies the return point after the user selects `Save And Close`. This property is required.
templateIdstringObligatorioThe 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.
viewAccessstringSet 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
CreateuserauthorizationforagentuserDOCUSIGN_CREATE_USER_AUTHORIZATION_FOR_AGENT_USERAcciónCreates 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.
DOCUSIGN_CREATE_USER_AUTHORIZATION_FOR_AGENT_USERAcciónCreates 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.
Parámetros de entrada
userIdstringObligatorioThe ID of the principal user who is granting authorization. This parameter is required and must be provided in the path of the API request. The principal user is the one sharing their permissions with the agent user.
endDatestringThe UTC DateTime to end the authorization. The default value is the max UTC value (`9999-12-31T23:59:59.0000000+00:00`).
accountIdstringThe 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.
startDatestringThe UTC DateTime to initiate the authorization. The default value is the current date and time.
permissionstringThe [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values: * `Send` * `Manage` * `Sign` * `Edit` This property is required.
agentUser__namestringThe name of the authorization user.
agentUser__emailstringThe email address of the authorization user.
agentUser__userIdstringThe ID of the authorization user.
agentUser__accountIdstringThe account ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete account brandDOCUSIGN_DELETE_ACCOUNT_BRANDAcciónThis endpoint deletes a specific brand from a docusign account. it should be used when you need to permanently remove a brand configuration from an account, such as when a brand is no longer needed or has been replaced. the operation requires that branding for either signing or sending (or both) is enabled for the account. this is indicated by the account settings 'canselfbrandsend' or 'canselfbrandsign' being set to true. the deletion is irreversible, so it should be used with caution. if successful, the brand will be completely removed from the account and can no longer be applied to documents or emails. this endpoint does not return the deleted brand details; it only confirms the successful deletion or returns an error if the operation fails.
DOCUSIGN_DELETE_ACCOUNT_BRANDAcciónThis endpoint deletes a specific brand from a docusign account. it should be used when you need to permanently remove a brand configuration from an account, such as when a brand is no longer needed or has been replaced. the operation requires that branding for either signing or sending (or both) is enabled for the account. this is indicated by the account settings 'canselfbrandsend' or 'canselfbrandsign' being set to true. the deletion is irreversible, so it should be used with caution. if successful, the brand will be completely removed from the account and can no longer be applied to documents or emails. this endpoint does not return the deleted brand details; it only confirms the successful deletion or returns an error if the operation fails.
Parámetros de entrada
brandIdstringObligatorioThe 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".
accountIdstringThe 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 brand belongs to and should be deleted from. Example: "12345" or "a1b2c3d4-5678-90ef-ghij-klmnopqrstuv".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete account custom fieldDOCUSIGN_DELETE_ACCOUNT_CUSTOM_FIELDAcciónDeletes 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.
DOCUSIGN_DELETE_ACCOUNT_CUSTOM_FIELDAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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 custom field should be deleted from. The value must be a valid DocuSign account identifier string.
customFieldIdstringObligatorioThe 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.
apply_to_templatesstringAn 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete account permission profileDOCUSIGN_DELETE_ACCOUNT_PERMISSION_PROFILEAcciónThis 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.
DOCUSIGN_DELETE_ACCOUNT_PERMISSION_PROFILEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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 permission profile should be deleted.
move_users_tostringAn optional query parameter that allows you to specify a new permission profile ID to which users associated with the profile being deleted should be reassigned. If not provided and the profile has associated users, the deletion will fail.
permissionProfileIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete account stampDOCUSIGN_DELETE_ACCOUNT_STAMPAcciónDeletes a specific account stamp (signature) from a docusign account. this endpoint should be used when you need to permanently remove a stamp from an account, such as when it's no longer needed or has been replaced. the operation is irreversible, so use it with caution. it's particularly useful for maintaining account hygiene by removing outdated or unused stamps. note that this endpoint only deletes the stamp; it does not affect any documents that may have already been signed using this stamp.
DOCUSIGN_DELETE_ACCOUNT_STAMPAcciónDeletes a specific account stamp (signature) from a docusign account. this endpoint should be used when you need to permanently remove a stamp from an account, such as when it's no longer needed or has been replaced. the operation is irreversible, so use it with caution. it's particularly useful for maintaining account hygiene by removing outdated or unused stamps. note that this endpoint only deletes the stamp; it does not affect any documents that may have already been signed using this stamp.
Parámetros de entrada
accountIdstringThe 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 belongs to. The value must be a valid account identifier within your DocuSign organization.
signatureIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete bcc email archive configurationDOCUSIGN_DELETE_BCC_EMAIL_ARCHIVE_CONFIGURATIONAcciónThis 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.
DOCUSIGN_DELETE_BCC_EMAIL_ARCHIVE_CONFIGURATIONAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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".
bccEmailArchiveIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletebrandfromgroupDOCUSIGN_DELETE_BRAND_FROM_GROUPAcciónThis 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.
DOCUSIGN_DELETE_BRAND_FROM_GROUPAcciónThis 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.
Parámetros de entrada
brandsobject[]A list of brands.
groupIdstringObligatorioThe 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.
accountIdstringThe external account number (int) or account ID GUID. This parameter identifies the specific DocuSign account from which the brands will be deleted. It must be a valid account identifier, either in the form of an integer or a GUID string. This parameter is required and must be provided in the path of the API request.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletebrandlogobytypeDOCUSIGN_DELETE_BRAND_LOGO_BY_TYPEAcciónThis 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.
DOCUSIGN_DELETE_BRAND_LOGO_BY_TYPEAcciónThis 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.
Parámetros de entrada
brandIdstringObligatorioThe 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".
logoTypestringObligatorioSpecifies which type of logo to delete from the brand. This parameter is required and must be one of three valid string values: "primary", "secondary", or "email". Each type serves a different purpose in document branding: - "primary": The main logo used for the brand - "secondary": An alternative logo used in specific contexts - "email": The logo used in email communications Choose the appropriate type based on which logo you want to remove from the brand.
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete brand profilesDOCUSIGN_DELETE_BRAND_PROFILESAcciónThis endpoint allows you to delete one or more brand profiles from a docusign account. it is used to remove custom branding configurations that are no longer needed. the method requires either the 'canselfbrandsign' or 'canselfbrandsend' setting to be enabled for the account. it's important to note that this operation is irreversible, so care should be taken when using this endpoint. the response provides detailed information about the deleted brands, including their ids, names, and associated resources.
DOCUSIGN_DELETE_BRAND_PROFILESAcciónThis endpoint allows you to delete one or more brand profiles from a docusign account. it is used to remove custom branding configurations that are no longer needed. the method requires either the 'canselfbrandsign' or 'canselfbrandsend' setting to be enabled for the account. it's important to note that this operation is irreversible, so care should be taken when using this endpoint. the response provides detailed information about the deleted brands, including their ids, names, and associated resources.
Parámetros de entrada
brandsobject[]A list of brands.
accountIdstringThe external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account from which the brand profiles will be deleted. It must be provided in the path of the API request and is required for the operation.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete chunked uploadDOCUSIGN_DELETE_CHUNKED_UPLOADAcciónDeletes 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.
DOCUSIGN_DELETE_CHUNKED_UPLOADAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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 used to specify which account the chunked upload belongs to.
chunkedUploadIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete connect configurationDOCUSIGN_DELETE_CONNECT_CONFIGURATIONAcciónDeletes 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.
DOCUSIGN_DELETE_CONNECT_CONFIGURATIONAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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.
connectIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete connect failure log entryDOCUSIGN_DELETE_CONNECT_FAILURE_LOG_ENTRYAcciónDeletes 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.
DOCUSIGN_DELETE_CONNECT_FAILURE_LOG_ENTRYAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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.
failureIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteconnectlogentriesDOCUSIGN_DELETE_CONNECT_LOG_ENTRIESAcciónDeletes a specified list of connect log entries for a docusign account. this endpoint is designed for account administrators to manage and clean up connect event logs. it should be used when you need to remove specific log entries, potentially for data management, privacy, or housekeeping purposes. the operation requires that connect be enabled on the account and that the user has account administrator privileges. it's important to note that this action is irreversible and will permanently remove the selected log entries, so it should be used with caution. the endpoint does not provide a way to retrieve or view the log entries before deletion, so ensure you have identified the correct entries to be deleted before using this function.
DOCUSIGN_DELETE_CONNECT_LOG_ENTRIESAcciónDeletes a specified list of connect log entries for a docusign account. this endpoint is designed for account administrators to manage and clean up connect event logs. it should be used when you need to remove specific log entries, potentially for data management, privacy, or housekeeping purposes. the operation requires that connect be enabled on the account and that the user has account administrator privileges. it's important to note that this action is irreversible and will permanently remove the selected log entries, so it should be used with caution. the endpoint does not provide a way to retrieve or view the log entries before deletion, so ensure you have identified the correct entries to be deleted before using this function.
Parámetros de entrada
accountIdstringThe 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 account"s Connect log entries should be deleted.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete connect oauth configurationDOCUSIGN_DELETE_CONNECT_OAUTH_CONFIGURATIONAcciónDeletes 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.
DOCUSIGN_DELETE_CONNECT_OAUTH_CONFIGURATIONAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete contact from accountDOCUSIGN_DELETE_CONTACT_FROM_ACCOUNTAcciónDeletes a specific contact from a docusign account. this endpoint should be used when you need to remove a contact's information from an account's address book. it requires both the account id and the specific contact id to be provided. upon successful deletion, it returns an updated list of contacts for the account. this operation is irreversible, so it should be used with caution. the endpoint does not provide any confirmation or undo functionality, so ensure the correct contact id is specified before making the call.
DOCUSIGN_DELETE_CONTACT_FROM_ACCOUNTAcciónDeletes a specific contact from a docusign account. this endpoint should be used when you need to remove a contact's information from an account's address book. it requires both the account id and the specific contact id to be provided. upon successful deletion, it returns an updated list of contacts for the account. this operation is irreversible, so it should be used with caution. the endpoint does not provide any confirmation or undo functionality, so ensure the correct contact id is specified before making the call.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account from which the contact will be deleted. This can be either an external account number (integer) or an account ID GUID (string). It is a required parameter and must be provided to specify the account context for the operation. Example: "12345" or "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6".
contactIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete custom document fieldsDOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDSAcciónDeletes 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.
DOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDSAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletecustomdocumentfieldsfromtemplateDOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDS_FROM_TEMPLATEAcciónDeletes 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.
DOCUSIGN_DELETE_CUSTOM_DOCUMENT_FIELDS_FROM_TEMPLATEAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
templateIdstringObligatorioThe 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.
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete custom fields in templateDOCUSIGN_DELETE_CUSTOM_FIELDS_IN_TEMPLATEAcciónThis endpoint deletes specified custom fields from a docusign template. it allows users to remove both list and text custom fields that are no longer needed or relevant for the template. the operation is performed on a specific template identified by the templateid within a given docusign account specified by the accountid. users can selectively delete custom fields by providing arrays of listcustomfields and/or textcustomfields in the request body. if successful, the response will contain information about the remaining custom fields in the template. this endpoint is useful for maintaining and updating templates by removing outdated or unnecessary custom fields, thereby streamlining the document creation process.
DOCUSIGN_DELETE_CUSTOM_FIELDS_IN_TEMPLATEAcciónThis endpoint deletes specified custom fields from a docusign template. it allows users to remove both list and text custom fields that are no longer needed or relevant for the template. the operation is performed on a specific template identified by the templateid within a given docusign account specified by the accountid. users can selectively delete custom fields by providing arrays of listcustomfields and/or textcustomfields in the request body. if successful, the response will contain information about the remaining custom fields in the template. this endpoint is useful for maintaining and updating templates by removing outdated or unnecessary custom fields, thereby streamlining the document creation process.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID associated with the DocuSign account. This parameter is required and uniquely identifies the account for which the template custom fields will be deleted. It must be a valid string representation of either an integer or a GUID.
templateIdstringObligatorioThe 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.
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete custom tab informationDOCUSIGN_DELETE_CUSTOM_TAB_INFORMATIONAcciónDeletes 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.
DOCUSIGN_DELETE_CUSTOM_TAB_INFORMATIONAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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.
customTabIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete custom user settingsDOCUSIGN_DELETE_CUSTOM_USER_SETTINGSAcciónDeletes specified custom user settings for a single docusign user. this endpoint allows for the removal of both grouped and ungrouped custom settings, providing flexibility in managing user preferences. it's particularly useful for cleaning up or resetting user-specific configurations within a docusign account. the operation requires careful use of parameters to ensure only intended settings are deleted, and it's important to note that users can only modify their own settings.
DOCUSIGN_DELETE_CUSTOM_USER_SETTINGSAcciónDeletes specified custom user settings for a single docusign user. this endpoint allows for the removal of both grouped and ungrouped custom settings, providing flexibility in managing user preferences. it's particularly useful for cleaning up or resetting user-specific configurations within a docusign account. the operation requires careful use of parameters to ensure only intended settings are deleted, and it's important to note that users can only modify their own settings.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose custom settings are to be deleted. This parameter is required and must be provided in the path. Important: Users can only access and modify their own settings, even those with Admin rights cannot access another user"s settings.
accountIdstringThe 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.
customSettingsobject[]The name/value pair information for the user custom setting.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletedelayedroutingruleforenvelopestepDOCUSIGN_DELETE_DELAYED_ROUTING_RULE_FOR_ENVELOPE_STEPAcciónThis 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.
DOCUSIGN_DELETE_DELAYED_ROUTING_RULE_FOR_ENVELOPE_STEPAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete delayed routing rules for templateDOCUSIGN_DELETE_DELAYED_ROUTING_RULES_FOR_TEMPLATEAcciónDeletes 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.
DOCUSIGN_DELETE_DELAYED_ROUTING_RULES_FOR_TEMPLATEAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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".
templateIdstringObligatorioThe 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".
workflowStepIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete draft envelope attachmentsDOCUSIGN_DELETE_DRAFT_ENVELOPE_ATTACHMENTSAcciónDeletes 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.
DOCUSIGN_DELETE_DRAFT_ENVELOPE_ATTACHMENTSAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe 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".
attachmentsobject[]An object that contains information about the attachment.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteenoteconfigurationDOCUSIGN_DELETE_ENOTE_CONFIGURATIONAcciónDeletes 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.
DOCUSIGN_DELETE_ENOTE_CONFIGURATIONAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account from which the eNote configuration should be deleted. This can be either the external account number (integer) or the account ID GUID. It is required for the operation and must be provided in the path of the API request. The format depends on the type of identifier used: for external account numbers, it should be a string representation of an integer; for GUIDs, it should be a string in the standard GUID format (e.g., "12345678-1234-1234-1234-123456789012").
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteenvelopecustomfieldsDOCUSIGN_DELETE_ENVELOPE_CUSTOM_FIELDSAcciónThis 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.
DOCUSIGN_DELETE_ENVELOPE_CUSTOM_FIELDSAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteenvelopeemailsettingsDOCUSIGN_DELETE_ENVELOPE_EMAIL_SETTINGSAcciónDeletes 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.
DOCUSIGN_DELETE_ENVELOPE_EMAIL_SETTINGSAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteenvelopelockDOCUSIGN_DELETE_ENVELOPE_LOCKAcciónThe deleteenvelopelock endpoint removes the lock from a specified envelope in docusign, allowing it to be modified again. this operation is crucial for managing document workflows where temporary locks are used to prevent concurrent edits. the endpoint requires the x-docusign-edit header for authentication and can optionally save or discard changes made during the lock period. it's important to note that only the user who initially locked the envelope can delete the lock, ensuring security and consistency in the document management process.
DOCUSIGN_DELETE_ENVELOPE_LOCKAcciónThe deleteenvelopelock endpoint removes the lock from a specified envelope in docusign, allowing it to be modified again. this operation is crucial for managing document workflows where temporary locks are used to prevent concurrent edits. the endpoint requires the x-docusign-edit header for authentication and can optionally save or discard changes made during the lock period. it's important to note that only the user who initially locked the envelope can delete the lock, ensuring security and consistency in the document management process.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete envelope scheduled sending rulesDOCUSIGN_DELETE_ENVELOPE_SCHEDULED_SENDING_RULESAcciónDeletes 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.
DOCUSIGN_DELETE_ENVELOPE_SCHEDULED_SENDING_RULESAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete envelope transfer ruleDOCUSIGN_DELETE_ENVELOPE_TRANSFER_RULEAcciónDeletes 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.
DOCUSIGN_DELETE_ENVELOPE_TRANSFER_RULEAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. It can be either an external account number (integer) or an account ID GUID (string). This parameter is required to specify which account the envelope transfer rule belongs to. The value must be a valid account identifier associated with the API user"s organization.
envelopeTransferRuleIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete envelope workflow definitionDOCUSIGN_DELETE_ENVELOPE_WORKFLOW_DEFINITIONAcciónThis 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.
DOCUSIGN_DELETE_ENVELOPE_WORKFLOW_DEFINITIONAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete envelope workflow stepDOCUSIGN_DELETE_ENVELOPE_WORKFLOW_STEPAcciónDeletes 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.
DOCUSIGN_DELETE_ENVELOPE_WORKFLOW_STEPAcciónDeletes 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.
Parámetros de entrada
accountIdstringA 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).
envelopeIdstringObligatorioThe 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").
workflowStepIdstringObligatorioThe 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).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete existing workspace logicallyDOCUSIGN_DELETE_EXISTING_WORKSPACE_LOGICALLYAcciónLogically deletes an existing workspace in docusign. this endpoint should be used when you need to remove a workspace from active use without permanently erasing its data. the deletion is logical, meaning the workspace is marked as deleted but can potentially be recovered if needed. this operation requires specific identification of the account and workspace, and returns detailed information about the deleted workspace upon success. use this endpoint with caution, as it will make the workspace inaccessible to users.
DOCUSIGN_DELETE_EXISTING_WORKSPACE_LOGICALLYAcciónLogically deletes an existing workspace in docusign. this endpoint should be used when you need to remove a workspace from active use without permanently erasing its data. the deletion is logical, meaning the workspace is marked as deleted but can potentially be recovered if needed. this operation requires specific identification of the account and workspace, and returns detailed information about the deleted workspace upon success. use this endpoint with caution, as it will make the workspace inaccessible to users.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that identifies the DocuSign account associated with the workspace. 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 (Globally Unique Identifier) format. For example: "12345" or "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p".
workspaceIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete members from signing groupDOCUSIGN_DELETE_MEMBERS_FROM_SIGNING_GROUPAcciónRemoves 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.
DOCUSIGN_DELETE_MEMBERS_FROM_SIGNING_GROUPAcciónRemoves 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.
Parámetros de entrada
usersobject[]User management information.
accountIdstringThe 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".
signingGroupIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletemultiplecontactsfromaccountDOCUSIGN_DELETE_MULTIPLE_CONTACTS_FROM_ACCOUNTAcciónDeletes multiple contacts associated with a specific docusign account. this endpoint allows for bulk removal of contacts from an account's address book, streamlining contact management operations. it's particularly useful for cleaning up outdated or unnecessary contacts, or when reorganizing large contact lists. the endpoint accepts a list of contact ids and returns details of the deleted contacts or error information if the deletion was unsuccessful for any contact. note that this operation is irreversible, so it should be used with caution. it's recommended to verify the contacts to be deleted before making the api call.
DOCUSIGN_DELETE_MULTIPLE_CONTACTS_FROM_ACCOUNTAcciónDeletes multiple contacts associated with a specific docusign account. this endpoint allows for bulk removal of contacts from an account's address book, streamlining contact management operations. it's particularly useful for cleaning up outdated or unnecessary contacts, or when reorganizing large contact lists. the endpoint accepts a list of contact ids and returns details of the deleted contacts or error information if the deletion was unsuccessful for any contact. note that this operation is irreversible, so it should be used with caution. it's recommended to verify the contacts to be deleted before making the api call.
Parámetros de entrada
accountIdstringThe 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.
contactListobject[]A list of contacts.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete notary jurisdictionDOCUSIGN_DELETE_NOTARY_JURISDICTIONAcciónDeletes 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.
DOCUSIGN_DELETE_NOTARY_JURISDICTIONAcciónDeletes 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.
Parámetros de entrada
jurisdictionIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete one or more signing groupsDOCUSIGN_DELETE_ONE_OR_MORE_SIGNING_GROUPSAcciónDeletes one or more signing groups from a specified docusign account. this endpoint allows for bulk deletion of signing groups, which are collections of users authorized to sign documents on behalf of the group. it should be used when you need to remove outdated or unnecessary signing groups from your account. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this action does not delete the individual users within the groups, only the group associations.
DOCUSIGN_DELETE_ONE_OR_MORE_SIGNING_GROUPSAcciónDeletes one or more signing groups from a specified docusign account. this endpoint allows for bulk deletion of signing groups, which are collections of users authorized to sign documents on behalf of the group. it should be used when you need to remove outdated or unnecessary signing groups from your account. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this action does not delete the individual users within the groups, only the group associations.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete page from document in envelopeDOCUSIGN_DELETE_PAGE_FROM_DOCUMENT_IN_ENVELOPEAcciónDeletes a specific page from a document within an envelope in docusign. this endpoint allows you to remove a single page from a document based on its page number. it's useful for modifying documents after they've been added to an envelope but before the envelope has been sent for signing. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires specific identification of the account, envelope, document, and page number to ensure precise targeting of the deletion operation.
DOCUSIGN_DELETE_PAGE_FROM_DOCUMENT_IN_ENVELOPEAcciónDeletes a specific page from a document within an envelope in docusign. this endpoint allows you to remove a single page from a document based on its page number. it's useful for modifying documents after they've been added to an envelope but before the envelope has been sent for signing. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires specific identification of the account, envelope, document, and page number to ensure precise targeting of the deletion operation.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to specify which account the operation should be performed on. The value should be a string representation of either the numeric account number or the full GUID of the account.
documentIdstringObligatorioThe unique identifier for the document within the envelope. This parameter is required and must be specified by the user. It typically follows a simple numerical sequence (1, 2, 3, etc.) but can be any positive integer up to 2,147,483,647. This ID is crucial for identifying which document in the envelope will have a page deleted. It"s also used in tab objects to specify document placement.
envelopeIdstringObligatorioThe 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.
pageNumberstringObligatorioThe 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. The page number should correspond to the actual page in the document that needs to be removed. It"s crucial to ensure the correct page number is specified, as this operation permanently deletes the page from the document.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete page from template documentDOCUSIGN_DELETE_PAGE_FROM_TEMPLATE_DOCUMENTAcciónDeletes 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.
DOCUSIGN_DELETE_PAGE_FROM_TEMPLATE_DOCUMENTAcciónDeletes 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.
Parámetros de entrada
rotatestringSets the direction the page image is rotated. The possible settings are: left or right
passwordstringThe user"s encrypted password hash.
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
pageNumberstringObligatorioThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete powerform by idDOCUSIGN_DELETE_POWER_FORM_BY_IDAcciónThis 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.
DOCUSIGN_DELETE_POWER_FORM_BY_IDAcciónThis 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required to ensure the PowerForm deletion occurs in the correct account context. It must be a valid string representing either a numeric account number or a GUID (e.g., "1234567" or "12345678-1234-1234-1234-123456789012").
powerFormIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete request log filesDOCUSIGN_DELETE_REQUEST_LOG_FILESAcciónDeletes all request log files associated with the docusign api. this endpoint is part of the diagnostics service and is used for maintenance and troubleshooting purposes. it should be used when you need to clean up or remove accumulated request logs, which can help in managing storage and maintaining system performance. the operation does not require any parameters and will delete all available request logs. use this endpoint with caution, as deleted logs cannot be recovered. it's recommended to backup any critical log data before performing this operation.
DOCUSIGN_DELETE_REQUEST_LOG_FILESAcciónDeletes all request log files associated with the docusign api. this endpoint is part of the diagnostics service and is used for maintenance and troubleshooting purposes. it should be used when you need to clean up or remove accumulated request logs, which can help in managing storage and maintaining system performance. the operation does not require any parameters and will delete all available request logs. use this endpoint with caution, as deleted logs cannot be recovered. it's recommended to backup any critical log data before performing this operation.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete scheduled sending rulesDOCUSIGN_DELETE_SCHEDULED_SENDING_RULESAcciónDeletes 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.
DOCUSIGN_DELETE_SCHEDULED_SENDING_RULESAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be a valid account identifier associated with the API credentials being used.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete signature for captive recipientsDOCUSIGN_DELETE_SIGNATURE_FOR_CAPTIVE_RECIPIENTSAcciónThis endpoint deletes the signature for one or more captive (embedded) recipient records in docusign. it is primarily designed for testing purposes, allowing developers to reset the signature associated with a client user id. this enables the creation of a new signature the next time the client user id is used. the endpoint should be used when testing signature workflows or when it's necessary to clear existing signatures for embedded recipients. it's important to note that this operation is not intended for regular production use and should be employed cautiously, as it permanently removes signature data. the endpoint requires specifying the account id and confirming that the operation is for the 'signature' part of the recipient information. the request body should include details of the captive recipients whose signatures are to be deleted, primarily identified by their clientuserid.
DOCUSIGN_DELETE_SIGNATURE_FOR_CAPTIVE_RECIPIENTSAcciónThis endpoint deletes the signature for one or more captive (embedded) recipient records in docusign. it is primarily designed for testing purposes, allowing developers to reset the signature associated with a client user id. this enables the creation of a new signature the next time the client user id is used. the endpoint should be used when testing signature workflows or when it's necessary to clear existing signatures for embedded recipients. it's important to note that this operation is not intended for regular production use and should be employed cautiously, as it permanently removes signature data. the endpoint requires specifying the account id and confirming that the operation is for the 'signature' part of the recipient information. the request body should include details of the captive recipients whose signatures are to be deleted, primarily identified by their clientuserid.
Parámetros de entrada
accountIdstringThe 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.
recipientPartstringObligatorioSpecifies 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". This indicates that the operation will delete the signature associated with the specified captive recipients.
captiveRecipientsobject[]A complex type containing information about one or more captive recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete specific connect log entryDOCUSIGN_DELETE_SPECIFIC_CONNECT_LOG_ENTRYAcciónDeletes 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.
DOCUSIGN_DELETE_SPECIFIC_CONNECT_LOG_ENTRYAcciónDeletes 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.
Parámetros de entrada
logIdstringObligatorioThe 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".
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete specified accountDOCUSIGN_DELETE_SPECIFIED_ACCOUNTAcciónDeletes (closes) a specified docusign account. this operation permanently closes the account and can only be performed by an account admin. once an account is closed, it cannot be reopened by users and must be reactivated by docusign support. use this endpoint with caution as it has significant implications for access to documents and user data associated with the account. the optional redact user data parameter allows for additional data privacy measures during deletion. this endpoint should be used when an organization needs to completely shut down their docusign account, such as when ceasing operations or consolidating multiple accounts.
DOCUSIGN_DELETE_SPECIFIED_ACCOUNTAcciónDeletes (closes) a specified docusign account. this operation permanently closes the account and can only be performed by an account admin. once an account is closed, it cannot be reopened by users and must be reactivated by docusign support. use this endpoint with caution as it has significant implications for access to documents and user data associated with the account. the optional redact user data parameter allows for additional data privacy measures during deletion. this endpoint should be used when an organization needs to completely shut down their docusign account, such as when ceasing operations or consolidating multiple accounts.
Parámetros de entrada
accountIdstringThe 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.
redact_user_datastringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete stamp image for accountDOCUSIGN_DELETE_STAMP_IMAGE_FOR_ACCOUNTAcciónThis 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.
DOCUSIGN_DELETE_STAMP_IMAGE_FOR_ACCOUNTAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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 stamp image belongs to.
imageTypestringObligatorioSpecifies the type of image to be deleted. Must be one of the following values: "stamp_image", "signature_image", or "initials_image". This parameter is required to ensure the correct type of image is deleted from the account signature.
signatureIdstringObligatorioThe unique identifier for the account stamp (signature) from which the image will be deleted. This ID is required to target the specific stamp within the account for image deletion.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeletetemplatefromenvelopedocumentDOCUSIGN_DELETE_TEMPLATE_FROM_ENVELOPE_DOCUMENTAcciónThis endpoint deletes a specified template from a document within an existing envelope in docusign. it allows users to remove a template that has been previously applied to a document, providing flexibility in managing document content and structure. this operation is useful when you need to update or modify the document by removing a specific template, perhaps to replace it with a different one or to revert the document to its original state. it's important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly valuable in workflows where document templates need to be dynamically managed or updated based on changing requirements or corrections.
DOCUSIGN_DELETE_TEMPLATE_FROM_ENVELOPE_DOCUMENTAcciónThis endpoint deletes a specified template from a document within an existing envelope in docusign. it allows users to remove a template that has been previously applied to a document, providing flexibility in managing document content and structure. this operation is useful when you need to update or modify the document by removing a specific template, perhaps to replace it with a different one or to revert the document to its original state. it's important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly valuable in workflows where document templates need to be dynamically managed or updated based on changing requirements or corrections.
Parámetros de entrada
accountIdstringThe 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. The accountId is crucial for multi-account environments to ensure the correct account is accessed.
documentIdstringObligatorioThe unique identifier for the document within the envelope. Unlike other IDs in the eSignature API, you specify this ID yourself. It"s typically a number between 1 and 2147483647, with the first document usually assigned ID "1", the second "2", and so on. This flexibility allows for custom document numbering schemes within the 32-bit signed integer range. The documentId is used in tab objects to specify which document a tab should be placed on.
envelopeIdstringObligatorioThe globally unique identifier (GUID) for the envelope. This 32-character string uniquely identifies the envelope from which the template will be deleted. For example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". The envelopeId is crucial for targeting the specific envelope containing the document and template to be modified.
templateIdstringObligatorioThe unique identifier for the template that needs to be deleted from the document. This ID is specific to the template within the DocuSign system. Ensure you provide the correct templateId to avoid unintentionally deleting the wrong template from your document.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete template lockDOCUSIGN_DELETE_TEMPLATE_LOCKAcciónDeletes the lock from a specified template in docusign. this endpoint allows users to remove a lock they previously placed on a template, with the option to save or discard changes made during the lock period. it should be used when a user wants to release their lock on a template, either after making changes or deciding to abandon modifications. the endpoint requires the user deleting the lock to be the same user who initially locked the template, ensuring security and preventing unauthorized lock removals. it's important to note that this operation requires the x-docusign-edit header for authentication.
DOCUSIGN_DELETE_TEMPLATE_LOCKAcciónDeletes the lock from a specified template in docusign. this endpoint allows users to remove a lock they previously placed on a template, with the option to save or discard changes made during the lock period. it should be used when a user wants to release their lock on a template, either after making changes or deciding to abandon modifications. the endpoint requires the user deleting the lock to be the same user who initially locked the template, ensuring security and preventing unauthorized lock removals. it's important to note that this operation requires the x-docusign-edit header for authentication.
Parámetros de entrada
lockTypestringThe type of lock. Currently `edit` is the only supported type.
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and must be provided in the path. It identifies the DocuSign account associated with the template lock operation.
templateIdstringObligatorioThe 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.
lockedByAppstringA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
useScratchPadstringWhen **true,** a scratchpad is used to edit information.
templatePasswordstringThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). 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.
lockDurationInSecondsstringThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete template workflow stepDOCUSIGN_DELETE_TEMPLATE_WORKFLOW_STEPAcciónDeletes 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.
DOCUSIGN_DELETE_TEMPLATE_WORKFLOW_STEPAcciónDeletes 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be a valid string representing either the numeric account number or the GUID format account ID. It is used to authenticate and authorize the API request to the specific DocuSign account.
templateIdstringObligatorioThe 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.
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteuserauthforcloudstorageprovidersDOCUSIGN_DELETE_USER_AUTH_FOR_CLOUD_STORAGE_PROVIDERSAcciónThis 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.
DOCUSIGN_DELETE_USER_AUTH_FOR_CLOUD_STORAGE_PROVIDERSAcciónThis 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.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
storageProvidersobject[]An Array containing the storage providers associated with the user.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete user authorizationDOCUSIGN_DELETE_USER_AUTHORIZATIONAcciónDeletes a specific user authorization within the docusign system. this endpoint is used to revoke or remove permissions previously granted to a user. it requires either account administrator privileges or being the principal user of the specified authorization. the operation is irreversible, so it should be used cautiously. this tool is particularly useful for managing access control and maintaining security by removing outdated or unnecessary user permissions. it does not provide information about existing authorizations or create new ones; it solely focuses on deletion.
DOCUSIGN_DELETE_USER_AUTHORIZATIONAcciónDeletes a specific user authorization within the docusign system. this endpoint is used to revoke or remove permissions previously granted to a user. it requires either account administrator privileges or being the principal user of the specified authorization. the operation is irreversible, so it should be used cautiously. this tool is particularly useful for managing access control and maintaining security by removing outdated or unnecessary user permissions. it does not provide information about existing authorizations or create new ones; it solely focuses on deletion.
Parámetros de entrada
userIdstringObligatorioThe 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).
accountIdstringThe 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).
authorizationIdstringObligatorioThe 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).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteuserauthorizationsDOCUSIGN_DELETE_USER_AUTHORIZATIONSAcciónThe 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.
DOCUSIGN_DELETE_USER_AUTHORIZATIONSAcciónThe 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.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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 determines the scope of the authorization deletion operation. The value should be a valid DocuSign account identifier, typically a string of numbers or a GUID (Globally Unique Identifier).
authorizationsstring[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete user cloud storage authenticationDOCUSIGN_DELETE_USER_CLOUD_STORAGE_AUTHENTICATIONAcciónThis 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.
DOCUSIGN_DELETE_USER_CLOUD_STORAGE_AUTHENTICATIONAcciónThis 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.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose cloud storage authentication is being deleted. Must be a valid user ID within the specified DocuSign account. Important: Users can only delete their own authentication information, even those with Admin rights cannot access or modify another user"s settings.
accountIdstringThe 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.
serviceIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
DeleteusergroupDOCUSIGN_DELETE_USER_GROUPAcciónDeletes one or more existing user groups from a specified docusign account. this endpoint should be used when you need to remove user groups that are no longer needed or have become obsolete. it requires the account id and the group id(s) of the group(s) to be deleted. the operation is irreversible, so use it with caution. this endpoint only deletes the group itself and does not affect the individual users who were members of the group. after deletion, any permissions or settings associated with the group will no longer apply to its former members.
DOCUSIGN_DELETE_USER_GROUPAcciónDeletes one or more existing user groups from a specified docusign account. this endpoint should be used when you need to remove user groups that are no longer needed or have become obsolete. it requires the account id and the group id(s) of the group(s) to be deleted. the operation is irreversible, so use it with caution. this endpoint only deletes the group itself and does not affect the individual users who were members of the group. after deletion, any permissions or settings associated with the group will no longer apply to its former members.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
nextUristringThe 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.
accountIdstringThe 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 ensures that the group deletion operation is performed on the correct account.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete user initials or signature imageDOCUSIGN_DELETE_USER_INITIALS_OR_SIGNATURE_IMAGEAcciónThis 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.
DOCUSIGN_DELETE_USER_INITIALS_OR_SIGNATURE_IMAGEAcciónThis 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.
Parámetros de entrada
userIdstringObligatorioThe unique identifier for the user whose signature image is being deleted. This parameter is required and must match the authenticated user"s ID. Users can only delete their own signature images, even those with admin rights cannot access another user"s settings.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be a valid account identifier associated with the authenticated user.
imageTypestringObligatorioSpecifies the type of image to be deleted. This parameter is required and must be one of the following valid values: "stamp_image", "signature_image", or "initials_image". Each value corresponds to a specific type of user signature image in DocuSign.
signatureIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete user profile imageDOCUSIGN_DELETE_USER_PROFILE_IMAGEAcciónDeletes the profile image of a specified user within a docusign account. this endpoint should be used when a user wants to remove their current profile picture from their docusign account. it's important to note that this operation can only be performed by the user on their own profile; even users with admin rights cannot delete another user's profile image. the endpoint requires both the account id and the user id to be specified, ensuring that the operation is performed on the correct user within the correct account. after successful deletion, the user's profile will no longer have an associated image. this endpoint does not provide the ability to upload a new image; it only removes the existing one.
DOCUSIGN_DELETE_USER_PROFILE_IMAGEAcciónDeletes the profile image of a specified user within a docusign account. this endpoint should be used when a user wants to remove their current profile picture from their docusign account. it's important to note that this operation can only be performed by the user on their own profile; even users with admin rights cannot delete another user's profile image. the endpoint requires both the account id and the user id to be specified, ensuring that the operation is performed on the correct user within the correct account. after successful deletion, the user's profile will no longer have an associated image. this endpoint does not provide the ability to upload a new image; it only removes the existing one.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose profile image is to be deleted. This parameter is required and must be provided in the path. It must match the authenticated user"s own user ID, as users can only access and modify their own information. The userId should be a valid string format used by DocuSign to identify users.
accountIdstringThe 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 should be a valid string representing either a numeric account number or a GUID format account ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete users from groupDOCUSIGN_DELETE_USERS_FROM_GROUPAcciónDeletes 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.
DOCUSIGN_DELETE_USERS_FROM_GROUPAcciónDeletes 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.
Parámetros de entrada
usersobject[]An array of `userInfo` objects containing information about the users in the group.
groupIdstringObligatorioThe 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.
accountIdstringThe 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 helps identify the specific account from which users will be deleted.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete workflow definition for templateDOCUSIGN_DELETE_WORKFLOW_DEFINITION_FOR_TEMPLATEAcciónDeletes the workflow definition associated with a specific template in docusign. this endpoint is used to remove any existing workflow settings from a template, such as scheduled sending or delayed routing. it's particularly useful when you need to reset a template's workflow or prepare it for new workflow configurations. the operation is idempotent, meaning it will return a successful response even if the template doesn't have a workflow definition. this feature allows for safe, repeated calls without causing errors.
DOCUSIGN_DELETE_WORKFLOW_DEFINITION_FOR_TEMPLATEAcciónDeletes the workflow definition associated with a specific template in docusign. this endpoint is used to remove any existing workflow settings from a template, such as scheduled sending or delayed routing. it's particularly useful when you need to reset a template's workflow or prepare it for new workflow configurations. the operation is idempotent, meaning it will return a successful response even if the template doesn't have a workflow definition. this feature allows for safe, repeated calls without causing errors.
Parámetros de entrada
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete workspace files or foldersDOCUSIGN_DELETE_WORKSPACE_FILES_OR_FOLDERSAcciónThis 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.
DOCUSIGN_DELETE_WORKSPACE_FILES_OR_FOLDERSAcciónThis 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.
Parámetros de entrada
itemsobject[]A list of workspace items.
folderIdstringObligatorioThe 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").
accountIdstringThe 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").
workspaceIdstringObligatorioThe 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").
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deprecated endpoint for tab blobDOCUSIGN_DEPRECATED_ENDPOINT_FOR_TAB_BLOBAcciónThis 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.
DOCUSIGN_DEPRECATED_ENDPOINT_FOR_TAB_BLOBAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ExportbrandtoxmlfileDOCUSIGN_EXPORT_BRAND_TO_XMLFILEAcciónThis endpoint exports information about a docusign brand to an xml file. it allows users to retrieve structured brand data for an account, which can be useful for backup, analysis, or integration purposes. the endpoint should be used when there's a need to extract comprehensive brand information in a standardized format. note that this operation is only available if branding for either signing or sending is enabled for the account (canselfbrandsend or canselfbrandsign must be set to true). the exported xml file contains all relevant brand settings and configurations associated with the specified brand id.
DOCUSIGN_EXPORT_BRAND_TO_XMLFILEAcciónThis endpoint exports information about a docusign brand to an xml file. it allows users to retrieve structured brand data for an account, which can be useful for backup, analysis, or integration purposes. the endpoint should be used when there's a need to extract comprehensive brand information in a standardized format. note that this operation is only available if branding for either signing or sending is enabled for the account (canselfbrandsend or canselfbrandsign must be set to true). the exported xml file contains all relevant brand settings and configurations associated with the specified brand id.
Parámetros de entrada
brandIdstringObligatorioThe 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.
accountIdstringThe 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 information should be exported. The accountId must correspond to an active DocuSign account with branding enabled.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
FetchrecipientnamesforemailDOCUSIGN_FETCH_RECIPIENT_NAMES_FOR_EMAILAcciónRetrieves 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.
DOCUSIGN_FETCH_RECIPIENT_NAMES_FOR_EMAILAcciónRetrieves 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.
Parámetros de entrada
emailstringThe email address for which you want to retrieve associated recipient names. This parameter is required and should be provided as a query parameter. 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.
accountIdstringThe 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 data should be accessed when retrieving recipient names.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GenerateeditviewurlforenvelopeDOCUSIGN_GENERATE_EDIT_VIEW_URLFOR_ENVELOPEAcciónGenerates 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.
DOCUSIGN_GENERATE_EDIT_VIEW_URLFOR_ENVELOPEAcciónGenerates 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.
Parámetros de entrada
accountIdstringThe 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.
returnUrlstringIdentifies 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).
envelopeIdstringObligatorioThe 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.
viewAccessstringSet 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.
settings__lockTokenstringIf your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
settings__showBackButtonstringDetermines 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.
settings__startingScreenstringDetermines the starting screen for the sender view. Valid values: * `Prepare` (default) * `Tagger`
settings__backButtonActionstringSets 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
settings__sendButtonActionstringSets 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`.
settings__showDiscardActionstringWhen **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
settings__showHeaderActionsstringDetermines 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`.
settings__showAdvancedOptionsstringReserved for Docusign.
settings__taggerSettings__paletteDefaultstringWhen `paletteSections` is set to `custom`, this property selects the tagger palette. Valid values: * `custom` (default) * `merge` * `notary` * `seals` * `smartContracts` * `annotations` * `smartSections`
settings__documentSettings__showEditPagesstringsettings__recipientSettings__showBulkSendstringReserved for Docusign.
settings__taggerSettings__paletteSectionsstringValid values: * `default` (default): The default tagger palette UX * `none`: No tagger palette * `custom`: Set by `paletteDefault`
settings__recipientSettings__showEditMessagestringReserved for Docusign.
settings__documentSettings__showEditDocumentsstringWhen **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**
settings__recipientSettings__showContactsListstringsettings__recipientSettings__showEditRecipientsstringsettings__documentSettings__showEditDocumentVisibilitystringsettings__taggerSettings__paletteSettings__merge__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__seals__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__custom__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__notary__showstringReserved for Docusign.
settings__templateSettings__showMatchingTemplatesPromptstringReserved for Docusign.
settings__documentSettings__showSaveAsDocumentCustomFieldstringReserved for Docusign.
settings__taggerSettings__paletteSettings__annotations__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartSections__showstringReserved for Docusign.
settings__envelopeCustomFieldSettings__showEnvelopeCustomFieldsstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartContracts__showstringReserved for Docusign.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GenerateenvelopecorrectionurlDOCUSIGN_GENERATE_ENVELOPE_CORRECTION_URLAcciónGenerates a url that allows embedding the envelope correction view of the docusign ui within an application. this endpoint enables customization of the correction view appearance and functionality through query parameters. the returned url provides temporary, one-time access to the envelope correction interface, allowing users to modify and update envelope details securely within your application.
DOCUSIGN_GENERATE_ENVELOPE_CORRECTION_URLAcciónGenerates a url that allows embedding the envelope correction view of the docusign ui within an application. this endpoint enables customization of the correction view appearance and functionality through query parameters. the returned url provides temporary, one-time access to the envelope correction interface, allowing users to modify and update envelope details securely within your application.
Parámetros de entrada
accountIdstringThe 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 envelope correction view should be generated for.
returnUrlstringIdentifies 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).
envelopeIdstringObligatorioThe unique identifier for the envelope that needs correction. 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 the specific envelope to be corrected. Example format: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
viewAccessstringSet 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.
settings__lockTokenstringIf your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
settings__showBackButtonstringDetermines 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.
settings__startingScreenstringDetermines the starting screen for the sender view. Valid values: * `Prepare` (default) * `Tagger`
settings__backButtonActionstringSets 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
settings__sendButtonActionstringSets 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`.
settings__showDiscardActionstringWhen **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
settings__showHeaderActionsstringDetermines 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`.
settings__showAdvancedOptionsstringReserved for Docusign.
settings__taggerSettings__paletteDefaultstringWhen `paletteSections` is set to `custom`, this property selects the tagger palette. Valid values: * `custom` (default) * `merge` * `notary` * `seals` * `smartContracts` * `annotations` * `smartSections`
settings__documentSettings__showEditPagesstringsettings__recipientSettings__showBulkSendstringReserved for Docusign.
settings__taggerSettings__paletteSectionsstringValid values: * `default` (default): The default tagger palette UX * `none`: No tagger palette * `custom`: Set by `paletteDefault`
settings__recipientSettings__showEditMessagestringReserved for Docusign.
settings__documentSettings__showEditDocumentsstringWhen **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**
settings__recipientSettings__showContactsListstringsettings__recipientSettings__showEditRecipientsstringsettings__documentSettings__showEditDocumentVisibilitystringsettings__taggerSettings__paletteSettings__merge__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__seals__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__custom__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__notary__showstringReserved for Docusign.
settings__templateSettings__showMatchingTemplatesPromptstringReserved for Docusign.
settings__documentSettings__showSaveAsDocumentCustomFieldstringReserved for Docusign.
settings__taggerSettings__paletteSettings__annotations__showstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartSections__showstringReserved for Docusign.
settings__envelopeCustomFieldSettings__showEnvelopeCustomFieldsstringReserved for Docusign.
settings__taggerSettings__paletteSettings__smartContracts__showstringReserved for Docusign.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GeneraterecipientsharedviewurlDOCUSIGN_GENERATE_RECIPIENT_SHARED_VIEW_URLAcciónGenerates a url that enables embedding the docusign ui recipient view of a shared envelope in your application. this endpoint is specifically used for shared envelopes, allowing recipients on the same account to view and interact with the shared envelope directly within your application. it's particularly useful for collaborative document signing and management scenarios. the generated url should not be used in iframes on mobile devices due to screen space limitations; for ios devices, a webview is recommended instead.
DOCUSIGN_GENERATE_RECIPIENT_SHARED_VIEW_URLAcciónGenerates a url that enables embedding the docusign ui recipient view of a shared envelope in your application. this endpoint is specifically used for shared envelopes, allowing recipients on the same account to view and interact with the shared envelope directly within your application. it's particularly useful for collaborative document signing and management scenarios. the generated url should not be used in iframes on mobile devices due to screen space limitations; for ios devices, a webview is recommended instead.
Parámetros de entrada
emailstring(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
userIdstringThe user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user.
pingUrlstringThe 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.
userNamestringThe username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
accountIdstringThe 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 shared envelope view is being generated.
returnUrlstring(Required) 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.
envelopeIdstringObligatorioThe 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".
assertionIdstringA unique identifier of the authentication event executed by the client application.
recipientIdstringUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
clientUserIdstringA 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.
displayFormatstringpingFrequencystringOnly 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.
xFrameOptionsstringSpecifies 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.
frameAncestorsstring[]An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-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"]`
messageOriginsstring[]The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`.
securityDomainstringThe domain in which the user authenticated.
authenticationMethodstringRequired. 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.
clientURLs__onCancelstringauthenticationInstantstringA sender-generated value that indicates the date and time that the signer was authenticated.
clientURLs__onDeclinestringclientURLs__onExceptionstringclientURLs__onFaxPendingstringclientURLs__onTTLExpiredstringxFrameOptionsAllowFromUrlstringWhen 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.
clientURLs__onIdCheckFailedstringclientURLs__onSessionTimeoutstringclientURLs__onSigningCompletestringclientURLs__onViewingCompletestringclientURLs__onAccessCodeFailedstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get account billing charges listDOCUSIGN_GET_ACCOUNT_BILLING_CHARGES_LISTAcciónRetrieves 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.
DOCUSIGN_GET_ACCOUNT_BILLING_CHARGES_LISTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
include_chargesstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get account password rulesDOCUSIGN_GET_ACCOUNT_PASSWORD_RULESAcciónRetrieves 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.
DOCUSIGN_GET_ACCOUNT_PASSWORD_RULESAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 password rules should be retrieved. The accountId must correspond to a valid, existing DocuSign account that the authenticated user has permission to access.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get account stamp imageDOCUSIGN_GET_ACCOUNT_STAMP_IMAGEAcciónRetrieves the image file for a specific account stamp, signature, or initials in docusign. this endpoint allows users to obtain the visual representation of stamps or signatures associated with their docusign account. it's particularly useful when you need to display or embed these images in other documents or applications. the endpoint returns the actual image file in gif format, not just metadata. it supports retrieving different types of images (stamp, signature, or initials) and offers an option to include or exclude the chrome (frame) around the image.
DOCUSIGN_GET_ACCOUNT_STAMP_IMAGEAcciónRetrieves the image file for a specific account stamp, signature, or initials in docusign. this endpoint allows users to obtain the visual representation of stamps or signatures associated with their docusign account. it's particularly useful when you need to display or embed these images in other documents or applications. the endpoint returns the actual image file in gif format, not just metadata. it supports retrieving different types of images (stamp, signature, or initials) and offers an option to include or exclude the chrome (frame) around the image.
Parámetros de entrada
accountIdstringThe 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".
imageTypestringObligatorioSpecifies the type of image to retrieve. This parameter is required and must be one of three valid string values: - "stamp_image": Retrieves the image of an account stamp. - "signature_image": Retrieves the image of a signature. - "initials_image": Retrieves the image of initials. The choice depends on which type of visual element you need to obtain.
signatureIdstringObligatorioThe 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".
include_chromestringAn optional boolean parameter that determines whether to include the chrome (frame) around the signature image. When set to "true", the returned image will include additional visual elements such as a border or identifying text. When "false" or omitted, only the core image is returned. This parameter allows for flexibility in how the image is presented or used in other contexts. The value should be provided as a string: "true" or "false".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetagentuserauthorizationsDOCUSIGN_GET_AGENT_USER_AUTHORIZATIONSAcciónRetrieves user authorizations for a specified agent user within a docusign account. this endpoint allows you to fetch detailed information about the permissions granted to an agent user to act on behalf of other users in the account. it's particularly useful for managing and auditing user access levels, especially in larger organizations with complex permission structures. the endpoint supports various filtering options and pagination, enabling efficient retrieval of specific authorization data.
DOCUSIGN_GET_AGENT_USER_AUTHORIZATIONSAcciónRetrieves user authorizations for a specified agent user within a docusign account. this endpoint allows you to fetch detailed information about the permissions granted to an agent user to act on behalf of other users in the account. it's particularly useful for managing and auditing user access levels, especially in larger organizations with complex permission structures. the endpoint supports various filtering options and pagination, enabling efficient retrieval of specific authorization data.
Parámetros de entrada
countstringAn optional parameter that specifies the maximum number of results to return in a single API call. This allows for pagination of results when dealing with a large number of authorizations. If omitted, the API will return a default number of results.
userIdstringObligatorioThe unique identifier of the user who is acting as the agent. This parameter is required and must be provided in the path of the API request. It specifies which user"s agent authorizations should be retrieved.
accountIdstringThe 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 specify the context in which the agent user authorizations are being retrieved.
active_onlystringA boolean flag that, when set to true, filters the results to return only active users. When false or omitted, both active and inactive users are included in the results. The default value is false. This parameter is optional and can be used to focus on currently valid authorizations.
permissionsstringAn optional parameter to filter authorizations based on specific permission levels. Valid values include "Send", "Manage", "Sign", and "Edit". Multiple permissions can be specified by separating them with commas. This parameter allows for precise filtering of authorizations based on the granted access levels.
start_positionstringAn optional parameter that specifies the starting position within the total result set from which to begin returning values. This is used for pagination of results. The special value "thumbnail" can be used to return the page image, though the exact behavior of this value is not specified in the schema.
email_substringstringAn optional parameter used to filter returned user records based on their email address. The filter can match a full email address or a substring of an email address. This is useful for narrowing down results when searching for specific users or domains.
user_name_substringstringAn optional parameter used to filter results based on a full or partial user name. The filter does not require wildcard characters and can match any part of the user"s name. This is useful for searching authorizations for specific users when their exact user ID is unknown.
include_closed_usersstringA boolean flag that, when set to true, includes active and scheduled authorizations of closed (inactive) users in the results. The default value is true. This parameter is only applied when active_only is false. It allows for historical data retrieval and auditing of past authorizations.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get api request log settingsDOCUSIGN_GET_API_REQUEST_LOG_SETTINGSAcciónRetrieves the current api request logging settings for the authenticated user in docusign. this endpoint provides information about whether api request logging is enabled, the maximum number of log entries allowed, and the remaining number of entries that can be logged. it is useful for developers and administrators who need to monitor or troubleshoot api usage, manage log storage, or ensure compliance with logging policies. the endpoint should be used when you need to check the current state of api request logging or verify remaining log capacity. it does not modify any settings or create new log entries.
DOCUSIGN_GET_API_REQUEST_LOG_SETTINGSAcciónRetrieves the current api request logging settings for the authenticated user in docusign. this endpoint provides information about whether api request logging is enabled, the maximum number of log entries allowed, and the remaining number of entries that can be logged. it is useful for developers and administrators who need to monitor or troubleshoot api usage, manage log storage, or ensure compliance with logging policies. the endpoint should be used when you need to check the current state of api request logging or verify remaining log capacity. it does not modify any settings or create new log entries.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get bcc email archive configurationsDOCUSIGN_GET_BCC_EMAIL_ARCHIVE_CONFIGURATIONSAcciónRetrieves a list of bcc (blind carbon copy) email archive configurations associated with a specified docusign account. this endpoint allows users to fetch details about email addresses used for archiving docusign-generated emails. it supports pagination for large result sets and provides comprehensive information about each bcc email archive configuration, including its status, creation date, and associated user details. this tool is useful for auditing or managing bcc email archiving settings within a docusign account.
DOCUSIGN_GET_BCC_EMAIL_ARCHIVE_CONFIGURATIONSAcciónRetrieves a list of bcc (blind carbon copy) email archive configurations associated with a specified docusign account. this endpoint allows users to fetch details about email addresses used for archiving docusign-generated emails. it supports pagination for large result sets and provides comprehensive information about each bcc email archive configuration, including its status, creation date, and associated user details. this tool is useful for auditing or managing bcc email archiving settings within a docusign account.
Parámetros de entrada
countstringThe 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.
accountIdstringThe 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.
start_positionstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetbccemailarchivehistoryDOCUSIGN_GET_BCCEMAIL_ARCHIVE_HISTORYAcciónRetrieves 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.
DOCUSIGN_GET_BCCEMAIL_ARCHIVE_HISTORYAcciónRetrieves 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.
Parámetros de entrada
countstringAn 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.
accountIdstringThe 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.
start_positionstringAn 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.
bccEmailArchiveIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get brand logo by typeDOCUSIGN_GET_BRAND_LOGO_BY_TYPEAcciónRetrieves 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.
DOCUSIGN_GET_BRAND_LOGO_BY_TYPEAcciónRetrieves 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.
Parámetros de entrada
brandIdstringObligatorioThe unique identifier for the brand within the specified DocuSign account. Required parameter that determines which specific brand"s logo will be retrieved.
logoTypestringObligatorioSpecifies the type of logo to retrieve. Required parameter with three valid values: "primary", "secondary", or "email". Each type represents a different use case for the logo within the DocuSign platform.
accountIdstringThe 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 brand logo to retrieve.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get brands information for groupDOCUSIGN_GET_BRANDS_INFORMATION_FOR_GROUPAcciónRetrieves 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.
DOCUSIGN_GET_BRANDS_INFORMATION_FOR_GROUPAcciónRetrieves 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.
Parámetros de entrada
groupIdstringObligatorioThe 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.
accountIdstringThe unique identifier for the DocuSign account. This can be either the account"s external number (an integer) or the account ID GUID. It is required to specify which account"s group brands should be retrieved. The accountId must be valid and associated with an existing DocuSign account to which the API user has access.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get bulk send batch statusDOCUSIGN_GET_BULK_SEND_BATCH_STATUSAcciónRetrieves the general status of a specific bulk send batch in docusign. this endpoint provides detailed information about the progress and outcomes of a bulk send operation, including the number of successfully sent envelopes, pending envelopes, and any errors encountered. it's useful for monitoring large-scale document sending operations and identifying issues that may require attention. use this endpoint to track batch progress, verify success rates, or investigate failures in high-volume document workflows.
DOCUSIGN_GET_BULK_SEND_BATCH_STATUSAcciónRetrieves the general status of a specific bulk send batch in docusign. this endpoint provides detailed information about the progress and outcomes of a bulk send operation, including the number of successfully sent envelopes, pending envelopes, and any errors encountered. it's useful for monitoring large-scale document sending operations and identifying issues that may require attention. use this endpoint to track batch progress, verify success rates, or investigate failures in high-volume document workflows.
Parámetros de entrada
accountIdstringThe 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 bulk send batch status should be retrieved.
bulkSendBatchIdstringObligatorioThe unique identifier for the specific bulk send batch whose status is being requested. This parameter is required and must be provided in the path of the API request. It is used to identify the exact batch for which the status information should be retrieved.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get bulk send lists informationDOCUSIGN_GET_BULK_SEND_LISTS_INFORMATIONAcciónRetrieves 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.
DOCUSIGN_GET_BULK_SEND_LISTS_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetdefaultconsumerdisclosureDOCUSIGN_GET_DEFAULT_CONSUMER_DISCLOSUREAcciónRetrieves the default html-formatted electronic record and signature disclosure (ersd) associated with a docusign account. this endpoint is used to obtain the standard disclosure provided by docusign for u.s.-based customers, which is valid only for transactions between u.s.-based parties. it allows retrieval of the disclosure in multiple languages and provides comprehensive details about the ersd, including company information, withdrawal methods, and the full text of the esign agreement.
DOCUSIGN_GET_DEFAULT_CONSUMER_DISCLOSUREAcciónRetrieves the default html-formatted electronic record and signature disclosure (ersd) associated with a docusign account. this endpoint is used to obtain the standard disclosure provided by docusign for u.s.-based customers, which is valid only for transactions between u.s.-based parties. it allows retrieval of the disclosure in multiple languages and provides comprehensive details about the ersd, including company information, withdrawal methods, and the full text of the esign agreement.
Parámetros de entrada
langCodestringAn optional query parameter that specifies the language code for the desired version of the disclosure. Supports a wide range of language codes including "en" for English US, "fr" for French, "de" for German, etc. If not provided, the default language (typically English) will be used. Set to "browser" to automatically detect and use the viewer"s browser language. This parameter allows for localization of the ERSD to suit the recipient"s preferred language.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve the default consumer disclosure. This parameter is required and must be provided in the path of the API request. It should be a valid DocuSign account identifier.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get docusign account contactsDOCUSIGN_GET_DOCUSIGN_ACCOUNT_CONTACTSAcciónRetrieves contact information associated with a docusign account. this endpoint allows users to fetch either a specific contact using the contactid or all contacts if the contactid is omitted. it supports retrieving contacts from both the default docusign address book and connected cloud storage providers. the endpoint is particularly useful for accessing detailed contact information, including personal details, phone numbers, email addresses, notary certifications, and signing group associations. it should be used when needing to access or update contact information within a docusign workflow. note that phone numbers for shared contacts may have limited visibility to users other than the contact creator.
DOCUSIGN_GET_DOCUSIGN_ACCOUNT_CONTACTSAcciónRetrieves contact information associated with a docusign account. this endpoint allows users to fetch either a specific contact using the contactid or all contacts if the contactid is omitted. it supports retrieving contacts from both the default docusign address book and connected cloud storage providers. the endpoint is particularly useful for accessing detailed contact information, including personal details, phone numbers, email addresses, notary certifications, and signing group associations. it should be used when needing to access or update contact information within a docusign workflow. note that phone numbers for shared contacts may have limited visibility to users other than the contact creator.
Parámetros de entrada
accountIdstringThe 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 contacts should be retrieved.
contactIdstringObligatorioThe unique identifier for a specific contact in the account"s address book. While marked as required, omitting this parameter will return all contacts associated with the account. Use this parameter when you need information about a particular contact.
cloud_providerstringAn optional parameter specifying the cloud service from which to retrieve contacts. Valid values are "rooms" for DocuSign Rooms contacts and "docusignCore" (default) for the standard DocuSign address book. This parameter allows integration with different cloud storage providers, expanding the sources of contact information.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetdowngradeplaninfoforaccountDOCUSIGN_GET_DOWNGRADE_PLAN_INFO_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_GET_DOWNGRADE_PLAN_INFO_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 downgrade request information should be retrieved. The value must be a valid DocuSign account identifier.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetelectronicdisclosureforrecipientDOCUSIGN_GET_ELECTRONIC_DISCLOSURE_FOR_RECIPIENTAcciónRetrieves 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.
DOCUSIGN_GET_ELECTRONIC_DISCLOSURE_FOR_RECIPIENTAcciónRetrieves 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.
Parámetros de entrada
langCodestringObligatorio(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. 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`.
accountIdstringThe external account number (int) or account ID GUID. This parameter is required to identify the DocuSign account for which the ERSD is being retrieved. It must be a valid string representing either an integer or a GUID associated with the account.
envelopeIdstringObligatorioThe envelope"s GUID (Globally Unique Identifier). This required parameter specifies the unique identifier of the envelope for which the recipient"s ERSD is being retrieved. It must be a valid GUID string, for example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
recipientIdstringObligatorioA local reference used to map recipients to other objects, such as specific document tabs. This required parameter must be either an integer or a GUID, and it must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of "1". The recipientId is crucial for identifying the specific recipient for whom the ERSD is being retrieved.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetelectronicrecordandsignaturedisclosureDOCUSIGN_GET_ELECTRONIC_RECORD_AND_SIGNATURE_DISCLOSUREAcciónRetrieves 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.
DOCUSIGN_GET_ELECTRONIC_RECORD_AND_SIGNATURE_DISCLOSUREAcciónRetrieves 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.
Parámetros de entrada
langCodestringObligatorioThe language code specifying the desired language version of the disclosure to retrieve. This parameter is required and must be a valid language code string. 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. The language code directly affects the content of the retrieved disclosure, ensuring it"s in the specified language.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetenoteintegrationsettingsDOCUSIGN_GET_ENOTE_INTEGRATION_SETTINGSAcciónRetrieves 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.
DOCUSIGN_GET_ENOTE_INTEGRATION_SETTINGSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get EnvelopeDOCUSIGN_GET_ENVELOPEAcciónGets 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
DOCUSIGN_GET_ENVELOPEAcciónGets 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
Parámetros de entrada
account_idstringObligatorioThe external account number (int) or account ID GUID
envelope_idstringObligatorioThe envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Envelope DocGen Form FieldsDOCUSIGN_GET_ENVELOPE_DOC_GEN_FORM_FIELDSAcciónGiven an envelopeid, this method returns the sender fields found in that envelope's documents. after you retrieve the sender fields, you can use the documentgeneration::updateenvelopedocgenformfields method to populate the fields.
DOCUSIGN_GET_ENVELOPE_DOC_GEN_FORM_FIELDSAcciónGiven an envelopeid, this method returns the sender fields found in that envelope's documents. after you retrieve the sender fields, you can use the documentgeneration::updateenvelopedocgenformfields method to populate the fields.
Parámetros de entrada
account_idstringObligatorioThe external account number (int) or account ID GUID
envelope_idstringObligatorioThe envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Envelope Document FieldsDOCUSIGN_GET_ENVELOPE_DOCUMENT_FIELDSAcciónRetrieves the custom document field information from an existing envelope document. the documentid must be a positive 32-bit signed integer (1 through 2147483647). typically the first document has id 1, the second document id 2, and so on, but you can use any numbering scheme within the valid range.
DOCUSIGN_GET_ENVELOPE_DOCUMENT_FIELDSAcciónRetrieves the custom document field information from an existing envelope document. the documentid must be a positive 32-bit signed integer (1 through 2147483647). typically the first document has id 1, the second document id 2, and so on, but you can use any numbering scheme within the valid range.
Parámetros de entrada
account_idstringObligatorioThe external account number (int) or account ID GUID
document_idstringObligatorioThe unique ID of the document within the envelope. Must be between 1 and 2147483647. Typically the first document has ID 1, second has ID 2, etc.
envelope_idstringObligatorioThe envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get envelope lock informationDOCUSIGN_GET_ENVELOPE_LOCK_INFORMATIONAcciónRetrieves 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.
DOCUSIGN_GET_ENVELOPE_LOCK_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetenvelopenotificationdefaultsDOCUSIGN_GET_ENVELOPE_NOTIFICATION_DEFAULTSAcciónRetrieves the default email notification settings for envelopes in a docusign account. this endpoint provides a comprehensive overview of the notification preferences for both senders and signers, covering various events in the envelope lifecycle such as envelope completion, delivery failures, and signer changes. it's particularly useful when setting up a new account or reviewing existing notification configurations to ensure optimal communication with all parties involved in the signing process. the returned settings serve as a template for envelope-specific notifications but can be overridden on a per-envelope basis if needed.
DOCUSIGN_GET_ENVELOPE_NOTIFICATION_DEFAULTSAcciónRetrieves the default email notification settings for envelopes in a docusign account. this endpoint provides a comprehensive overview of the notification preferences for both senders and signers, covering various events in the envelope lifecycle such as envelope completion, delivery failures, and signer changes. it's particularly useful when setting up a new account or reviewing existing notification configurations to ensure optimal communication with all parties involved in the signing process. the returned settings serve as a template for envelope-specific notifications but can be overridden on a per-envelope basis if needed.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the account"s external number (int) or the account ID GUID. It is required to specify which account"s default notification settings should be retrieved. The accountId must be associated with your DocuSign credentials to access the settings.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetenvelopeworkflowdefinitionDOCUSIGN_GET_ENVELOPE_WORKFLOW_DEFINITIONAcciónRetrieves 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.
DOCUSIGN_GET_ENVELOPE_WORKFLOW_DEFINITIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetenvelopeworkflowdelayedroutingdefinitionDOCUSIGN_GET_ENVELOPE_WORKFLOW_DELAYED_ROUTING_DEFINITIONAcciónRetrieves 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.
DOCUSIGN_GET_ENVELOPE_WORKFLOW_DELAYED_ROUTING_DEFINITIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetgroupsinformationforaccountDOCUSIGN_GET_GROUPS_INFORMATION_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_GET_GROUPS_INFORMATION_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
accountIdstringThe 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.
group_typestringFilters 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.
search_textstringA 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.
start_positionstringThe 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.
include_usercountstringA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetlistofaccountpermissionprofilesDOCUSIGN_GET_LIST_OF_ACCOUNT_PERMISSION_PROFILESAcciónThis 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.
DOCUSIGN_GET_LIST_OF_ACCOUNT_PERMISSION_PROFILESAcciónThis 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.
Parámetros de entrada
includestringAn 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.
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get members of a signing groupDOCUSIGN_GET_MEMBERS_OF_A_SIGNING_GROUPAcciónRetrieves 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.
DOCUSIGN_GET_MEMBERS_OF_A_SIGNING_GROUPAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 Signing Group belongs to. For example: "7215091" or "f0f9781e-a546-4ca0-aa1c-0e878c61b64d".
signingGroupIdstringObligatorioThe 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: "group_123456" or "custom_group_name".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetnotaryjurisdictionobjectDOCUSIGN_GET_NOTARY_JURISDICTION_OBJECTAcciónRetrieves 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.
DOCUSIGN_GET_NOTARY_JURISDICTION_OBJECTAcciónRetrieves 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.
Parámetros de entrada
jurisdictionIdstringObligatorioThe unique identifier for the notary jurisdiction. Must be a string representing one of the supported jurisdiction IDs. Valid values range from 5 to 62, corresponding to specific U.S. states or special jurisdictions (e.g., "5" for California, "62" for Florida Commissioner of Deeds). The parameter is required and must match a jurisdiction the notary is registered for. Example: "9" for Florida.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get notary jurisdictions for userDOCUSIGN_GET_NOTARY_JURISDICTIONS_FOR_USERAcciónRetrieves a list of notary journals for a user in the docusign system. this endpoint allows users to fetch detailed information about notary sessions, including creation dates, document names, jurisdiction details, and signer information. it's particularly useful for notaries who need to review their past notarizations or for administrators managing notary activities. the endpoint supports pagination and filtering, making it efficient for handling large sets of journal entries.
DOCUSIGN_GET_NOTARY_JURISDICTIONS_FOR_USERAcciónRetrieves a list of notary journals for a user in the docusign system. this endpoint allows users to fetch detailed information about notary sessions, including creation dates, document names, jurisdiction details, and signer information. it's particularly useful for notaries who need to review their past notarizations or for administrators managing notary activities. the endpoint supports pagination and filtering, making it efficient for handling large sets of journal entries.
Parámetros de entrada
countstringThe maximum number of results to return in a single response. This parameter is optional and helps control the size of the response, especially when dealing with large numbers of journal entries. If not specified, the API will return a default number of results. Use this parameter in conjunction with "start_position" for effective pagination.
search_textstringAn optional parameter used to filter the results based on specific text. The search is performed across various fields of the notary journal entries, such as document names or signer names. This allows for more targeted retrieval of journal entries. The search is case-insensitive and matches partial text within fields.
start_positionstringSpecifies the starting position within the total result set from which to begin returning values. This parameter is optional and works in conjunction with "count" for pagination. It can be a numeric value representing the index of the first item to return. Additionally, the special value "thumbnail" can be used to return the page image, though the exact behavior of this option is not fully specified in the schema.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetnotaryusersettingsDOCUSIGN_GET_NOTARY_USER_SETTINGSAcciónRetrieves the settings and information for the currently authenticated notary user in the docusign system. this endpoint provides comprehensive details about the notary's account configuration, including personal information, user settings, and optionally, information about supported jurisdictions. it should be used when detailed information about a notary user's account and capabilities is required, such as during account management or when verifying a notary's jurisdictional authority. the endpoint is specifically designed for notary users and will not work for regular docusign users. it's important to note that the response contains sensitive information, so proper authorization and security measures should be in place when using this endpoint.
DOCUSIGN_GET_NOTARY_USER_SETTINGSAcciónRetrieves the settings and information for the currently authenticated notary user in the docusign system. this endpoint provides comprehensive details about the notary's account configuration, including personal information, user settings, and optionally, information about supported jurisdictions. it should be used when detailed information about a notary user's account and capabilities is required, such as during account management or when verifying a notary's jurisdictional authority. the endpoint is specifically designed for notary users and will not work for regular docusign users. it's important to note that the response contains sensitive information, so proper authorization and security measures should be in place when using this endpoint.
Parámetros de entrada
include_jurisdictionsstringA boolean flag that determines whether to include detailed information about supported jurisdictions in the response. When set to "true", the response will include a "jurisdiction" property containing an array of all supported jurisdictions for the current notary user. This parameter is optional, and if not provided, jurisdiction information may not be included in the response. Example: "true"
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetoriginalhtmldefinitionfortemplateDOCUSIGN_GET_ORIGINAL_HTML_DEFINITION_FOR_TEMPLATEAcciónRetrieves 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.
DOCUSIGN_GET_ORIGINAL_HTML_DEFINITION_FOR_TEMPLATEAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. 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".
templateIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetpageimagefromenvelopeDOCUSIGN_GET_PAGE_IMAGE_FROM_ENVELOPEAcciónRetrieves 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.
DOCUSIGN_GET_PAGE_IMAGE_FROM_ENVELOPEAcciónRetrieves 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.
Parámetros de entrada
dpistringAn 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.
accountIdstringThe 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 correct account"s envelopes and documents.
max_widthstringAn 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
max_heightstringAn 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.
pageNumberstringObligatorioThe 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.
show_changesstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetpdftranscriptofenvelopecommentsDOCUSIGN_GET_PDFTRANSCRIPT_OF_ENVELOPE_COMMENTSAcciónRetrieves a pdf transcript containing all comments added by senders and recipients to documents within a specific envelope in a docusign account. this endpoint is useful for obtaining a comprehensive record of all discussions and annotations related to the documents in an envelope. it should be used when a consolidated view of all comments is needed, such as for review, auditing, or record-keeping purposes. the response is a pdf file returned as a byte stream, which can be saved or processed as needed. note that the comments feature must be enabled in the account settings (set 'enablesigningextensioncomments' to true in accountsettingsinformation) for this endpoint to function. this tool does not provide individual comments or allow for adding or modifying comments.
DOCUSIGN_GET_PDFTRANSCRIPT_OF_ENVELOPE_COMMENTSAcciónRetrieves a pdf transcript containing all comments added by senders and recipients to documents within a specific envelope in a docusign account. this endpoint is useful for obtaining a comprehensive record of all discussions and annotations related to the documents in an envelope. it should be used when a consolidated view of all comments is needed, such as for review, auditing, or record-keeping purposes. the response is a pdf file returned as a byte stream, which can be saved or processed as needed. note that the comments feature must be enabled in the account settings (set 'enablesigningextensioncomments' to true in accountsettingsinformation) for this endpoint to function. this tool does not provide individual comments or allow for adding or modifying comments.
Parámetros de entrada
encodingstringAn 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.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to specify which account"s envelope to retrieve comments from.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetpermissionprofileforaccountDOCUSIGN_GET_PERMISSION_PROFILE_FOR_ACCOUNTAcciónThis endpoint retrieves detailed information about a specific permission profile in a docusign account. it provides a comprehensive view of permissions, settings, and capabilities assigned to a profile. useful for auditing or reviewing permissions granted to user groups, it returns data on account role settings, user settings, api access levels, and other configuration options. note that this endpoint is read-only and cannot modify profile settings.
DOCUSIGN_GET_PERMISSION_PROFILE_FOR_ACCOUNTAcciónThis endpoint retrieves detailed information about a specific permission profile in a docusign account. it provides a comprehensive view of permissions, settings, and capabilities assigned to a profile. useful for auditing or reviewing permissions granted to user groups, it returns data on account role settings, user settings, api access levels, and other configuration options. note that this endpoint is read-only and cannot modify profile settings.
Parámetros de entrada
includestringAn 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"
accountIdstringThe unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID (a string). It is required to specify which account"s permission profile you want to retrieve. For example: "12345" or "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p".
permissionProfileIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get powerform sendersDOCUSIGN_GET_POWER_FORM_SENDERSAcciónRetrieves 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.
DOCUSIGN_GET_POWER_FORM_SENDERSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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".
start_positionstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetrecipientdocumentvisibilityDOCUSIGN_GET_RECIPIENT_DOCUMENT_VISIBILITYAcciónRetrieves 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.
DOCUSIGN_GET_RECIPIENT_DOCUMENT_VISIBILITYAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
recipientIdstringObligatorioA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get request logging log fileDOCUSIGN_GET_REQUEST_LOGGING_LOG_FILEAcciónRetrieves detailed information for a single api request log entry from docusign's diagnostics service. this endpoint is crucial for debugging and troubleshooting api interactions. it returns the complete request and response data for a specific api call. the log entry can be retrieved as a base64 encoded string or binary data, controlled by the content-transfer-encoding header. use this endpoint to investigate specific api calls, understand errors, or verify exchanged data during docusign api interactions.
DOCUSIGN_GET_REQUEST_LOGGING_LOG_FILEAcciónRetrieves detailed information for a single api request log entry from docusign's diagnostics service. this endpoint is crucial for debugging and troubleshooting api interactions. it returns the complete request and response data for a specific api call. the log entry can be retrieved as a base64 encoded string or binary data, controlled by the content-transfer-encoding header. use this endpoint to investigate specific api calls, understand errors, or verify exchanged data during docusign api interactions.
Parámetros de entrada
requestLogIdstringObligatorioThe 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 a separate endpoint). The requestLogId is required and must be provided as a path parameter. It should be a string value that corresponds to a valid log entry in the DocuSign system.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get signature information for recipientDOCUSIGN_GET_SIGNATURE_INFORMATION_FOR_RECIPIENTAcciónRetrieves detailed signature information for a specific signer or sign-in-person recipient within a docusign envelope. this endpoint provides comprehensive data about the recipient's signature, including the signature image, adoption date, various properties, and associated metadata. it's particularly useful when you need to access or verify a recipient's signature details after they have signed a document or when you want to retrieve the current state of a recipient's signature within an ongoing envelope process. the endpoint returns a rich set of information, including the base64-encoded signature image, signature type, stamp properties, and related timestamps. this tool should be used when detailed signature information is required for auditing, verification, or display purposes within your application. note that this endpoint focuses solely on signature information and does not provide other envelope or recipient status details.
DOCUSIGN_GET_SIGNATURE_INFORMATION_FOR_RECIPIENTAcciónRetrieves detailed signature information for a specific signer or sign-in-person recipient within a docusign envelope. this endpoint provides comprehensive data about the recipient's signature, including the signature image, adoption date, various properties, and associated metadata. it's particularly useful when you need to access or verify a recipient's signature details after they have signed a document or when you want to retrieve the current state of a recipient's signature within an ongoing envelope process. the endpoint returns a rich set of information, including the base64-encoded signature image, signature type, stamp properties, and related timestamps. this tool should be used when detailed signature information is required for auditing, verification, or display purposes within your application. note that this endpoint focuses solely on signature information and does not provide other envelope or recipient status details.
Parámetros de entrada
accountIdstringThe 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 and recipient belong to.
envelopeIdstringObligatorioThe 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.
recipientIdstringObligatorioThe unique identifier for the recipient within the specified envelope. This can be either an integer 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get signing group informationDOCUSIGN_GET_SIGNING_GROUP_INFORMATIONAcciónRetrieves comprehensive information about a specific signing group, including details about its members. this endpoint is essential for managing and auditing signing groups within a docusign account. it provides valuable data such as the group's creation date, email, name, type, and a list of all members with their respective email addresses and usernames. use this endpoint when you need to inspect the composition and properties of a particular signing group, which is crucial for maintaining accurate records and ensuring proper configuration of e-signature workflows involving group-based signers. the endpoint is particularly useful for administrative tasks, troubleshooting, or when integrating signing group functionality into custom applications. note that this endpoint only returns information for 'sharedsigninggroup' types and does not modify any existing data.
DOCUSIGN_GET_SIGNING_GROUP_INFORMATIONAcciónRetrieves comprehensive information about a specific signing group, including details about its members. this endpoint is essential for managing and auditing signing groups within a docusign account. it provides valuable data such as the group's creation date, email, name, type, and a list of all members with their respective email addresses and usernames. use this endpoint when you need to inspect the composition and properties of a particular signing group, which is crucial for maintaining accurate records and ensuring proper configuration of e-signature workflows involving group-based signers. the endpoint is particularly useful for administrative tasks, troubleshooting, or when integrating signing group functionality into custom applications. note that this endpoint only returns information for 'sharedsigninggroup' types and does not modify any existing data.
Parámetros de entrada
accountIdstringThe 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 signing group information is being requested. It must be a valid string representation of either an integer or a GUID.
signingGroupIdstringObligatorioThe unique identifier of the signing group for which information is being requested. This parameter is required and must be a valid string representing the ID of an existing signing group within the specified account. The signing group ID can be obtained from previous API calls or from the DocuSign web interface.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetspecificbrandresourcefileDOCUSIGN_GET_SPECIFIC_BRAND_RESOURCE_FILEAcciónRetrieves a specific branding resource file for customizing docusign experiences. this endpoint allows users to access and manage brand resource files that control sending, signing, email, and captive (embedded) signing experiences. it's particularly useful when you need to retrieve customized branding elements or the master resource file for a specific brand within an account. the endpoint supports localization and can return either the full master resource file or only the modified elements, depending on the parameters used. note that this endpoint requires branding to be enabled for the account (either for sending, signing, or both).
DOCUSIGN_GET_SPECIFIC_BRAND_RESOURCE_FILEAcciónRetrieves a specific branding resource file for customizing docusign experiences. this endpoint allows users to access and manage brand resource files that control sending, signing, email, and captive (embedded) signing experiences. it's particularly useful when you need to retrieve customized branding elements or the master resource file for a specific brand within an account. the endpoint supports localization and can return either the full master resource file or only the modified elements, depending on the parameters used. note that this endpoint requires branding to be enabled for the account (either for sending, signing, or both).
Parámetros de entrada
brandIdstringObligatorioThe unique identifier for the specific brand within the account. This parameter is required and determines which brand"s resources will be retrieved. Each brand in DocuSign has its own set of customizable resources.
langcodestringAn optional parameter that specifies the language for the brand resources. It uses ISO 3166-1 alpha-2 codes to identify the desired language. For example, "en" for English, "fr" for French, "de" for German. If not provided, the default language for the brand will be used. This parameter allows for localization of branding resources.
accountIdstringThe 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 helps identify which account"s brand resources are being accessed.
return_masterstringAn optional parameter that determines which resource file data to return. It accepts a string value that is interpreted as a boolean: - When set to "true", only the master resource file is returned. - When set to "false" or not provided, only the elements that have been modified are returned. This parameter is useful for comparing customized elements against the master file or retrieving the full set of resources.
resourceContentTypestringObligatorioSpecifies the type of brand resource file to return. This parameter is required and must be one of the following values: - "sending": Resources related to the document sending experience - "signing": Resources for the standard signing experience - "email": Resources for email communications - "signing_captive": Resources for the embedded (captive) signing experience The value chosen determines which specific set of branding resources will be returned.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetspecifiedaccountstampinfoDOCUSIGN_GET_SPECIFIED_ACCOUNT_STAMP_INFOAcciónRetrieves 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.
DOCUSIGN_GET_SPECIFIED_ACCOUNT_STAMP_INFOAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID (Globally Unique Identifier). It is a required parameter and must be provided to specify which account the signature belongs to. The format depends on the type of identifier used by your system to reference DocuSign accounts.
signatureIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetsupportedlanguagesforrecipientsDOCUSIGN_GET_SUPPORTED_LANGUAGES_FOR_RECIPIENTSAcciónRetrieves 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.
DOCUSIGN_GET_SUPPORTED_LANGUAGES_FOR_RECIPIENTSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 supported languages are being queried. The accountId must be valid and associated with your API integration to successfully retrieve the language list.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GettabsblobforenvelopeDOCUSIGN_GET_TABS_BLOB_FOR_ENVELOPEAcciónThis 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.
DOCUSIGN_GET_TABS_BLOB_FOR_ENVELOPEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GettabsettingsforaccountDOCUSIGN_GET_TAB_SETTINGS_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_GET_TAB_SETTINGS_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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). It is required to specify which account"s tab settings are being retrieved. The value must be a valid account identifier associated with the API credentials being used.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplateDOCUSIGN_GET_TEMPLATEAcciónGets a template definition from the specified account. you can include additional template attributes in the response by using the include parameter: - powerforms: includes information about powerforms - tabs: includes information about tabs - documents: includes information about documents - favorite template status: includes the template favoritedbyme property
DOCUSIGN_GET_TEMPLATEAcciónGets a template definition from the specified account. you can include additional template attributes in the response by using the include parameter: - powerforms: includes information about powerforms - tabs: includes information about tabs - documents: includes information about documents - favorite template status: includes the template favoritedbyme property
Parámetros de entrada
includestringComma-separated list of additional template attributes to include: powerforms, tabs, documents, favorite_template_status
account_idstringObligatorioThe external account number (int) or account ID GUID
template_idstringObligatorioThe ID of the template
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get template delayed routing rulesDOCUSIGN_GET_TEMPLATE_DELAYED_ROUTING_RULESAcciónRetrieves 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.
DOCUSIGN_GET_TEMPLATE_DELAYED_ROUTING_RULESAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 template and workflow step to query. The accountId must be valid and associated with your DocuSign integration.
templateIdstringObligatorioThe 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.
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GettemplatedocumenthtmldefinitionDOCUSIGN_GET_TEMPLATE_DOCUMENT_HTML_DEFINITIONAcciónRetrieves 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.
DOCUSIGN_GET_TEMPLATE_DOCUMENT_HTML_DEFINITIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the template and document.
documentIdstringObligatorioThe unique ID of the document within the envelope. 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 link tab objects to specific documents.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get template lock informationDOCUSIGN_GET_TEMPLATE_LOCK_INFORMATIONAcciónRetrieves general information about a template lock in docusign. this endpoint allows users to obtain details about an existing lock on a specific template, including the lock duration, the user who applied the lock, the expiration date, and the unique lock token. it is particularly useful for recovering lock information when a user needs to manage or update a locked template. the endpoint should be used when a user needs to verify the status of a template lock or retrieve the lock token for subsequent operations. it's important to note that only the user who initially locked the template can request this information, ensuring security and preventing unauthorized access to lock details. the response includes the x-docusign-edit header, which provides additional context about the lock.
DOCUSIGN_GET_TEMPLATE_LOCK_INFORMATIONAcciónRetrieves general information about a template lock in docusign. this endpoint allows users to obtain details about an existing lock on a specific template, including the lock duration, the user who applied the lock, the expiration date, and the unique lock token. it is particularly useful for recovering lock information when a user needs to manage or update a locked template. the endpoint should be used when a user needs to verify the status of a template lock or retrieve the lock token for subsequent operations. it's important to note that only the user who initially locked the template can request this information, ensuring security and preventing unauthorized access to lock details. the response includes the x-docusign-edit header, which provides additional context about the lock.
Parámetros de entrada
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get template notification informationDOCUSIGN_GET_TEMPLATE_NOTIFICATION_INFORMATIONAcciónRetrieves 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.
DOCUSIGN_GET_TEMPLATE_NOTIFICATION_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get template recipient document visibilityDOCUSIGN_GET_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis endpoint retrieves document visibility information for a specific recipient of a docusign template. it allows users to check which documents within the template are visible to the recipient and what access rights (read-only or editable) they have for each document. this tool is essential for managing document access and permissions in complex signing workflows, ensuring that sensitive information is only shared with the appropriate recipients. the endpoint returns a list of documentvisibility objects, providing detailed information about each document's visibility and access rights for the specified recipient.
DOCUSIGN_GET_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis endpoint retrieves document visibility information for a specific recipient of a docusign template. it allows users to check which documents within the template are visible to the recipient and what access rights (read-only or editable) they have for each document. this tool is essential for managing document access and permissions in complex signing workflows, ensuring that sensitive information is only shared with the appropriate recipients. the endpoint returns a list of documentvisibility objects, providing detailed information about each document's visibility and access rights for the specified recipient.
Parámetros de entrada
accountIdstringThe 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. The accountId must be valid and associated with an active DocuSign account.
templateIdstringObligatorioThe 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.
recipientIdstringObligatorioA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get template scheduled sending settingsDOCUSIGN_GET_TEMPLATE_SCHEDULED_SENDING_SETTINGSAcciónRetrieves 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.
DOCUSIGN_GET_TEMPLATE_SCHEDULED_SENDING_SETTINGSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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).
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get templates for envelope documentDOCUSIGN_GET_TEMPLATES_FOR_ENVELOPE_DOCUMENTAcciónRetrieves 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.
DOCUSIGN_GET_TEMPLATES_FOR_ENVELOPE_DOCUMENTAcciónRetrieves 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.
Parámetros de entrada
includestringA 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".
accountIdstringThe external account number (int) or account ID GUID. This parameter uniquely identifies the DocuSign account for which the operation is being performed. It is required and must be a valid account identifier within your DocuSign environment.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get templates used in envelopeDOCUSIGN_GET_TEMPLATES_USED_IN_ENVELOPEAcciónThis 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.
DOCUSIGN_GET_TEMPLATES_USED_IN_ENVELOPEAcciónThis 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.
Parámetros de entrada
includestringAn 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.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to specify which account"s envelope templates should be retrieved.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get unsupported file types listDOCUSIGN_GET_UNSUPPORTED_FILE_TYPES_LISTAcciónRetrieves a comprehensive list of file types (both mime-types and file extensions) that are not supported for upload through the docusign system. this endpoint is crucial for developers and users who need to understand which file formats cannot be processed by docusign, helping to prevent errors and improve the efficiency of document uploads. use this endpoint when you need to validate file types before attempting to upload documents to docusign, or when creating user interfaces that guide users on acceptable file formats. the returned list can be used to implement client-side validation or to provide informative messages to users about unsupported file types. note that this list may change over time as docusign updates its supported file types, so it's recommended to check periodically for any updates.
DOCUSIGN_GET_UNSUPPORTED_FILE_TYPES_LISTAcciónRetrieves a comprehensive list of file types (both mime-types and file extensions) that are not supported for upload through the docusign system. this endpoint is crucial for developers and users who need to understand which file formats cannot be processed by docusign, helping to prevent errors and improve the efficiency of document uploads. use this endpoint when you need to validate file types before attempting to upload documents to docusign, or when creating user interfaces that guide users on acceptable file formats. the returned list can be used to implement client-side validation or to provide informative messages to users about unsupported file types. note that this list may change over time as docusign updates its supported file types, so it's recommended to check periodically for any updates.
Parámetros de entrada
accountIdstringThe 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 retrieve the unsupported file types list specific to the account. The value should be a valid DocuSign account identifier, either in the form of a numeric ID or a GUID string.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GeturlforembeddingdocusignuiDOCUSIGN_GET_URLFOR_EMBEDDING_DOCUSIGN_UIAcciónThis endpoint returns a url that enables embedding the docusign ui in your applications, providing seamless integration of electronic signing capabilities. it's primarily used to generate console views or sender views based on the provided parameters. the endpoint requires an accountid and optionally accepts an envelopeid and returnurl in the request body. when an envelopeid is provided, the behavior varies: 1. for sent envelopes, it returns a url for viewing envelope documents. 2. for draft envelopes, it returns a url for the sender view, with an optional returnurl for redirection. 3. if no envelopeid is specified, it returns a url for the front page of the demo ui. this endpoint provides full access to the sending account, so it should be used cautiously and securely. it's ideal for scenarios where you need to embed docusign functionality directly within your application's interface, enhancing user experience and workflow efficiency.
DOCUSIGN_GET_URLFOR_EMBEDDING_DOCUSIGN_UIAcciónThis endpoint returns a url that enables embedding the docusign ui in your applications, providing seamless integration of electronic signing capabilities. it's primarily used to generate console views or sender views based on the provided parameters. the endpoint requires an accountid and optionally accepts an envelopeid and returnurl in the request body. when an envelopeid is provided, the behavior varies: 1. for sent envelopes, it returns a url for viewing envelope documents. 2. for draft envelopes, it returns a url for the sender view, with an optional returnurl for redirection. 3. if no envelopeid is specified, it returns a url for the front page of the demo ui. this endpoint provides full access to the sending account, so it should be used cautiously and securely. it's ideal for scenarios where you need to embed docusign functionality directly within your application's interface, enhancing user experience and workflow efficiency.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and must be provided in the path to identify the specific DocuSign account for which the embedded UI URL is being requested.
returnUrlstringThe URL to which the user should be redirected. This is only used when the `envelopeId` is specified as a draft envelope. In this case, the endpoint returns a URL for the sender view. When the user exits the sender view, they will be redirected to the `returnUrl` value. If no value is provided, there is no option to leave the sender view. In other cases, the user is not redirected out of the console view.
envelopeIdstringThe ID of an envelope. If the envelope has been sent, the endpoint returns a URL for a view of the documents. If the envelope has not yet been sent, the endpoint returns a URL for the sender view. This property is optional. If no value is provided, the endpoint returns a URL for the front page of the demo UI.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get user authorization detailsDOCUSIGN_GET_USER_AUTHORIZATION_DETAILSAcciónRetrieves 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.
DOCUSIGN_GET_USER_AUTHORIZATION_DETAILSAcciónRetrieves 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.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the principal user associated with the authorization. This is required and helps to ensure that the correct authorization is being accessed.
accountIdstringThe 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.
authorizationIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetuserauthorizationsforprincipalDOCUSIGN_GET_USER_AUTHORIZATIONS_FOR_PRINCIPALAcciónRetrieves 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.
DOCUSIGN_GET_USER_AUTHORIZATIONS_FOR_PRINCIPALAcciónRetrieves 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.
Parámetros de entrada
countstringSpecifies 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.
userIdstringObligatorioThe 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.
accountIdstringThe 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.
active_onlystringA 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.
permissionsstringFilters 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.
start_positionstringSpecifies 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.
email_substringstringAn 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.
user_name_substringstringAn 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.
include_closed_usersstringA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get user cloud storage provider configurationDOCUSIGN_GET_USER_CLOUD_STORAGE_PROVIDER_CONFIGURATIONAcciónRetrieves the cloud storage provider configuration for a specific user within a docusign account. this endpoint returns a list of enabled cloud storage providers and their configuration details for the specified user. it's useful for integrating cloud storage options into docusign workflows or managing user-specific cloud storage settings. the endpoint is designed for individual user access, meaning users can only retrieve their own configuration information, even if they have admin rights. the response includes authentication urls for providers that require user authentication, making it valuable for setting up or updating cloud storage integrations.
DOCUSIGN_GET_USER_CLOUD_STORAGE_PROVIDER_CONFIGURATIONAcciónRetrieves the cloud storage provider configuration for a specific user within a docusign account. this endpoint returns a list of enabled cloud storage providers and their configuration details for the specified user. it's useful for integrating cloud storage options into docusign workflows or managing user-specific cloud storage settings. the endpoint is designed for individual user access, meaning users can only retrieve their own configuration information, even if they have admin rights. the response includes authentication urls for providers that require user authentication, making it valuable for setting up or updating cloud storage integrations.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
serviceIdstringObligatorioThe identifier for the specific cloud storage service to access. Can be provided as either the service name (e.g., "Box") or the numerical serviceId (e.g., "4136"). Required parameter that determines which cloud storage provider"s configuration to retrieve.
redirectUrlstringOptional 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get user information by idDOCUSIGN_GET_USER_INFORMATION_BY_IDAcciónRetrieves 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.
DOCUSIGN_GET_USER_INFORMATION_BY_IDAcciónRetrieves 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.
Parámetros de entrada
emailstringAn optional parameter that has no effect in this operation. Similar to additional_info, including or excluding the email parameter will not impact the API response or functionality. It can be safely omitted when making requests to this endpoint.
userIdstringObligatorioThe ID of the user to access. This parameter is required and specifies the unique identifier of the user whose information you want to retrieve. It"s important to note that users can only access their own information. Even users with Admin rights cannot access another user"s settings using this endpoint.
accountIdstringThe external account number (int) or account ID GUID. This parameter is required and identifies the specific DocuSign account from which to retrieve user information. It must be a valid account identifier associated with your DocuSign integration.
additional_infostringAn optional parameter that has no effect in this operation. Including or excluding this parameter will not change the response or behavior of the API call. It can be safely omitted when making requests to this endpoint.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get users in groupDOCUSIGN_GET_USERS_IN_GROUPAcciónRetrieves 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.
DOCUSIGN_GET_USERS_IN_GROUPAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
groupIdstringObligatorioThe 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.
accountIdstringThe 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.
start_positionstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetwatermarkdetailsforaccountDOCUSIGN_GET_WATERMARK_DETAILS_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_GET_WATERMARK_DETAILS_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
GetworkflowstepforenvelopeDOCUSIGN_GET_WORKFLOW_STEP_FOR_ENVELOPEAcciónRetrieves detailed information about a specific workflow step for a docusign template. this endpoint allows users to fetch comprehensive data about a single step in a template's workflow, including its action, status, delayed routing settings, and recipient routing rules. it's particularly useful when you need to examine or troubleshoot the configuration of a specific workflow step within a template. the endpoint provides insights into how the step is triggered, its current status, and any conditional routing or delay rules applied to it. use this when you need to understand the exact behavior and settings of a particular workflow step in your docusign template.
DOCUSIGN_GET_WORKFLOW_STEP_FOR_ENVELOPEAcciónRetrieves detailed information about a specific workflow step for a docusign template. this endpoint allows users to fetch comprehensive data about a single step in a template's workflow, including its action, status, delayed routing settings, and recipient routing rules. it's particularly useful when you need to examine or troubleshoot the configuration of a specific workflow step within a template. the endpoint provides insights into how the step is triggered, its current status, and any conditional routing or delay rules applied to it. use this when you need to understand the exact behavior and settings of a particular workflow step in your docusign template.
Parámetros de entrada
accountIdstringThe 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 and workflow step are being accessed. The accountId is essential for multi-account scenarios and ensures that the correct account"s data is retrieved.
templateIdstringObligatorioThe unique identifier for the specific DocuSign template containing the workflow step. This ID is required to locate the correct template within the specified account. It"s typically a GUID or a long string of alphanumeric characters. Use this parameter to ensure you"re accessing the workflow step from the intended template.
workflowStepIdstringObligatorioThe unique identifier for the specific workflow step within the template. This ID is required to pinpoint the exact step you want to retrieve information about. It"s typically a GUID or a long string of alphanumeric characters. Use this parameter to fetch details about a particular step in the template"s workflow sequence.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get workspace fileDOCUSIGN_GET_WORKSPACE_FILEAcciónRetrieves 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.
DOCUSIGN_GET_WORKSPACE_FILEAcciónRetrieves 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.
Parámetros de entrada
fileIdstringObligatorioThe unique identifier of the file within the DocuSign workspace. This required parameter is used to specify which file should be retrieved. The fileId is typically a string of alphanumeric characters (e.g., "abc123def456") assigned by DocuSign when the file was originally uploaded or created in the workspace.
folderIdstringObligatorioThe unique identifier of the folder containing the file within the DocuSign workspace. This required parameter helps navigate the workspace structure to locate the file. The folderId is usually a string of alphanumeric characters (e.g., "folder789") assigned by DocuSign when the folder was created or modified.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to locate the correct account within the DocuSign system. The value should be a string representation of either the numeric account number or the full GUID (e.g., "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6").
is_downloadstringAn 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".
pdf_versionstringAn 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.
workspaceIdstringObligatorioThe unique identifier of the workspace containing the file and folder. This required parameter specifies which workspace to search for the file. The workspaceId is typically a string of alphanumeric characters (e.g., "ws123456") assigned by DocuSign when the workspace was created.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get workspace folder contentsDOCUSIGN_GET_WORKSPACE_FOLDER_CONTENTSAcciónRetrieves 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.
DOCUSIGN_GET_WORKSPACE_FOLDER_CONTENTSAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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. Use in conjunction with "start_position" for pagination. If not specified, the API will return all results.
folderIdstringObligatorioThe 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.
accountIdstringThe external account number (int) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the workspace folder. It must be a valid string representing either an integer or a GUID.
workspaceIdstringObligatorioThe ID of the workspace containing the folder. This parameter is required and must be a valid string representing the unique identifier of the workspace.
include_filesstringWhen set to "true", the response includes file information in addition to folder information. The default value is "false". This optional parameter allows you to control whether file details are included in the response.
start_positionstringThe zero-based index of the result from which to start returning results. This optional parameter is used for pagination in conjunction with "count". The default value is 0. It should be a non-negative integer representing the starting position in the result set.
workspace_user_idstringIf specified, the response only includes results associated with the provided userId. 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.
include_thumbnailsstringWhen set to "true", the response returns thumbnails for the items. The default value is "false". This optional parameter allows you to include thumbnail images in the response, which can be useful for visual representation of files.
include_sub_foldersstringWhen set to "true", the response includes information about the sub-folders of the current folder. The default value is "false". This optional parameter allows you to control whether sub-folder details are included in the response.
include_user_detailstringWhen set to "true", the response includes extended details about the user. The default value is "false". This optional parameter allows you to include additional user information in the response, providing more context about the users associated with the workspace items.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Initiate new chunked uploadDOCUSIGN_INITIATE_NEW_CHUNKED_UPLOADAcciónInitiates 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.
DOCUSIGN_INITIATE_NEW_CHUNKED_UPLOADAcciónInitiates 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.
Parámetros de entrada
datastringA 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.
accountIdstringThe 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.
chunkedUploadIdstringThe ID of the chunked upload. **Note:** This property is ignored in requests, and overridden with an auto-generated value in responses.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Account TemplatesDOCUSIGN_LIST_ALL_TEMPLATESAcciónGets 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.
DOCUSIGN_LIST_ALL_TEMPLATESAcciónGets 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.
Parámetros de entrada
countstringThe maximum number of results to return. Default limit is 2,000 templates if not specified
orderstringSort order: asc (A to Z) or desc (Z to A)
includestringComma-separated list of additional template attributes to include: powerforms, documents, folders, favorite_template_status, advanced_templates, recipients, custom_fields, notifications
to_datestringEnd of search date range in UTC DateTime format. Defaults to current date if null
user_idstringThe ID of the user
order_bystringenumProperty to order results by: name, modified, or used
namemodifiedusedfrom_datestringStart of the search date range. Only returns templates created on or after this date/time
account_idstringObligatorioThe external account number (int) or account ID GUID
folder_idsstringA comma-separated list of folder ID GUIDs
is_downloadstringWhen true, downloads the templates listed in template_ids as JSON definitions in a zip file. Only works with template_ids parameter
search_textstringText to search template names. Max 48 characters
user_filterstringFilter templates: owned_by_me, shared_with_me, or all
folder_typesstringThe type of folder to return templates for. Valid values: templates, templates_root, recylebin
shared_by_mestringWhen true, only includes templates shared by the user. When false, only returns templates not shared by the user
template_idsstringComma-separated list of template IDs to download. Only valid when is_download is true
used_to_datestringEnd of date range. Returns templates used or edited up to this date/time. Defaults to current date
search_fieldsstringComma-separated list of additional properties to search: sender, recipients, envelope
start_positionstringZero-based index of the result from which to start returning results. Default is 0
used_from_datestringStart of date range. Returns templates used or edited on or after this date/time
created_to_datestringLists templates modified before this date
modified_to_datestringLists templates modified before this date
created_from_datestringLists templates created on or after this date
modified_from_datestringLists templates modified on or after this date
is_deleted_template_onlystringWhen true, retrieves templates that have been permanently deleted. Default is false
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List billing invoicesDOCUSIGN_LIST_BILLING_INVOICESAcciónRetrieves 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.
DOCUSIGN_LIST_BILLING_INVOICESAcciónRetrieves 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.
Parámetros de entrada
to_datestringAn 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.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which to retrieve invoices. 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 format.
from_datestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List brands for accountDOCUSIGN_LIST_BRANDS_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_LIST_BRANDS_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
include_logosstringAn 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.
exclude_distributor_brandstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListbulksendbatchsummariesDOCUSIGN_LIST_BULK_SEND_BATCH_SUMMARIESAcciónRetrieves 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.
DOCUSIGN_LIST_BULK_SEND_BATCH_SUMMARIESAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
statusstringFilter 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).
to_datestringThe 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.
user_idstringAn 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.
accountIdstringThe 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.
batch_idsstringAn 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".
from_datestringThe 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.
search_textstringA 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.
start_positionstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListcloudstorageitemsDOCUSIGN_LIST_CLOUD_STORAGE_ITEMSAcciónRetrieves a list of the user's items (files and folders) from a specified cloud storage provider integrated with docusign. this endpoint allows for filtered and paginated access to cloud storage contents, enabling efficient navigation and search of large storage structures. it's particularly useful for applications that need to display or process cloud-stored documents within the docusign ecosystem. the endpoint supports various query parameters for customizing the retrieval process, including sorting, limiting results, and searching by text. note that users can only access their own cloud storage items, ensuring data privacy and security.
DOCUSIGN_LIST_CLOUD_STORAGE_ITEMSAcciónRetrieves a list of the user's items (files and folders) from a specified cloud storage provider integrated with docusign. this endpoint allows for filtered and paginated access to cloud storage contents, enabling efficient navigation and search of large storage structures. it's particularly useful for applications that need to display or process cloud-stored documents within the docusign ecosystem. the endpoint supports various query parameters for customizing the retrieval process, including sorting, limiting results, and searching by text. note that users can only access their own cloud storage items, ensuring data privacy and security.
Parámetros de entrada
countstringAn 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.
orderstringAn 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.
userIdstringObligatorioThe ID of the user whose cloud storage items are being accessed. This is a required parameter. Important: Users can only access their own information. Even users with Admin rights cannot access another user"s settings or data.
folderIdstringObligatorioThe 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.
order_bystringAn 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.
accountIdstringThe external account number (int) or account ID GUID that uniquely identifies the DocuSign account. This is a required parameter and must be provided to identify the correct account context for the operation.
serviceIdstringObligatorioThe 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.
search_textstringAn 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.
start_positionstringAn 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.
cloud_storage_folder_pathstringAn 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.
cloud_storage_folderid_plainstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListenvelopeanddocumentcustomfieldsDOCUSIGN_LIST_ENVELOPE_AND_DOCUMENT_CUSTOM_FIELDSAcciónRetrieves a comprehensive list of envelope and document custom fields associated with a specific docusign account. this endpoint is useful for account administrators who need to review, manage, or analyze the custom fields set up for their organization's docusign workflows. the returned data includes both list custom fields (with predefined options) and text custom fields (for free-form input), providing a complete overview of all custom data points used in the account's envelope processes. this tool should be used when you need to audit existing custom fields, prepare for updates to custom field configurations, or gather information for reporting purposes. it does not allow for the creation, modification, or deletion of custom fields; it is strictly for retrieval of existing field data.
DOCUSIGN_LIST_ENVELOPE_AND_DOCUMENT_CUSTOM_FIELDSAcciónRetrieves a comprehensive list of envelope and document custom fields associated with a specific docusign account. this endpoint is useful for account administrators who need to review, manage, or analyze the custom fields set up for their organization's docusign workflows. the returned data includes both list custom fields (with predefined options) and text custom fields (for free-form input), providing a complete overview of all custom data points used in the account's envelope processes. this tool should be used when you need to audit existing custom fields, prepare for updates to custom field configurations, or gather information for reporting purposes. it does not allow for the creation, modification, or deletion of custom fields; it is strictly for retrieval of existing field data.
Parámetros de entrada
accountIdstringThe 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 used to specify which account"s custom fields should be retrieved.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListenvelopeattachmentsbyenvelopeidDOCUSIGN_LIST_ENVELOPE_ATTACHMENTS_BY_ENVELOPE_IDAcciónRetrieves 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.
DOCUSIGN_LIST_ENVELOPE_ATTACHMENTS_BY_ENVELOPE_IDAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required to authenticate and scope the API request to the correct account. It should be obtained from the account settings or provided by the DocuSign administrator.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List past due invoicesDOCUSIGN_LIST_PAST_DUE_INVOICESAcciónRetrieves 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.
DOCUSIGN_LIST_PAST_DUE_INVOICESAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 past due invoices should be retrieved. For example: "12345" or "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListpaymentgatewayaccountsinfoDOCUSIGN_LIST_PAYMENT_GATEWAY_ACCOUNTS_INFOAcciónRetrieves 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.
DOCUSIGN_LIST_PAYMENT_GATEWAY_ACCOUNTS_INFOAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 DocuSign account"s payment gateway information you want to retrieve. The value must be a valid account identifier associated with your DocuSign integration.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List registered notary jurisdictionsDOCUSIGN_LIST_REGISTERED_NOTARY_JURISDICTIONSAcciónRetrieves 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.
DOCUSIGN_LIST_REGISTERED_NOTARY_JURISDICTIONSAcciónRetrieves 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListresourcesforrestversionspecifiedDOCUSIGN_LIST_RESOURCES_FOR_RESTVERSION_SPECIFIEDAcciónRetrieves the base resources available for the docusign esignature rest api. this endpoint provides developers with a comprehensive list of available api resources and their current configurations without requiring authentication or an integrator key. it's particularly useful for api discovery, allowing developers to understand the capabilities and structure of the esignature api before implementation. the endpoint returns detailed information about each resource, including names, values, and any associated error details, which can be crucial for diagnosing issues or planning api integrations. while it doesn't provide access to user-specific data, it serves as an essential tool for api exploration and troubleshooting.
DOCUSIGN_LIST_RESOURCES_FOR_RESTVERSION_SPECIFIEDAcciónRetrieves the base resources available for the docusign esignature rest api. this endpoint provides developers with a comprehensive list of available api resources and their current configurations without requiring authentication or an integrator key. it's particularly useful for api discovery, allowing developers to understand the capabilities and structure of the esignature api before implementation. the endpoint returns detailed information about each resource, including names, values, and any associated error details, which can be crucial for diagnosing issues or planning api integrations. while it doesn't provide access to user-specific data, it serves as an essential tool for api exploration and troubleshooting.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListsignatureprovidersforaccountDOCUSIGN_LIST_SIGNATURE_PROVIDERS_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_LIST_SIGNATURE_PROVIDERS_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List users for accountDOCUSIGN_LIST_USERS_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_LIST_USERS_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
countstringSpecifies 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.
emailstringFilters 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.
statusstringFilters 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.
group_idstringFilters results based on one or more group IDs.
accountIdstringThe 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.
login_statusstringWhen **true,** the response includes the login status of each user.
not_group_idstringReturn user records excluding the specified group IDs.
start_positionstringSpecifies 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.
additional_infostringA 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.
email_substringstringFilters 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.
domain_users_onlystringWhen **true,** return only users in [domains](https://support.docusign.com/s/document-item?rsc_301=&bundleId=rrf1583359212854&topicId=jub1589318086105.html) claimed by your organization. The default value is **false.**
user_name_substringstringFilters the user records returned by the user name or a sub-string of user name.
alternate_admins_onlystringWhen **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.**
include_usersettings_for_csvstringWhen **true,** the response includes the `userSettings` object data in CSV format.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ListworkspacefilepagesDOCUSIGN_LIST_WORKSPACE_FILE_PAGESAcciónRetrieves 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.
DOCUSIGN_LIST_WORKSPACE_FILE_PAGESAcciónRetrieves 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.
Parámetros de entrada
dpistringThe 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.
countstringThe 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.
fileIdstringObligatorioThe 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.
folderIdstringObligatorioThe 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.
accountIdstringThe 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.
max_widthstringSets 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.
max_heightstringSets 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.
workspaceIdstringObligatorioThe 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.
start_positionstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List workspacesDOCUSIGN_LIST_WORKSPACESAcciónRetrieves a list of docusign workspaces and their associated information for a specified account. this endpoint allows users to get a comprehensive view of all workspaces they have access to, including details such as workspace ids, names, descriptions, creation dates, and user information. it's particularly useful for applications that need to display or manage multiple workspaces, or for auditing purposes to review workspace configurations and user access. the endpoint provides paginated results, allowing for efficient retrieval of large numbers of workspaces.
DOCUSIGN_LIST_WORKSPACESAcciónRetrieves a list of docusign workspaces and their associated information for a specified account. this endpoint allows users to get a comprehensive view of all workspaces they have access to, including details such as workspace ids, names, descriptions, creation dates, and user information. it's particularly useful for applications that need to display or manage multiple workspaces, or for auditing purposes to review workspace configurations and user access. the endpoint provides paginated results, allowing for efficient retrieval of large numbers of workspaces.
Parámetros de entrada
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Lock an envelope for editingDOCUSIGN_LOCK_AN_ENVELOPE_FOR_EDITINGAcciónThis 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.
DOCUSIGN_LOCK_AN_ENVELOPE_FOR_EDITINGAcciónThis 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.
Parámetros de entrada
lockTypestringThe type of lock. Currently `edit` is the only supported type.
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
lockedByAppstringA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
useScratchPadstringWhen **true,** a scratchpad is used to edit information.
templatePasswordstringThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). 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.
lockDurationInSecondsstringThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
LocktemplateforeditingDOCUSIGN_LOCK_TEMPLATE_FOR_EDITINGAcciónThis endpoint locks a specified docusign template for editing, preventing other users or recipients from modifying it during the lock period. it returns a locktoken that must be used in subsequent put requests to update the locked template. the method is crucial for maintaining data integrity in collaborative environments where multiple users might attempt to edit the same template simultaneously. use this endpoint before making any changes to a template to ensure exclusive access. note that the lock has an expiration time, and you must provide the locktoken in the x-docusign-edit header for all update operations while the template is locked.
DOCUSIGN_LOCK_TEMPLATE_FOR_EDITINGAcciónThis endpoint locks a specified docusign template for editing, preventing other users or recipients from modifying it during the lock period. it returns a locktoken that must be used in subsequent put requests to update the locked template. the method is crucial for maintaining data integrity in collaborative environments where multiple users might attempt to edit the same template simultaneously. use this endpoint before making any changes to a template to ensure exclusive access. note that the lock has an expiration time, and you must provide the locktoken in the x-docusign-edit header for all update operations while the template is locked.
Parámetros de entrada
lockTypestringThe type of lock. Currently `edit` is the only supported type.
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
lockedByAppstringA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
useScratchPadstringWhen **true,** a scratchpad is used to edit information.
templatePasswordstringThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). 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.
lockDurationInSecondsstringThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ModifyaccountnotificationsettingsDOCUSIGN_MODIFY_ACCOUNT_NOTIFICATION_SETTINGSAcciónThis endpoint updates the default email notification settings for envelope senders and signers in a docusign account. it allows for extensive customization of when and what type of notifications users receive regarding envelope status changes, comments, and other events. the endpoint is useful for tailoring the docusign experience to an organization's specific needs and communication preferences. it should be used when an account administrator wants to modify the default notification behavior for all users in the account. note that these settings can be overridden at the individual envelope level if needed.
DOCUSIGN_MODIFY_ACCOUNT_NOTIFICATION_SETTINGSAcciónThis endpoint updates the default email notification settings for envelope senders and signers in a docusign account. it allows for extensive customization of when and what type of notifications users receive regarding envelope status changes, comments, and other events. the endpoint is useful for tailoring the docusign experience to an organization's specific needs and communication preferences. it should be used when an account administrator wants to modify the default notification behavior for all users in the account. note that these settings can be overridden at the individual envelope level if needed.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID (a string). It is required to specify which account"s notification settings are being updated. For example: "12345" or "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p".
emailNotifications__signerEmailNotifications__faxReceivedstringReserved for Docusign.
emailNotifications__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
apiEmailNotifications__signerEmailNotifications__faxReceivedstringReserved for Docusign.
emailNotifications__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
emailNotifications__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
emailNotifications__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
emailNotifications__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
emailNotifications__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
apiEmailNotifications__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
emailNotifications__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
emailNotifications__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
emailNotifications__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
emailNotifications__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
emailNotifications__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
apiEmailNotifications__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
apiEmailNotifications__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
apiEmailNotifications__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
apiEmailNotifications__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
emailNotifications__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
emailNotifications__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
apiEmailNotifications__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
emailNotifications__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
emailNotifications__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
emailNotifications__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
apiEmailNotifications__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
apiEmailNotifications__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
apiEmailNotifications__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
apiEmailNotifications__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
apiEmailNotifications__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
apiEmailNotifications__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
apiEmailNotifications__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
emailNotifications__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
emailNotifications__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
apiEmailNotifications__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
apiEmailNotifications__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
apiEmailNotifications__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
emailNotifications__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
emailNotifications__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
emailNotifications__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
apiEmailNotifications__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
apiEmailNotifications__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
emailNotifications__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
apiEmailNotifications__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
apiEmailNotifications__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
apiEmailNotifications__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
apiEmailNotifications__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
emailNotifications__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
emailNotifications__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
emailNotifications__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
apiEmailNotifications__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
apiEmailNotifications__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
apiEmailNotifications__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
emailNotifications__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringemailNotifications__senderEmailNotifications__powerformResponsesLimitNotificationEmailstringapiEmailNotifications__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringapiEmailNotifications__senderEmailNotifications__powerformResponsesLimitNotificationEmailstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Modify tab settings for accountDOCUSIGN_MODIFY_TAB_SETTINGS_FOR_ACCOUNTAcciónThis 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.
DOCUSIGN_MODIFY_TAB_SETTINGS_FOR_ACCOUNTAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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"s tab settings are being modified.
allowTabOrderstringWhen **true,** account users can set a tab order for the signing process. **Note:** Only Admin users can change this setting.
drawTabsEnabledstringlistTabsEnabledstringWhen **true,** list tabs are enabled.
noteTabsEnabledstringWhen **true,** note tabs are enabled.
tabScaleEnabledstringReserved for Docusign.
textTabsEnabledstringWhen **true,** text tabs are enabled.
radioTabsEnabledstringWhen **true,** radio button tabs are enabled.
tabLockingEnabledstringWhen **true,** tab locking is enabled. **Note:** Only Admin users can change this setting.
prefillTabsEnabledstringtabLocationEnabledstringReserved for Docusign.
checkboxTabsEnabledstringWhen **true,** checkbox tabs are enabled.
tabDataLabelEnabledstringWhen **true,** [data labels](https://support.docusign.com/en/videos/Data-Labels) are enabled. **Note:** Only Admin users can change this setting.
dataFieldSizeEnabledstringWhen **true,** setting character limits for input fields is enabled.
numericalTabsEnabledstringdataFieldRegexEnabledstringWhen **true,** regular expressions are enabled for tabs that contain data fields.
calculatedFieldsEnabledstringWhen **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs.
savingCustomTabsEnabledstringWhen **true,** saving custom tabs is enabled.
sharedCustomTabsEnabledstringWhen **true,** shared custom tabs are enabled.
drawTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
drawTabsMetadata__uiHintstringReserved for Docusign.
drawTabsMetadata__uiTypestringReserved for Docusign.
listTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
listTabsMetadata__uiHintstringReserved for Docusign.
listTabsMetadata__uiTypestringReserved for Docusign.
noteTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
noteTabsMetadata__uiHintstringReserved for Docusign.
noteTabsMetadata__uiTypestringReserved for Docusign.
tabScaleMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabScaleMetadata__uiHintstringReserved for Docusign.
tabScaleMetadata__uiTypestringReserved for Docusign.
tabTextFormattingEnabledstringWhen **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.
textTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
textTabsMetadata__uiHintstringReserved for Docusign.
textTabsMetadata__uiTypestringReserved for Docusign.
approveDeclineTabsEnabledstringWhen **true,** approve and decline tabs are enabled.
drawTabsMetadata__optionsstring[]An array of option strings supported by this setting.
drawTabsMetadata__uiOrderstringReserved for Docusign.
enableTabAgreementDetailsstringfirstLastEmailTabsEnabledstringReserved for Docusign.
listTabsMetadata__optionsstring[]An array of option strings supported by this setting.
listTabsMetadata__uiOrderstringReserved for Docusign.
noteTabsMetadata__optionsstring[]An array of option strings supported by this setting.
noteTabsMetadata__uiOrderstringReserved for Docusign.
radioTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
radioTabsMetadata__uiHintstringReserved for Docusign.
radioTabsMetadata__uiTypestringReserved for Docusign.
tabScaleMetadata__optionsstring[]An array of option strings supported by this setting.
tabScaleMetadata__uiOrderstringReserved for Docusign.
textTabsMetadata__optionsstring[]An array of option strings supported by this setting.
textTabsMetadata__uiOrderstringReserved for Docusign.
radioTabsMetadata__optionsstring[]An array of option strings supported by this setting.
radioTabsMetadata__uiOrderstringReserved for Docusign.
tabLockingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabLockingMetadata__uiHintstringReserved for Docusign.
tabLockingMetadata__uiTypestringReserved for Docusign.
prefillTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
prefillTabsMetadata__uiHintstringReserved for Docusign.
prefillTabsMetadata__uiTypestringReserved for Docusign.
tabLocationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabLocationMetadata__uiHintstringReserved for Docusign.
tabLocationMetadata__uiTypestringReserved for Docusign.
tabLockingMetadata__optionsstring[]An array of option strings supported by this setting.
tabLockingMetadata__uiOrderstringReserved for Docusign.
checkBoxTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
checkBoxTabsMetadata__uiHintstringReserved for Docusign.
checkBoxTabsMetadata__uiTypestringReserved for Docusign.
prefillTabsMetadata__optionsstring[]An array of option strings supported by this setting.
prefillTabsMetadata__uiOrderstringReserved for Docusign.
tabDataLabelMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabDataLabelMetadata__uiHintstringReserved for Docusign.
tabDataLabelMetadata__uiTypestringReserved for Docusign.
tabLocationMetadata__optionsstring[]An array of option strings supported by this setting.
tabLocationMetadata__uiOrderstringReserved for Docusign.
allowTabOrderMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowTabOrderMetadata__uiHintstringReserved for Docusign.
allowTabOrderMetadata__uiTypestringReserved for Docusign.
checkBoxTabsMetadata__optionsstring[]An array of option strings supported by this setting.
checkBoxTabsMetadata__uiOrderstringReserved for Docusign.
dataFieldSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
dataFieldSizeMetadata__uiHintstringReserved for Docusign.
dataFieldSizeMetadata__uiTypestringReserved for Docusign.
numericalTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
numericalTabsMetadata__uiHintstringReserved for Docusign.
numericalTabsMetadata__uiTypestringReserved for Docusign.
tabDataLabelMetadata__optionsstring[]An array of option strings supported by this setting.
tabDataLabelMetadata__uiOrderstringReserved for Docusign.
allowTabOrderMetadata__optionsstring[]An array of option strings supported by this setting.
allowTabOrderMetadata__uiOrderstringReserved for Docusign.
dataFieldRegexMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
dataFieldRegexMetadata__uiHintstringReserved for Docusign.
dataFieldRegexMetadata__uiTypestringReserved for Docusign.
dataFieldSizeMetadata__optionsstring[]An array of option strings supported by this setting.
dataFieldSizeMetadata__uiOrderstringReserved for Docusign.
numericalTabsMetadata__optionsstring[]An array of option strings supported by this setting.
numericalTabsMetadata__uiOrderstringReserved for Docusign.
dataFieldRegexMetadata__optionsstring[]An array of option strings supported by this setting.
dataFieldRegexMetadata__uiOrderstringReserved for Docusign.
drawTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
listTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
noteTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabScaleMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
textTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
calculatedFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
calculatedFieldsMetadata__uiHintstringReserved for Docusign.
calculatedFieldsMetadata__uiTypestringReserved for Docusign.
radioTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
savingCustomTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
savingCustomTabsMetadata__uiHintstringReserved for Docusign.
savingCustomTabsMetadata__uiTypestringReserved for Docusign.
sharedCustomTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sharedCustomTabsMetadata__uiHintstringReserved for Docusign.
sharedCustomTabsMetadata__uiTypestringReserved for Docusign.
calculatedFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
calculatedFieldsMetadata__uiOrderstringReserved for Docusign.
savingCustomTabsMetadata__optionsstring[]An array of option strings supported by this setting.
savingCustomTabsMetadata__uiOrderstringReserved for Docusign.
sharedCustomTabsMetadata__optionsstring[]An array of option strings supported by this setting.
sharedCustomTabsMetadata__uiOrderstringReserved for Docusign.
tabLockingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabTextFormattingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabTextFormattingMetadata__uiHintstringReserved for Docusign.
tabTextFormattingMetadata__uiTypestringReserved for Docusign.
approveDeclineTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
approveDeclineTabsMetadata__uiHintstringReserved for Docusign.
approveDeclineTabsMetadata__uiTypestringReserved for Docusign.
firstLastEmailTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
firstLastEmailTabsMetadata__uiHintstringReserved for Docusign.
firstLastEmailTabsMetadata__uiTypestringReserved for Docusign.
prefillTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabLocationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabTextFormattingMetadata__optionsstring[]An array of option strings supported by this setting.
tabTextFormattingMetadata__uiOrderstringReserved for Docusign.
approveDeclineTabsMetadata__optionsstring[]An array of option strings supported by this setting.
approveDeclineTabsMetadata__uiOrderstringReserved for Docusign.
checkBoxTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
firstLastEmailTabsMetadata__optionsstring[]An array of option strings supported by this setting.
firstLastEmailTabsMetadata__uiOrderstringReserved for Docusign.
senderToChangeTabAssignmentsEnabledstringReserved for Docusign.
tabDataLabelMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTabOrderMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
dataFieldSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
numericalTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
dataFieldRegexMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
calculatedFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
savingCustomTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sharedCustomTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabTextFormattingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
approveDeclineTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableTabAgreementDetailsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableTabAgreementDetailsMetadata__uiHintstringReserved for Docusign.
enableTabAgreementDetailsMetadata__uiTypestringReserved for Docusign.
firstLastEmailTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableTabAgreementDetailsMetadata__optionsstring[]An array of option strings supported by this setting.
enableTabAgreementDetailsMetadata__uiOrderstringReserved for Docusign.
senderToChangeTabAssignmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
senderToChangeTabAssignmentsMetadata__uiHintstringReserved for Docusign.
senderToChangeTabAssignmentsMetadata__uiTypestringReserved for Docusign.
senderToChangeTabAssignmentsMetadata__optionsstring[]An array of option strings supported by this setting.
senderToChangeTabAssignmentsMetadata__uiOrderstringReserved for Docusign.
enableTabAgreementDetailsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderToChangeTabAssignmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
PostpaymenttoinvoiceDOCUSIGN_POST_PAYMENT_TO_INVOICEAcciónPosts a payment to a past due invoice in the docusign system. this endpoint is used to process payments for overdue invoices, but only when the 'paymentallowed' value for the invoice is true. it requires account administrator privileges and returns detailed payment information. the endpoint is crucial for managing billing and payments within docusign, ensuring timely settlement of past due accounts. it should be used in conjunction with the 'list invoices past due' endpoint to retrieve eligible invoices and their balances before posting payments.
DOCUSIGN_POST_PAYMENT_TO_INVOICEAcciónPosts a payment to a past due invoice in the docusign system. this endpoint is used to process payments for overdue invoices, but only when the 'paymentallowed' value for the invoice is true. it requires account administrator privileges and returns detailed payment information. the endpoint is crucial for managing billing and payments within docusign, ensuring timely settlement of past due accounts. it should be used in conjunction with the 'list invoices past due' endpoint to retrieve eligible invoices and their balances before posting payments.
Parámetros de entrada
accountIdstringThe 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 payment should be posted to.
paymentAmountstringThe payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Purchase additional envelopesDOCUSIGN_PURCHASE_ADDITIONAL_ENVELOPESAcciónThis 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.
DOCUSIGN_PURCHASE_ADDITIONAL_ENVELOPESAcciónThis 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.
Parámetros de entrada
amountstringThe total amount of the purchase.
appNamestringThe AppName of the client application.
platformstringThe Platform of the client application
quantitystringThe quantity of envelopes to add to the account.
accountIdstringThe 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.
productIdstringThe Product ID from the AppStore.
storeNamestringThe name of the AppStore.
receiptDatastringThe encrypted Base64 encoded receipt data.
currencyCodestringSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.
transactionIdstringSpecifies the Transaction ID from the AppStore.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Queue downgrade billing plan requestDOCUSIGN_QUEUE_DOWNGRADE_BILLING_PLAN_REQUESTAcciónQueues a downgrade request for a docusign account's billing plan. this endpoint allows you to initiate the process of changing an account to a lower-tier or less expensive plan. it's used when an account holder wants to reduce their subscription level or change to a more cost-effective plan. the endpoint processes the request and returns information about the downgrade status, including the effective date and new plan details. note that this action queues the request for processing and does not immediately apply the downgrade.
DOCUSIGN_QUEUE_DOWNGRADE_BILLING_PLAN_REQUESTAcciónQueues a downgrade request for a docusign account's billing plan. this endpoint allows you to initiate the process of changing an account to a lower-tier or less expensive plan. it's used when an account holder wants to reduce their subscription level or change to a more cost-effective plan. the endpoint processes the request and returns information about the downgrade status, including the effective date and new plan details. note that this action queues the request for processing and does not immediately apply the downgrade.
Parámetros de entrada
accountIdstringThe 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 downgrade request applies to. The value must be a valid, existing DocuSign account identifier.
promoCodestringsaleDiscountstringsaleDiscountTypestringdowngradeEventTypestringsaleDiscountPeriodsstringReserved for Docusign.
planInformation__addOnsobject[]Reserved for Docusign.
planInformation__planIdstringDocusign"s ID for the account plan.
planInformation__currencyCodestringSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
planInformation__planFeatureSetsobject[]Reserved for Docusign.
planInformation__recipientDomainsobject[]planInformation__freeTrialDaysOverridestringReserved for Docusign.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RegistercurrentuserasnotaryDOCUSIGN_REGISTER_CURRENT_USER_AS_NOTARYAcciónThis 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.
DOCUSIGN_REGISTER_CURRENT_USER_AS_NOTARYAcciónThis 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.
Parámetros de entrada
enabledstringThe date the this object was created.
searchablestringWhen **true,** this notary is searchable.
createdDatestringThe creation date of the account in UTC timedate format.
userInfo__uristringA URI containing the user ID.
userInfo__emailstringThe user"s email address.
userInfo__titlestringThe title of the user.
userInfo__userIdstringThe 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.
userInfo__companystringThe name of the user"s company.
userInfo__isAdminstringWhen **true,** the user is an administrator.
userInfo__jobTitlestringThe user"s job title.
userInfo__lastNamestringThe user"s last name. Maximum Length: 50 characters.
userInfo__passwordstringThe user"s encrypted password hash.
userInfo__userNamestringThe name of the user.
userInfo__userTypestringThe type of user, for example `CompanyUser`.
userInfo__firstNamestringThe user"s first name. Maximum Length: 50 characters.
userInfo__groupListobject[]A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user"s group, only the `groupId` is required.
userInfo__lastLoginstringThis property has been deprecated.
userInfo__subscribestringuserInfo__middleNamestringThe user"s middle name. Limit: 50 characters.
userInfo__suffixNamestringThe suffix for the user"s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
userInfo__userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
userInfo__countryCodestringThe two-letter code for the user"s country.
userInfo__loginStatusstringBoolean value that indicates whether the user is currently logged in or not.
userInfo__isNAREnabledstringWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
userInfo__customSettingsobject[]The name/value pair information for the user custom setting.
userInfo__createdDateTimestringThe UTC DateTime when the item was created.
userInfo__hasRemoteNotarybooleanuserInfo__profileImageUristringThe URL for retrieving the user"s profile image.
userInfo__defaultAccountIdstringThe default account ID associated with the user.
userInfo__homeAddress__faxstringA fax number associated with the address, if one is available.
userInfo__initialsImageUristringThe URI for retrieving the image of the user"s initials.
userInfo__isAlternateAdminstringWhen **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.
userInfo__workAddress__faxstringA fax number associated with the address, if one is available.
userInfo__homeAddress__citystringThe user"s city. Maximum length: 40 characters.
userInfo__signatureImageUristringAn endpoint URI that you can use to retrieve the user"s signature image.
userInfo__workAddress__citystringThe user"s city. Maximum length: 40 characters.
userInfo__homeAddress__phonestringA phone number associated with the address.
userInfo__passwordExpirationstringIf password expiration is enabled, the date-time when the user"s password expires.
userInfo__workAddress__phonestringA phone number associated with the address.
userInfo__permissionProfileIdstringThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
userInfo__sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
userInfo__activationAccessCodestringAccess code provided to the user to activate the account.
userInfo__enableConnectForUserstringBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
userInfo__homeAddress__countrystringThe user"s country. Maximum length: 50 characters.
userInfo__userSettings__localestringThe user"s locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
userInfo__workAddress__countrystringThe user"s country. Maximum length: 50 characters.
userInfo__connectConfigurationsobject[]Object representing the user"s custom Connect configuration.
userInfo__errorDetails__messagestringA brief message describing the error condition.
userInfo__homeAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userInfo__homeAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userInfo__homeAddress__zipPlus4stringuserInfo__permissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
userInfo__workAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userInfo__workAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userInfo__workAddress__zipPlus4stringuserInfo__userSettings__bulkSendstringWhen **true,** this user can use the bulk send feature for the account.
userInfo__userSettings__webFormsstringuserInfo__errorDetails__errorCodestringThe code associated with the error condition.
userInfo__homeAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userInfo__userSettings__adminOnlystringReserved for Docusign.
userInfo__userSettings__newSendUIstringReserved for Docusign.
userInfo__workAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userInfo__userSettings__modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
userInfo__userSettings__enableDSProstringReserved for Docusign.
userInfo__userSettings__timezoneDSTstringWhen true, daylight savings time is in effect for this user"s time zone.
userInfo__userAddedToAccountDateTimestringThe date and time that the user was added to the account.
userInfo__userSettings__modifiedDatestringThe date on which this user record was last modified.
userInfo__userSettings__modifiedPagestringNote referencing the page that modified this user record.
userInfo__userSettings__timezoneMaskstringThe custom DateTime format setting for this user.
userInfo__userSettings__vaultingModestringIndicates the specified Vaulting mode: - `none` - `estored` - `electronic_original`
userInfo__userProfileLastModifiedDatestringThe date and time that the user"s profile was last modified.
userInfo__userSettings__powerFormModestringIndicates the Power Form mode setting for the user: - `none` - `admin` - `user`
userInfo__homeAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userInfo__sendActivationOnInvalidLoginstringWhen **true,** specifies that an additional activation email be sent if user"s log on fails before the account is activated.
userInfo__userSettings__apiCanExportACstringWhen **true,** this user can export authoritative copy for the account.
userInfo__userSettings__enableVaultingstringWhen **true,** Vaulting is enabled for the account.
userInfo__userSettings__timezoneOffsetstringThe 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`
userInfo__workAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userInfo__userSettings__canSendEnvelopestringWhen **true,** this user can send envelopes on the account.
userInfo__userSettings__canSignEnvelopestringWhen **true,** this user can sign envelopes.
userInfo__userSettings__expressSendOnlystringWhen **false,** this user can apply tabs to documents during the sending experience.
userInfo__userSettings__sealIdentifiersobject[]Information about the seals associated with this user.
userInfo__userSettings__allowAutoTaggingstringWhen **true,** the API returns suggested tabs for documents for this user.
userInfo__userSettings__canChargeAccountstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesstringReserved for Docusign.
userInfo__userSettings__canManageAccountstringWhen **true,** this user is an administrator for the account.
userInfo__userSettings__canUseScratchpadstringWhen **true,** this user can use a scratchpad to edit information.
userInfo__userSettings__allowTransactionsstringuserInfo__userSettings__canManageTemplatesstringWhen **true,** this user can manage templates for the account.
userInfo__userSettings__canSendAPIRequestsstringWhen **true,** this user can send API requests on the account.
userInfo__userSettings__allowSendOnBehalfOfstringWhen **true,** this user can send envelopes "on behalf of" other users through the API.
userInfo__userSettings__disableOtherActionsstringWhen **true,** this user can access the **Other Actions** menu.
userInfo__userSettings__templateApplyNotifystringWhen **true,** the system notifies this user before applying a matching template.
userInfo__userSettings__timezoneSendingPrefstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsstringWhen **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
userInfo__userSettings__apiAccountWideAccessstringWhen **true,** indicates that this user can send envelope-specific API requests on the account.
userInfo__userSettings__canCreateTransactionstringuserInfo__userSettings__canDeleteTransactionstringuserInfo__userSettings__canManageDistributorstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsstringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModestringWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
userInfo__userSettings__templateAutoMatchingstringWhen **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.
userInfo__userSettings__disableDocumentUploadstringWhen **true,** this user is prohibited from uploading documents during sending.
userInfo__userSettings__canSendEnvelopesViaSMSstringuserInfo__userSettings__enableTransactionPointstringReserved for Docusign.
userInfo__userSettings__localeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZonestringSpecifies 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`
userInfo__userSettings__templateActiveCreationstringWhen **true,** a new template is created each time the user sends an envelope.
userInfo__userSettings__allowEnvelopeTransferTostringWhen **true,** this user can participate in envelope transfers on the account.
userInfo__userSettings__canBulkUploadAgreementsstringuserInfo__userSettings__enableSignerAttachmentsstringWhen **true,** this user can use the signing attachments feature.
userInfo__userSettings__localeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__bulkSendMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookstringWhen true, this user can edit the shared address book for the account.
userInfo__userSettings__localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
userInfo__userSettings__localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
userInfo__userSettings__localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
userInfo__userSettings__transactionPointUserNamestringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__webFormsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__adminOnlyMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__bulkSendMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesstringuserInfo__userSettings__enableSequentialSigningUIstringWhen **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.
userInfo__userSettings__enableSignOnPaperOverridestringWhen **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.
userInfo__userSettings__localePolicy__allowRegionstringuserInfo__userSettings__localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
userInfo__userSettings__newSendUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__newSendUIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingstringWhen **true,** users see template matching functionality.
userInfo__userSettings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__webFormsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__adminOnlyMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
userInfo__userSettings__allowedOrchestrationAccessstringuserInfo__userSettings__enableSequentialSigningAPIstringWhen **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.
userInfo__userSettings__localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
userInfo__userSettings__localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
userInfo__userSettings__modifiedByMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedByMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedByMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__newSendUIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypestringuserInfo__userSettings__enableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableDSProMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
userInfo__userSettings__localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
userInfo__userSettings__modifiedByMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedByMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationstringWhen **true,** this user receives notifications when envelopes are viewed.
userInfo__userSettings__templateMatchingSensitivitystringPercentage used when matching templates.
userInfo__userSettings__timezoneDSTMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneDSTMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneDSTMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLstringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableDSProMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatstringThe 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.
userInfo__userSettings__localePolicy__signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
userInfo__userSettings__modifiedDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedDateMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedDateMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedPageMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneDSTMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneDSTMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneMaskMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__vaultingModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__modifiedDateMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedDateMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedPageMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__powerFormModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadstringWhen **true,** this user must both view and accept supplemental documents.
userInfo__userSettings__supplementalDocumentsMustViewstringWhen **true,** this user must view supplemental documents.
userInfo__userSettings__timezoneMaskMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneMaskMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__apiCanExportACMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableVaultingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__customDateFormatstringuserInfo__userSettings__localePolicy__customTimeFormatstringuserInfo__userSettings__powerFormModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__powerFormModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneOffsetMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionstringWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
userInfo__userSettings__apiCanExportACMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__apiCanExportACMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteDocumentsInTransactionstringuserInfo__userSettings__canSendEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSignEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableVaultingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveTimeZonestringuserInfo__userSettings__supplementalDocumentsMustAcceptstringWhen **true,** this user must accept supplemental documents.
userInfo__userSettings__timezoneOffsetMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneOffsetMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__adminOnlyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canChargeAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canChargeAccountMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canLockEnvelopesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageAccountMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSendEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSignEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canUseScratchpadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentstringSets 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.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer1stringThe answer to the first forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer2stringThe answer to the second forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer3stringThe answer to the third forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer4stringThe answer to the fourth forgotten password challenge question.
userInfo__userSettings__allowAccessToAllAccountAgreementsstringuserInfo__userSettings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canChargeAccountMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canLockEnvelopesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageAccountMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canUseScratchpadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveDateFormatstringuserInfo__userSettings__localePolicy__effectiveNameFormatstringuserInfo__userSettings__localePolicy__effectiveTimeFormatstringuserInfo__userSettings__modifiedByMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__anchorTagVersionedPlacementEnabledstringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageTemplatesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendAPIRequestsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__customSignDateFormatstringuserInfo__userSettings__localePolicy__customSignTimeFormatstringuserInfo__userSettings__timezoneDSTMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion1stringThe first challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion2stringThe second challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion3stringThe third challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion4stringThe fourth challenge question presented to a user who has forgotten their password.
userInfo__userSettings__allowSendOnBehalfOfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageTemplatesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendAPIRequestsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveCalendarTypestringuserInfo__userSettings__localePolicy__effectiveCurrencyCodestringuserInfo__userSettings__modifiedDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__modifiedPageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateApplyNotifyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateApplyNotifyMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateApplyNotifyMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__timezoneSendingPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneSendingPrefMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneSigningPrefMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowEsealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowEsealRecipientsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowSendOnBehalfOfMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__apiAccountWideAccessMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageDistributorMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canUseSmartContractsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
userInfo__userSettings__localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
userInfo__userSettings__localePolicy__effectiveAddressFormatstringuserInfo__userSettings__localePolicy__effectiveInitialFormatstringuserInfo__userSettings__manageClickwrapsModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__manageClickwrapsModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateApplyNotifyMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateApplyNotifyMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__templateAutoMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateAutoMatchingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateAutoMatchingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneSendingPrefMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneSigningPrefMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowEsealRecipientsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__apiAccountWideAccessMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageDistributorMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canUseSmartContractsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__manageClickwrapsModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__manageClickwrapsModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__signerEmailNotifications__faxReceivedstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentIncludeInDownloadstringWhen **true,** this user gets supplemental documents when downloading documents.
userInfo__userSettings__templateAutoMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateAutoMatchingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableTransactionPointMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__timeZoneMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateActiveCreationMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canViewUsersstringuserInfo__userSettings__allowEnvelopeTransferToMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canBulkUploadAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canLockEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canManageAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypestringuserInfo__userSettings__enableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveCustomDateFormatstringuserInfo__userSettings__localePolicy__effectiveCustomTimeFormatstringuserInfo__userSettings__localePolicy__timeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__timeZoneMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
userInfo__userSettings__templateActiveCreationMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateActiveCreationMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowEnvelopeTransferToMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canBulkUploadAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canEditSharedAddressbookMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__dateFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__nameFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__timeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
userInfo__userSettings__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userInfo__userSettings__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
userInfo__userSettings__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userInfo__userSettings__transactionPointUserNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__transactionPointUserNameMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersstring**True** if the user can manage users.
userInfo__userSettings__canEditSharedAddressbookMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canEditSharedAddressbookMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageAgreementPartiesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendAPIRequestsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__cultureNameMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__dateFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__nameFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__timeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
userInfo__userSettings__templatePageLevelMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templatePageLevelMatchingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__transactionPointUserNameMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsstring**True** if the user can manage administrators.
userInfo__userSettings__accountManagementGranular__canManageStampsstringuserInfo__userSettings__allowSendOnBehalfOfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageAgreementPartiesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__cultureNameMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userInfo__userSettings__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
userInfo__userSettings__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userInfo__userSettings__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
userInfo__userSettings__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
userInfo__userSettings__templateApplyNotifyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templatePageLevelMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templatePageLevelMatchingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__timezoneSigningPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountAgreementsAccessTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectstringuserInfo__userSettings__accountManagementGranular__canManageSharingstring**True** if the user can manage sharing.
userInfo__userSettings__allowEsealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canManageDistributorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canUseSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__addressFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__initialFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__recipientViewedNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__recipientViewedNotificationMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
userInfo__userSettings__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
userInfo__userSettings__templateAutoMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateMatchingSensitivityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateMatchingSensitivityMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateMatchingSensitivityMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__addressFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__addressFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__initialFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__recipientViewedNotificationMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userInfo__userSettings__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userInfo__userSettings__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
userInfo__userSettings__templateMatchingSensitivityMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateMatchingSensitivityMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingstring**True** if the user can manage reporting.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__effectiveCurrencyNegativeFormatstringuserInfo__userSettings__localePolicy__effectiveCurrencyPositiveFormatstringuserInfo__userSettings__localePolicy__signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowEnvelopeTransferToMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canBulkUploadAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userInfo__userSettings__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__dateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__nameFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__timeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopestringWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__cultureNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
userInfo__userSettings__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
userInfo__userSettings__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsstring**True** if the user can manage signing groups.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__calendarTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__currencyCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__initialFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__recipientViewedNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
userInfo__userSettings__templateMatchingSensitivityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__transactionPointSiteNameURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsstring**True** if the user can manage account settings.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsstringuserInfo__userSettings__localePolicy__signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferstringuserInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionstringuserInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersstringuserInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userInfo__userSettings__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
userInfo__userSettings__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsstring**True** if the user can manage account security settings.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringuserInfo__userSettings__senderEmailNotifications__powerformResponsesLimitNotificationEmailstringuserInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove bulk send listDOCUSIGN_REMOVE_BULK_SEND_LISTAcciónThis endpoint deletes a specific bulk send list from a docusign account. it is used to permanently remove a bulk send list that is no longer needed or was created in error. the operation requires both the account identifier and the specific bulk send list id to ensure precise targeting of the list to be deleted. upon successful deletion, it returns a summary of the remaining bulk send lists associated with the account. this endpoint should be used with caution as the deletion is irreversible. it's particularly useful for maintaining a clean and organized set of bulk send lists, especially in environments where list management is crucial for compliance or efficiency reasons. note that this operation does not affect any envelopes that may have already been sent using the deleted list.
DOCUSIGN_REMOVE_BULK_SEND_LISTAcciónThis endpoint deletes a specific bulk send list from a docusign account. it is used to permanently remove a bulk send list that is no longer needed or was created in error. the operation requires both the account identifier and the specific bulk send list id to ensure precise targeting of the list to be deleted. upon successful deletion, it returns a summary of the remaining bulk send lists associated with the account. this endpoint should be used with caution as the deletion is irreversible. it's particularly useful for maintaining a clean and organized set of bulk send lists, especially in environments where list management is crucial for compliance or efficiency reasons. note that this operation does not affect any envelopes that may have already been sent using the deleted list.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided to specify which account"s bulk send list should be deleted. It can be either a numeric value or a GUID string.
bulkSendListIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RemovegroupsharingpermissionsfortemplateDOCUSIGN_REMOVE_GROUP_SHARING_PERMISSIONS_FOR_TEMPLATEAcciónRemoves 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.
DOCUSIGN_REMOVE_GROUP_SHARING_PERMISSIONS_FOR_TEMPLATEAcciónRemoves 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.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
nextUristringThe 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.
accountIdstringThe 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".
templateIdstringObligatorioThe 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".
endPositionstringThe last index position in the result set.
previousUristringThe 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.
templatePartstringObligatorioSpecifies 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.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RemovetemplatesfromfavoritesDOCUSIGN_REMOVE_TEMPLATES_FROM_FAVORITESAcciónRemoves one or more templates from an account's list of favorite templates in docusign. this endpoint allows users to manage their favorite templates by specifying which templates should no longer be marked as favorites. it accepts an account identifier and a list of template ids to be removed from favorites. the api returns information about the templates that were successfully removed and any errors encountered during the process. this endpoint is particularly useful for maintaining an organized and relevant list of favorite templates, especially when templates are no longer frequently used or needed. note that this api is currently in beta status, which means it may not be fully stable and could be subject to changes in the future.
DOCUSIGN_REMOVE_TEMPLATES_FROM_FAVORITESAcciónRemoves one or more templates from an account's list of favorite templates in docusign. this endpoint allows users to manage their favorite templates by specifying which templates should no longer be marked as favorites. it accepts an account identifier and a list of template ids to be removed from favorites. the api returns information about the templates that were successfully removed and any errors encountered during the process. this endpoint is particularly useful for maintaining an organized and relevant list of favorite templates, especially when templates are no longer frequently used or needed. note that this api is currently in beta status, which means it may not be fully stable and could be subject to changes in the future.
Parámetros de entrada
accountIdstringThe 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.
favoriteTemplatesobject[]The favorite templates acted upon by the call.
errorDetails__messagestringA brief message describing the error condition.
templatesUpdatedCountintegerThe number of templates successfully updated by the call. This property is read-only.
errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove user signature informationDOCUSIGN_REMOVE_USER_SIGNATURE_INFORMATIONAcciónRemoves the signature information for a specific user in docusign. this endpoint should be used when a user wants to delete their existing signature from their docusign account. it's particularly useful for updating or refreshing signature information. the operation is restricted to the authenticated user's own signatures and cannot be used to modify other users' data, even with admin rights. it's important to note that this action is irreversible, so it should be used with caution. the endpoint accepts either a signature id or a signature name, but using the signature id is recommended to avoid url encoding issues.
DOCUSIGN_REMOVE_USER_SIGNATURE_INFORMATIONAcciónRemoves the signature information for a specific user in docusign. this endpoint should be used when a user wants to delete their existing signature from their docusign account. it's particularly useful for updating or refreshing signature information. the operation is restricted to the authenticated user's own signatures and cannot be used to modify other users' data, even with admin rights. it's important to note that this action is irreversible, so it should be used with caution. the endpoint accepts either a signature id or a signature name, but using the signature id is recommended to avoid url encoding issues.
Parámetros de entrada
userIdstringObligatorioThe 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".
accountIdstringThe external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is required and must be a valid account identifier to ensure the operation is performed within the correct account context. For example: "12345" or "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8".
signatureIdstringObligatorioThe 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).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Republish connect data for envelopeDOCUSIGN_REPUBLISH_CONNECT_DATA_FOR_ENVELOPEAcciónRepublishes 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.
DOCUSIGN_REPUBLISH_CONNECT_DATA_FOR_ENVELOPEAcciónRepublishes 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.
Parámetros de entrada
accountIdstringThe 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 envelope belongs to and to ensure the action is performed within the correct account context.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Republish connect info for envelopesDOCUSIGN_REPUBLISH_CONNECT_INFO_FOR_ENVELOPESAcciónRepublishes connect information for a specified set of envelopes in docusign. this endpoint is primarily used to retry failed connect post attempts by providing the envelope ids that previously failed to post correctly. it's designed for account administrators to handle and resolve connect post failures, ensuring that important envelope information is successfully transmitted to integrated systems. the endpoint requires connect to be enabled on the account and returns detailed results of the retry attempts for each envelope.
DOCUSIGN_REPUBLISH_CONNECT_INFO_FOR_ENVELOPESAcciónRepublishes connect information for a specified set of envelopes in docusign. this endpoint is primarily used to retry failed connect post attempts by providing the envelope ids that previously failed to post correctly. it's designed for account administrators to handle and resolve connect post failures, ensuring that important envelope information is successfully transmitted to integrated systems. the endpoint requires connect to be enabled on the account and returns detailed results of the retry attempts for each envelope.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that identifies the DocuSign account. This parameter is required and must be provided in the path of the API request. It"s used to specify which account the Connect republishing operation should be performed on.
envelopeIdsstring[]An array of envelope GUIDs. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
synchronousstringMust be **false.** Setting this property to any other value will result in errors.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountbillingplanDOCUSIGN_RETRIEVE_ACCOUNT_BILLING_PLANAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ACCOUNT_BILLING_PLANAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
include_metadatastringAn optional query parameter that, when set to "true", includes additional metadata in the response. Specifically, it adds the "canUpgrade" and "renewalStatus" properties to the response, as well as an array of "supportedCountries" to the billing address information. This parameter is useful for obtaining extended information about the account"s billing plan capabilities and renewal status.
include_tax_exempt_idstringAn optional query parameter that, when included, likely requests the inclusion of tax exemption identification information in the response. The exact behavior when set to "true" is not specified in the schema, but it presumably returns any tax-exempt ID associated with the account if applicable. When omitted or set to "false", this information is not included in the response.
include_successor_plansstringAn optional query parameter that controls the inclusion of successor plan information in the response. When set to "true", information about plans that the current plan can be upgraded to is included. When set to "false" or omitted, successor plan information is excluded from the response. This parameter is useful for understanding potential upgrade paths for the account.
include_downgrade_informationstringAn optional query parameter that, when included, requests information about potential downgrade options for the account"s billing plan. The exact behavior when set to "true" is not specified in the schema, but it likely includes details about available lower-tier plans or the process of downgrading. When omitted or set to "false", this information is not included in the response.
include_credit_card_informationstringAn optional query parameter that determines whether credit card information should be included in the response. When set to "true", payment information including credit card details will be returned. When set to "false" or omitted, credit card information will be excluded from the response. This parameter is useful for controlling the sensitivity of the information returned, especially in scenarios where credit card details are not needed.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountbrandinformationDOCUSIGN_RETRIEVE_ACCOUNT_BRAND_INFORMATIONAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ACCOUNT_BRAND_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
brandIdstringObligatorioThe 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.
accountIdstringThe unique identifier for the DocuSign account. This can be either the account"s external number (an integer) or the account ID GUID. It is required to specify which account"s brand information is being retrieved. The value must be a non-empty string representing a valid DocuSign account identifier.
include_logosstringAn 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".
include_external_referencesstringAn 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountenvelopepurgeconfigDOCUSIGN_RETRIEVE_ACCOUNT_ENVELOPE_PURGE_CONFIGAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ACCOUNT_ENVELOPE_PURGE_CONFIGAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 envelope purge configuration should be retrieved. The value must be a valid account identifier associated with the authenticated user"s access rights.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountfavoritetemplatesDOCUSIGN_RETRIEVE_ACCOUNT_FAVORITE_TEMPLATESAcciónRetrieves the list of favorite templates associated with a specified docusign account. this endpoint allows users to access their saved favorite templates, which can streamline document creation and signing processes. it's particularly useful for users who frequently work with the same set of templates and want quick access to them. the endpoint is currently in beta, so users should be aware that it may undergo changes or have limitations. it provides template ids, favorited dates, and a count of updated templates, but does not return the full template content.
DOCUSIGN_RETRIEVE_ACCOUNT_FAVORITE_TEMPLATESAcciónRetrieves the list of favorite templates associated with a specified docusign account. this endpoint allows users to access their saved favorite templates, which can streamline document creation and signing processes. it's particularly useful for users who frequently work with the same set of templates and want quick access to them. the endpoint is currently in beta, so users should be aware that it may undergo changes or have limitations. it provides template ids, favorited dates, and a count of updated templates, but does not return the full template content.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account from which to retrieve favorite templates. This can be either the external account number (integer) or the account ID GUID (string). It is a required parameter and must be provided in the path of the API request. For example: "12345" or "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p". Ensure you use the correct account ID to access the intended account"s favorite templates.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountinformationforspecifiedaccountDOCUSIGN_RETRIEVE_ACCOUNT_INFORMATION_FOR_SPECIFIED_ACCOUNTAcciónRetrieves comprehensive information for a specified docusign account, including account details, billing information, plan specifics, and optionally detailed account settings. this endpoint is used to gather extensive data about an account's configuration, status, and capabilities within the docusign platform. it's particularly useful for account management, auditing, or when needing to review or update account settings. the response includes critical information such as the account's guid, name, creation date, current plan details, and various feature enablements. when account settings are included, it provides a deep dive into the account's configuration, covering aspects like authentication requirements, branding options, envelope settings, and compliance-related configurations.
DOCUSIGN_RETRIEVE_ACCOUNT_INFORMATION_FOR_SPECIFIED_ACCOUNTAcciónRetrieves comprehensive information for a specified docusign account, including account details, billing information, plan specifics, and optionally detailed account settings. this endpoint is used to gather extensive data about an account's configuration, status, and capabilities within the docusign platform. it's particularly useful for account management, auditing, or when needing to review or update account settings. the response includes critical information such as the account's guid, name, creation date, current plan details, and various feature enablements. when account settings are included, it provides a deep dive into the account's configuration, covering aspects like authentication requirements, branding options, envelope settings, and compliance-related configurations.
Parámetros de entrada
accountIdstringThe 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.
include_account_settingsstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountpasswordrulesDOCUSIGN_RETRIEVE_ACCOUNT_PASSWORD_RULESAcciónRetrieves the current password rules and security settings for a user's docusign account. this endpoint provides detailed information about password requirements, including expiration policies, complexity rules, lockout settings, and security question configurations. it's useful for applications that need to display or enforce docusign's password policies, or for users who want to understand the security requirements for their account. the tool returns a comprehensive set of rules that govern password management, helping to ensure compliance with the account's security standards. it should be used when detailed password policy information is needed, but not for actually changing or resetting passwords.
DOCUSIGN_RETRIEVE_ACCOUNT_PASSWORD_RULESAcciónRetrieves the current password rules and security settings for a user's docusign account. this endpoint provides detailed information about password requirements, including expiration policies, complexity rules, lockout settings, and security question configurations. it's useful for applications that need to display or enforce docusign's password policies, or for users who want to understand the security requirements for their account. the tool returns a comprehensive set of rules that govern password management, helping to ensure compliance with the account's security standards. it should be used when detailed password policy information is needed, but not for actually changing or resetting passwords.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountprovisioninginfoDOCUSIGN_RETRIEVE_ACCOUNT_PROVISIONING_INFOAcciónRetrieves the account provisioning information for a docusign account. this endpoint is used to obtain crucial setup details necessary for account management and integration with docusign's services. it provides information such as default connection and plan ids, distributor codes, password rules, and billing-related details. this tool should be used when setting up a new docusign account or when needing to verify or update existing account provisioning information. the endpoint does not require any input parameters and returns a comprehensive set of account configuration data. note that this endpoint does not modify any account settings; it only retrieves existing information.
DOCUSIGN_RETRIEVE_ACCOUNT_PROVISIONING_INFOAcciónRetrieves the account provisioning information for a docusign account. this endpoint is used to obtain crucial setup details necessary for account management and integration with docusign's services. it provides information such as default connection and plan ids, distributor codes, password rules, and billing-related details. this tool should be used when setting up a new docusign account or when needing to verify or update existing account provisioning information. the endpoint does not require any input parameters and returns a comprehensive set of account configuration data. note that this endpoint does not modify any account settings; it only retrieves existing information.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountsealprovidersDOCUSIGN_RETRIEVE_ACCOUNT_SEAL_PROVIDERSAcciónRetrieves a list of electronic seal providers available for a specific docusign account. this endpoint allows developers to fetch all the seals that can be applied to documents within the specified account. it's particularly useful when implementing functionality to add electronic seals to documents or when displaying available seal options to users. the endpoint returns both the internal seal name and a user-friendly display name for each available seal. it should be used when an application needs to present seal choices to users or automatically apply seals based on predefined rules. note that this endpoint only retrieves the list of available seals and does not apply seals to documents; separate api calls would be required for seal application.
DOCUSIGN_RETRIEVE_ACCOUNT_SEAL_PROVIDERSAcciónRetrieves a list of electronic seal providers available for a specific docusign account. this endpoint allows developers to fetch all the seals that can be applied to documents within the specified account. it's particularly useful when implementing functionality to add electronic seals to documents or when displaying available seal options to users. the endpoint returns both the internal seal name and a user-friendly display name for each available seal. it should be used when an application needs to present seal choices to users or automatically apply seals based on predefined rules. note that this endpoint only retrieves the list of available seals and does not apply seals to documents; separate api calls would be required for seal application.
Parámetros de entrada
accountIdstringThe 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 seal providers should be retrieved. The accountId must be valid and associated with an existing DocuSign account. For example: "12345" or "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountsettingsinformationDOCUSIGN_RETRIEVE_ACCOUNT_SETTINGS_INFORMATIONAcciónRetrieves the comprehensive account settings information for a specified docusign account. this endpoint provides a detailed view of the account's configuration, including access code formats, account-wide preferences, feature toggles, security settings, ui customization options, and compliance-related configurations. it is particularly useful for administrators or integration developers who need to audit, review, or programmatically access the full range of account settings. the retrieved information can be used to understand the current state of the account, verify specific configurations, or as a basis for updating settings through other api calls. note that this endpoint returns a large amount of data and should be used judiciously to avoid unnecessary load on the system. it does not modify any settings; it only retrieves the current configuration.
DOCUSIGN_RETRIEVE_ACCOUNT_SETTINGS_INFORMATIONAcciónRetrieves the comprehensive account settings information for a specified docusign account. this endpoint provides a detailed view of the account's configuration, including access code formats, account-wide preferences, feature toggles, security settings, ui customization options, and compliance-related configurations. it is particularly useful for administrators or integration developers who need to audit, review, or programmatically access the full range of account settings. the retrieved information can be used to understand the current state of the account, verify specific configurations, or as a basis for updating settings through other api calls. note that this endpoint returns a large amount of data and should be used judiciously to avoid unnecessary load on the system. it does not modify any settings; it only retrieves the current configuration.
Parámetros de entrada
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountsigninggroupsDOCUSIGN_RETRIEVE_ACCOUNT_SIGNING_GROUPSAcciónRetrieves a comprehensive list of all signing groups within a specified docusign account. this endpoint allows you to obtain detailed information about each signing group, including group names, types, ids, and optionally, member details. it's particularly useful for managing and auditing signing groups across an organization. the endpoint supports filtering by group type and can include or exclude user information based on your needs. use this when you need to review, manage, or audit the signing groups in your docusign account. note that while it provides extensive group information, it does not modify any group settings or memberships.
DOCUSIGN_RETRIEVE_ACCOUNT_SIGNING_GROUPSAcciónRetrieves a comprehensive list of all signing groups within a specified docusign account. this endpoint allows you to obtain detailed information about each signing group, including group names, types, ids, and optionally, member details. it's particularly useful for managing and auditing signing groups across an organization. the endpoint supports filtering by group type and can include or exclude user information based on your needs. use this when you need to review, manage, or audit the signing groups in your docusign account. note that while it provides extensive group information, it does not modify any group settings or memberships.
Parámetros de entrada
accountIdstringThe 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.
group_typestringOptional 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.
include_usersstringOptional 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveaccountverificationworkflowsDOCUSIGN_RETRIEVE_ACCOUNT_VERIFICATION_WORKFLOWSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ACCOUNT_VERIFICATION_WORKFLOWSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
identity_verification_workflow_statusstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveallaccounttabsDOCUSIGN_RETRIEVE_ALL_ACCOUNT_TABSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ALL_ACCOUNT_TABSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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".
custom_tab_onlystringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveapirequestlogfilesDOCUSIGN_RETRIEVE_APIREQUEST_LOG_FILESAcciónRetrieves a list of api request log entries from docusign, providing diagnostic information for developers. offers flexible response formats (json, xml, or zip file). returns key data about each api request, including timestamps, endpoints called, and request status. useful for troubleshooting, monitoring, and auditing api usage. note: may not provide real-time logs and time range of returned logs is unspecified.
DOCUSIGN_RETRIEVE_APIREQUEST_LOG_FILESAcciónRetrieves a list of api request log entries from docusign, providing diagnostic information for developers. offers flexible response formats (json, xml, or zip file). returns key data about each api request, including timestamps, endpoints called, and request status. useful for troubleshooting, monitoring, and auditing api usage. note: may not provide real-time logs and time range of returned logs is unspecified.
Parámetros de entrada
encodingstringAn optional query parameter reserved for DocuSign. The exact purpose and valid values are not specified in the schema. As it"s reserved for DocuSign, it may be used for internal purposes or future expansions. Developers should typically leave this parameter empty unless specifically instructed by DocuSign documentation or support.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveavailableaccountstampsDOCUSIGN_RETRIEVE_AVAILABLE_ACCOUNT_STAMPSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_AVAILABLE_ACCOUNT_STAMPSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
stamp_namestringOptional 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.
stamp_typestringOptional 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.
stamp_formatstringOptional 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve billing invoiceDOCUSIGN_RETRIEVE_BILLING_INVOICEAcciónRetrieves a specific billing invoice for a docusign account, providing detailed information about charges and payment details. this endpoint allows account administrators to access invoice data in both json format and, when available, as a downloadable pdf. it's particularly useful for financial reconciliation, audit purposes, or when detailed billing information is required. the endpoint returns comprehensive invoice data, including total amount, balance, due date, and itemized charges, with amounts shown in the account's set currency.
DOCUSIGN_RETRIEVE_BILLING_INVOICEAcciónRetrieves a specific billing invoice for a docusign account, providing detailed information about charges and payment details. this endpoint allows account administrators to access invoice data in both json format and, when available, as a downloadable pdf. it's particularly useful for financial reconciliation, audit purposes, or when detailed billing information is required. the endpoint returns comprehensive invoice data, including total amount, balance, due date, and itemized charges, with amounts shown in the account's set currency.
Parámetros de entrada
accountIdstringThe 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 invoice is being retrieved. For example: "7215062" or "f0f9781f-d578-4e3e-b8f9-7b58414f8f41".
invoiceIdstringObligatorioThe specific ID of the invoice to be retrieved. This is a required string parameter that uniquely identifies the desired invoice within the account. The format may vary, but it"s typically a unique alphanumeric string assigned by DocuSign. For example: "INV-12345" or "BILL-2023-03-31".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievebillingpaymentinfoDOCUSIGN_RETRIEVE_BILLING_PAYMENT_INFOAcciónRetrieves detailed information for a specified billing payment within a docusign account. this endpoint is used to fetch comprehensive data about a single payment, including the amount, description, payment date, and payment number. it is designed for account administrators who need to access or review specific payment details, such as for auditing or reconciliation purposes. the endpoint does not modify any payment information and is read-only. it should be used when precise payment data is required, but not for real-time payment processing or for retrieving bulk payment information.
DOCUSIGN_RETRIEVE_BILLING_PAYMENT_INFOAcciónRetrieves detailed information for a specified billing payment within a docusign account. this endpoint is used to fetch comprehensive data about a single payment, including the amount, description, payment date, and payment number. it is designed for account administrators who need to access or review specific payment details, such as for auditing or reconciliation purposes. the endpoint does not modify any payment information and is read-only. it should be used when precise payment data is required, but not for real-time payment processing or for retrieving bulk payment information.
Parámetros de entrada
accountIdstringThe 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 billing payment information should be retrieved.
paymentIdstringObligatorioThe unique identifier for the specific payment to be retrieved. This is a required string parameter that pinpoints the exact payment for which detailed information is requested.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve billing plan detailsDOCUSIGN_RETRIEVE_BILLING_PLAN_DETAILSAcciónRetrieves comprehensive details of a specific docusign billing plan using its unique identifier. this endpoint provides extensive information about the plan, including its name, payment cycle, pricing structure, included features, and potential upgrade options. it's particularly useful for account administrators and billing managers who need to review or manage subscription details. the response includes the current plan's specifics such as per-seat pricing, included seats, and support fees, as well as a list of successor plans for potential upgrades. this endpoint should be used when detailed billing plan information is required, such as during account reviews, upgrade considerations, or for generating detailed billing reports. it does not modify any billing information and is intended for read-only operations.
DOCUSIGN_RETRIEVE_BILLING_PLAN_DETAILSAcciónRetrieves comprehensive details of a specific docusign billing plan using its unique identifier. this endpoint provides extensive information about the plan, including its name, payment cycle, pricing structure, included features, and potential upgrade options. it's particularly useful for account administrators and billing managers who need to review or manage subscription details. the response includes the current plan's specifics such as per-seat pricing, included seats, and support fees, as well as a list of successor plans for potential upgrades. this endpoint should be used when detailed billing plan information is required, such as during account reviews, upgrade considerations, or for generating detailed billing reports. it does not modify any billing information and is intended for read-only operations.
Parámetros de entrada
billingPlanIdstringObligatorioThe unique identifier for the billing plan to be retrieved. This is a required path parameter that specifies which plan"s details should be fetched. The ID should be a valid string representing a DocuSign billing plan ID. Example: "b76e4ef6-1234-5678-9abc-def012345678".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve chunked upload metadataDOCUSIGN_RETRIEVE_CHUNKED_UPLOAD_METADATAAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CHUNKED_UPLOAD_METADATAAcciónRetrieves 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.
Parámetros de entrada
includestringOptional 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.
accountIdstringThe 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.
chunkedUploadIdstringObligatorioThe unique identifier for the specific chunked upload. Required parameter used to retrieve metadata for a particular chunked upload within the specified account.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve cloud storage provider configurationDOCUSIGN_RETRIEVE_CLOUD_STORAGE_PROVIDER_CONFIGURATIONAcciónRetrieves the list of cloud storage providers enabled for a specific user in a docusign account, along with their configuration information. this endpoint is essential for integrating external cloud storage services with docusign, allowing users to access and manage documents from various providers. it provides details such as authentication urls and service ids for each enabled provider. use this endpoint when you need to display available cloud storage options to a user or initiate the authentication process for a specific provider. note that users can only access their own cloud storage information, and the endpoint does not modify any existing configurations.
DOCUSIGN_RETRIEVE_CLOUD_STORAGE_PROVIDER_CONFIGURATIONAcciónRetrieves the list of cloud storage providers enabled for a specific user in a docusign account, along with their configuration information. this endpoint is essential for integrating external cloud storage services with docusign, allowing users to access and manage documents from various providers. it provides details such as authentication urls and service ids for each enabled provider. use this endpoint when you need to display available cloud storage options to a user or initiate the authentication process for a specific provider. note that users can only access their own cloud storage information, and the endpoint does not modify any existing configurations.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
redirectUrlstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveconnectconfigurationdetailsDOCUSIGN_RETRIEVE_CONNECT_CONFIGURATION_DETAILSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATION_DETAILSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 which account"s Connect configuration should be retrieved.
connectIdstringObligatorioThe unique identifier of the custom Connect configuration being accessed. This parameter is required and must be provided in the path of the API request. It specifies which particular Connect configuration should be retrieved from the account identified by the accountId.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveconnectconfigurationsDOCUSIGN_RETRIEVE_CONNECT_CONFIGURATIONSAcciónRetrieves all docusign custom connect definitions for a specified account. this endpoint allows account administrators to fetch detailed information about existing connect configurations, including webhook settings, event triggers, and delivery modes. it provides a comprehensive view of how the account is set up to send notifications for various docusign events. this tool is essential for managing and auditing connect integrations, but should only be used by authorized account administrators with connect enabled on their account.
DOCUSIGN_RETRIEVE_CONNECT_CONFIGURATIONSAcciónRetrieves all docusign custom connect definitions for a specified account. this endpoint allows account administrators to fetch detailed information about existing connect configurations, including webhook settings, event triggers, and delivery modes. it provides a comprehensive view of how the account is set up to send notifications for various docusign events. this tool is essential for managing and auditing connect integrations, but should only be used by authorized account administrators with connect enabled on their account.
Parámetros de entrada
accountIdstringThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve connect failure logsDOCUSIGN_RETRIEVE_CONNECT_FAILURE_LOGSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CONNECT_FAILURE_LOGSAcciónRetrieves 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.
Parámetros de entrada
to_datestringAn 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.
accountIdstringThe 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.
from_datestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve connect log entryDOCUSIGN_RETRIEVE_CONNECT_LOG_ENTRYAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CONNECT_LOG_ENTRYAcciónRetrieves 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.
Parámetros de entrada
logIdstringObligatorioThe 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.
accountIdstringThe 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.
additional_infostringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve connect logsDOCUSIGN_RETRIEVE_CONNECT_LOGSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CONNECT_LOGSAcciónRetrieves 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.
Parámetros de entrada
to_datestringAn 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.
accountIdstringThe 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.
from_datestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveconnectoauthconfigurationDOCUSIGN_RETRIEVE_CONNECT_OAUTH_CONFIGURATIONAcciónRetrieves the connect oauth configuration for a specified docusign account. this endpoint allows account administrators to access the oauth settings used for docusign connect, which is crucial for webhook integrations and automated notifications. the retrieved configuration includes essential details such as the authorization server url, client id, client secret, and scope settings. this tool should be used when setting up or troubleshooting connect integrations, or when verifying the current oauth configuration for an account. it's important to note that this endpoint requires account administrator privileges and connect must be enabled on the account to access this information. the tool does not modify any settings; it only retrieves the existing configuration.
DOCUSIGN_RETRIEVE_CONNECT_OAUTH_CONFIGURATIONAcciónRetrieves the connect oauth configuration for a specified docusign account. this endpoint allows account administrators to access the oauth settings used for docusign connect, which is crucial for webhook integrations and automated notifications. the retrieved configuration includes essential details such as the authorization server url, client id, client secret, and scope settings. this tool should be used when setting up or troubleshooting connect integrations, or when verifying the current oauth configuration for an account. it's important to note that this endpoint requires account administrator privileges and connect must be enabled on the account to access this information. the tool does not modify any settings; it only retrieves the existing configuration.
Parámetros de entrada
accountIdstringThe 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 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 GUID format.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievecreditcardinfoDOCUSIGN_RETRIEVE_CREDIT_CARD_INFOAcciónThis 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.
DOCUSIGN_RETRIEVE_CREDIT_CARD_INFOAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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 credit card information should be retrieved. For example: "1234567" or "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve custom fields for envelopeDOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_ENVELOPEAcciónRetrieves custom field information for a specified envelope in docusign. this endpoint allows users to access both list and text custom fields associated with an envelope, providing valuable metadata for tracking, searching, and managing documents. it's particularly useful for retrieving envelope-specific custom data that isn't visible to recipients but is crucial for internal processes and integrations. the endpoint supports salesforce merge fields, enhancing its utility in crm-integrated workflows.
DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_ENVELOPEAcciónRetrieves custom field information for a specified envelope in docusign. this endpoint allows users to access both list and text custom fields associated with an envelope, providing valuable metadata for tracking, searching, and managing documents. it's particularly useful for retrieving envelope-specific custom data that isn't visible to recipients but is crucial for internal processes and integrations. the endpoint supports salesforce merge fields, enhancing its utility in crm-integrated workflows.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required to specify which account"s envelope custom fields should be retrieved. It must be a valid string representing either a numeric account number or a GUID format account ID.
envelopeIdstringObligatorioThe unique identifier for the envelope whose custom fields are to be retrieved. This parameter is required and must be in GUID format. For example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". Each envelope in DocuSign has a unique GUID, ensuring that the correct envelope"s custom fields are accessed.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievecustomfieldsfortemplateDOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_TEMPLATEAcciónThis 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.
DOCUSIGN_RETRIEVE_CUSTOM_FIELDS_FOR_TEMPLATEAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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. The value must be a non-empty string representing a valid DocuSign account identifier.
documentIdstringObligatorioThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievecustomtabinformationDOCUSIGN_RETRIEVE_CUSTOM_TAB_INFORMATIONAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_CUSTOM_TAB_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
customTabIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievecustomusersettingsDOCUSIGN_RETRIEVE_CUSTOM_USER_SETTINGSAcciónRetrieves a list of custom user settings for a single user in docusign. this endpoint allows flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard user account settings. it supports both grouped and ungrouped custom settings, with the ability to filter by group using an optional header. use this endpoint when you need to access user-specific configurations, preferences, or any custom data stored for a particular user in your docusign integration. note that users can only access their own custom settings, and this endpoint does not provide access to standard docusign account settings.
DOCUSIGN_RETRIEVE_CUSTOM_USER_SETTINGSAcciónRetrieves a list of custom user settings for a single user in docusign. this endpoint allows flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard user account settings. it supports both grouped and ungrouped custom settings, with the ability to filter by group using an optional header. use this endpoint when you need to access user-specific configurations, preferences, or any custom data stored for a particular user in your docusign integration. note that users can only access their own custom settings, and this endpoint does not provide access to standard docusign account settings.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose custom settings 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 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".
accountIdstringThe 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 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve default disclosure for envelopeDOCUSIGN_RETRIEVE_DEFAULT_DISCLOSURE_FOR_ENVELOPEAcciónRetrieves the default html-formatted electronic record and signature disclosure (ersd) for a specified envelope in docusign. this endpoint is used to obtain the standard disclosure text that recipients must agree to before signing documents electronically. it is particularly useful for retrieving language-specific versions of the disclosure and for ensuring compliance with electronic signature regulations.
DOCUSIGN_RETRIEVE_DEFAULT_DISCLOSURE_FOR_ENVELOPEAcciónRetrieves the default html-formatted electronic record and signature disclosure (ersd) for a specified envelope in docusign. this endpoint is used to obtain the standard disclosure text that recipients must agree to before signing documents electronically. it is particularly useful for retrieving language-specific versions of the disclosure and for ensuring compliance with electronic signature regulations.
Parámetros de entrada
langCodestringAn 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.
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
recipientIdstringObligatorioA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopeattachmentDOCUSIGN_RETRIEVE_ENVELOPE_ATTACHMENTAcciónRetrieves a developer-only envelope attachment from a specific envelope in docusign. this endpoint allows you to access files associated with an envelope that are not visible to signers. it should be used when you need to retrieve attachment files that were programmatically added to an envelope. the function returns the attachment as a binary file, which can then be processed or stored as needed. note that this operation is currently in beta status, which means it may undergo changes in the future. it's important to distinguish this from retrieving signer attachments, which is a separate process.
DOCUSIGN_RETRIEVE_ENVELOPE_ATTACHMENTAcciónRetrieves a developer-only envelope attachment from a specific envelope in docusign. this endpoint allows you to access files associated with an envelope that are not visible to signers. it should be used when you need to retrieve attachment files that were programmatically added to an envelope. the function returns the attachment as a binary file, which can then be processed or stored as needed. note that this operation is currently in beta status, which means it may undergo changes in the future. it's important to distinguish this from retrieving signer attachments, which is a separate process.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the account number (an integer) or the account ID GUID (a string). It is required to specify which account the envelope and attachment belong to. Example: "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6".
envelopeIdstringObligatorioThe unique identifier for the envelope containing the attachment. This is a required string parameter in the format of a GUID (Globally Unique Identifier). It is used to locate the specific envelope from which the attachment should be retrieved. Example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
attachmentIdstringObligatorioThe unique identifier for the specific attachment you want to retrieve. This is a required string parameter that DocuSign uses to locate the exact attachment within the envelope. The format is typically a GUID, but may vary depending on how the attachment was created. Example: "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopeauditeventsDOCUSIGN_RETRIEVE_ENVELOPE_AUDIT_EVENTSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ENVELOPE_AUDIT_EVENTSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. It is a required parameter used to specify which account the envelope belongs to. The accountId must be valid and associated with your DocuSign integration. Format: string (for both integer and GUID representations). Example: "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6".
envelopeIdstringObligatorioThe unique identifier for the specific envelope whose audit events you want to retrieve. This is a required parameter and must be provided as a GUID (Globally Unique Identifier) string. The envelopeId is case-sensitive and should match exactly with the ID of an existing envelope in the specified account. Format: 32-character string consisting of hexadecimal digits, typically grouped in 5 sections separated by hyphens. Example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopedocumentfieldsDOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENT_FIELDSAcciónRetrieves custom document field information from an existing envelope document in docusign. this endpoint allows users to access name-value pairs of custom data strings associated with a specific document within an envelope. it's particularly useful for retrieving metadata or additional information attached to documents that are not used in docusign's standard processing. the function returns both current and original values of these custom fields, enabling tracking of any changes made to the fields over time.
DOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENT_FIELDSAcciónRetrieves custom document field information from an existing envelope document in docusign. this endpoint allows users to access name-value pairs of custom data strings associated with a specific document within an envelope. it's particularly useful for retrieving metadata or additional information attached to documents that are not used in docusign's standard processing. the function returns both current and original values of these custom fields, enabling tracking of any changes made to the fields over time.
Parámetros de entrada
accountIdstringThe 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 and document belong to. The accountId is typically provided by DocuSign when setting up the integration and remains constant for a given account.
documentIdstringObligatorioThe unique identifier for the document within the envelope. Unlike other IDs in the eSignature API, you specify this ID yourself. It"s typically a sequential number (e.g., 1, 2, 3) but can be any positive integer from 1 to 2147483647. This ID is crucial as it links the custom fields to a specific document in the envelope. When setting up the envelope, ensure that the documentId used here matches the one assigned to the document of interest.
envelopeIdstringObligatorioThe unique identifier for the envelope containing the document. This is a GUID (Globally Unique Identifier) provided by DocuSign when the envelope is created. It"s a string in the format "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". The envelopeId is essential for locating the specific envelope from which you want to retrieve document fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopedocumentsDOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENTSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ENVELOPE_DOCUMENTSAcciónRetrieves 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.
Parámetros de entrada
encryptstringA 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.
encodingstringThis parameter is reserved for DocuSign"s internal use. Its specific function is not detailed in the provided schema.
languagestringSpecifies 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.
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account from which to retrieve the envelope documents.
watermarkstringA 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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".
certificatestringA 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.
recipient_idstringAllows 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.
show_changesstringA 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.
shared_user_idstringThe 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.
documents_by_useridstringA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopeemailoverridesDOCUSIGN_RETRIEVE_ENVELOPE_EMAIL_OVERRIDESAcciónRetrieves the email override settings for a specified envelope in docusign. this endpoint allows users to fetch custom email configurations, including reply-to email address and name overrides, as well as bcc email addresses for archiving purposes. it's particularly useful when you need to verify or audit the email settings for a specific envelope that may differ from the account-level defaults. the retrieved information is not included in the standard envelope status get request and requires this specific api call.
DOCUSIGN_RETRIEVE_ENVELOPE_EMAIL_OVERRIDESAcciónRetrieves the email override settings for a specified envelope in docusign. this endpoint allows users to fetch custom email configurations, including reply-to email address and name overrides, as well as bcc email addresses for archiving purposes. it's particularly useful when you need to verify or audit the email settings for a specific envelope that may differ from the account-level defaults. the retrieved information is not included in the standard envelope status get request and requires this specific api call.
Parámetros de entrada
accountIdstringThe 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 envelope belongs to. The accountId is essential for targeting the correct account within multi-account environments.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopehtmldefinitionDOCUSIGN_RETRIEVE_ENVELOPE_HTML_DEFINITIONAcciónRetrieves the original html definition used to generate the responsive html for a specific envelope in a docusign account. this endpoint is crucial for developers working with docusign's responsive signing feature, as it provides detailed information about how the envelope's documents are formatted and displayed in a responsive manner. the tool returns properties that define the responsive html generation, including display anchors, collapsible sections, and responsive table settings. it should be used when you need to inspect or troubleshoot the html definition of an envelope, particularly for envelopes using smart sections or responsive signing features. this endpoint does not modify any data and is purely for retrieval purposes.
DOCUSIGN_RETRIEVE_ENVELOPE_HTML_DEFINITIONAcciónRetrieves the original html definition used to generate the responsive html for a specific envelope in a docusign account. this endpoint is crucial for developers working with docusign's responsive signing feature, as it provides detailed information about how the envelope's documents are formatted and displayed in a responsive manner. the tool returns properties that define the responsive html generation, including display anchors, collapsible sections, and responsive table settings. it should be used when you need to inspect or troubleshoot the html definition of an envelope, particularly for envelopes using smart sections or responsive signing features. this endpoint does not modify any data and is purely for retrieval purposes.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe unique identifier for the envelope whose HTML definition is to be retrieved. 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveenvelopenotificationdetailsDOCUSIGN_RETRIEVE_ENVELOPE_NOTIFICATION_DETAILSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ENVELOPE_NOTIFICATION_DETAILSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievehtmldefinitionforresponsivedocumentDOCUSIGN_RETRIEVE_HTMLDEFINITION_FOR_RESPONSIVE_DOCUMENTAcciónThis endpoint retrieves the html definition used to generate a dynamically sized responsive document within a docusign envelope. it is specifically designed for documents created as signable html and provides detailed information about responsive signing and smart sections. the endpoint returns properties that define how to generate the responsive-formatted html for the document, including display settings, anchors, and styling options. it's particularly useful when implementing responsive signing across different devices or customizing the appearance of html documents in the signing process. note that for non-html documents or invalid document ids, the endpoint will return a 200 ok response with an empty json body, rather than an error.
DOCUSIGN_RETRIEVE_HTMLDEFINITION_FOR_RESPONSIVE_DOCUMENTAcciónThis endpoint retrieves the html definition used to generate a dynamically sized responsive document within a docusign envelope. it is specifically designed for documents created as signable html and provides detailed information about responsive signing and smart sections. the endpoint returns properties that define how to generate the responsive-formatted html for the document, including display settings, anchors, and styling options. it's particularly useful when implementing responsive signing across different devices or customizing the appearance of html documents in the signing process. note that for non-html documents or invalid document ids, the endpoint will return a 200 ok response with an empty json body, rather than an error.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID associated with 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.
documentIdstringObligatorioThe GUID (Globally Unique Identifier) of the document within the envelope. This parameter is required and must be a valid string in the format of a GUID, e.g., "c671747c-xxxx-xxxx-xxxx-4a4a48e23744". It uniquely identifies the specific document for which the HTML definition is being retrieved.
envelopeIdstringObligatorioThe envelope"s GUID (Globally Unique Identifier). This parameter is required and must be a valid string in the format of a GUID, e.g., "93be49ab-xxxx-xxxx-xxxx-f752070d71ec". It uniquely identifies the envelope containing the document for which the HTML definition is being retrieved.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveitemsincloudstoragefolderDOCUSIGN_RETRIEVE_ITEMS_IN_CLOUD_STORAGE_FOLDERAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_ITEMS_IN_CLOUD_STORAGE_FOLDERAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
orderstringSpecifies 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.
userIdstringObligatorioThe ID of the user whose cloud storage is being accessed. This parameter is required and ensures that users can only access their own information. Even users with Admin rights cannot access another user"s settings or storage.
order_bystringThe 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.
accountIdstringThe external account number (int) or account ID GUID. This unique identifier is required to specify the DocuSign account context for the operation. It must be provided as a string, either in the form of an integer or a GUID.
serviceIdstringObligatorioThe ID of the cloud storage service to access. This can be provided either as the service name (e.g., "Box") or the numerical serviceId (e.g., "4136"). This parameter is required to specify which cloud storage provider to query.
search_textstringA 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.
start_positionstringThe 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.
cloud_storage_folder_pathstringA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievelistofbillingplansDOCUSIGN_RETRIEVE_LIST_OF_BILLING_PLANSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_LIST_OF_BILLING_PLANSAcciónRetrieves 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve payment information listDOCUSIGN_RETRIEVE_PAYMENT_INFORMATION_LISTAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_PAYMENT_INFORMATION_LISTAcciónRetrieves 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.
Parámetros de entrada
to_datestringAn 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.
accountIdstringThe 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".
from_datestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve pdf from specified templateDOCUSIGN_RETRIEVE_PDF_FROM_SPECIFIED_TEMPLATEAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_PDF_FROM_SPECIFIED_TEMPLATEAcciónRetrieves 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.
Parámetros de entrada
encryptstringAn 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.
accountIdstringThe external account number (integer) or account ID GUID that identifies the DocuSign account from which to retrieve the template document. This parameter is required and must be a valid account identifier associated with your DocuSign integration.
file_typestringAn 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.
documentIdstringObligatorioThe unique identifier of the document within the template. This parameter is required and must be specified by the API user. Valid values range from 1 to 2147483647 (32-bit signed integer). 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 used to reference specific documents within the template and is crucial for operations like placing tabs on documents.
templateIdstringObligatorioThe unique identifier 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. Use this to specify which template"s documents you want to retrieve.
show_changesstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievepowerformdataentriesDOCUSIGN_RETRIEVE_POWER_FORM_DATA_ENTRIESAcciónThis 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.
DOCUSIGN_RETRIEVE_POWER_FORM_DATA_ENTRIESAcciónThis 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.
Parámetros de entrada
to_datestringOptional 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).
accountIdstringThe 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 PowerForm data to retrieve.
from_datestringOptional 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.
data_layoutstringOptional 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.
powerFormIdstringObligatorioThe unique identifier for the specific PowerForm from which to retrieve data. Required parameter that determines which PowerForm"s entries will be returned.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievepropertiesaboutworkspaceDOCUSIGN_RETRIEVE_PROPERTIES_ABOUT_WORKSPACEAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_PROPERTIES_ABOUT_WORKSPACEAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the workspace. It must be a valid account identifier within your organization"s DocuSign environment. Example: "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6".
workspaceIdstringObligatorioThe unique identifier of the workspace for which you want to retrieve properties. This parameter is required and must be a valid workspace ID within the specified account. It is typically a string of alphanumeric characters. Example: "ws-1234567890abcdef".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve rest api versionsDOCUSIGN_RETRIEVE_REST_API_VERSIONSAcciónRetrieves the available rest api versions for docusign's service. this endpoint provides crucial information about the current state of the api, including available versions, their corresponding urls, and some internal build details. it's useful for developers who need to check api compatibility, plan for version upgrades, or diagnose potential issues. the endpoint can be accessed on both production and demo systems without requiring authentication or an integration key, making it ideal for quick service checks or initial api exploration. while it offers valuable version and build information, it does not provide details about specific api functionalities or user-related data.
DOCUSIGN_RETRIEVE_REST_API_VERSIONSAcciónRetrieves the available rest api versions for docusign's service. this endpoint provides crucial information about the current state of the api, including available versions, their corresponding urls, and some internal build details. it's useful for developers who need to check api compatibility, plan for version upgrades, or diagnose potential issues. the endpoint can be accessed on both production and demo systems without requiring authentication or an integration key, making it ideal for quick service checks or initial api exploration. while it offers valuable version and build information, it does not provide details about specific api functionalities or user-related data.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveshareditemstatusforusersDOCUSIGN_RETRIEVE_SHARED_ITEM_STATUS_FOR_USERSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_SHARED_ITEM_STATUS_FOR_USERSAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
sharedstringA 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.
user_idsstringA 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.
accountIdstringThe external account number (integer) or account ID GUID. This is a required parameter that identifies the specific DocuSign account for which shared access information is being retrieved.
item_typestringSpecifies 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.
folder_idsstringA 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.
search_textstringAn 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.
start_positionstringThe 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".
envelopes_not_shared_user_statusstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve signer signature image informationDOCUSIGN_RETRIEVE_SIGNER_SIGNATURE_IMAGE_INFORMATIONAcciónRetrieves the specified user's signature image from a docusign envelope. this endpoint allows developers to access the electronic signature image of a specific recipient within an envelope, which can be useful for verification, display, or record-keeping purposes. the image is returned in its original uploaded format, with an option to include or exclude the chrome (added line and identifier around the initial image). this tool is particularly useful when you need to extract or display a user's signature from a completed or in-progress docusign transaction. it should be used cautiously, respecting privacy concerns and ensuring proper authorization. note that older envelopes may only have chromed images available, so a fallback strategy might be necessary in some cases.
DOCUSIGN_RETRIEVE_SIGNER_SIGNATURE_IMAGE_INFORMATIONAcciónRetrieves the specified user's signature image from a docusign envelope. this endpoint allows developers to access the electronic signature image of a specific recipient within an envelope, which can be useful for verification, display, or record-keeping purposes. the image is returned in its original uploaded format, with an option to include or exclude the chrome (added line and identifier around the initial image). this tool is particularly useful when you need to extract or display a user's signature from a completed or in-progress docusign transaction. it should be used cautiously, respecting privacy concerns and ensuring proper authorization. note that older envelopes may only have chromed images available, so a fallback strategy might be necessary in some cases.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
recipientIdstringObligatorioA 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.
include_chromestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievetemplatecustomfieldsDOCUSIGN_RETRIEVE_TEMPLATE_CUSTOM_FIELDSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_TEMPLATE_CUSTOM_FIELDSAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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 correct account"s templates. The value should be a valid string representing either the numeric account number or the GUID format account ID.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrievetemplatedocumentpageimagesDOCUSIGN_RETRIEVE_TEMPLATE_DOCUMENT_PAGE_IMAGESAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_TEMPLATE_DOCUMENT_PAGE_IMAGESAcciónRetrieves 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.
Parámetros de entrada
dpistringAn 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.
countstringAn 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.
nocachestringAn 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.
accountIdstringThe 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 ensures that the template document is retrieved from the correct account.
max_widthstringAn 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.
documentIdstringObligatorioThe unique identifier of the document within the template. This required parameter must be provided in the path of the API request. It specifies which document"s pages should be retrieved from the selected template.
max_heightstringAn 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.
templateIdstringObligatorioThe 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.
show_changesstringAn 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.
start_positionstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve template page imageDOCUSIGN_RETRIEVE_TEMPLATE_PAGE_IMAGEAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_TEMPLATE_PAGE_IMAGEAcciónRetrieves 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.
Parámetros de entrada
dpistringThe 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.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This is a required path parameter used to specify which account"s templates to access.
max_widthstringThe 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.
documentIdstringObligatorioThe 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.
max_heightstringThe 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.
pageNumberstringObligatorioThe 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.
templateIdstringObligatorioThe 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.
show_changesstringAn optional query parameter that likely controls whether to display any changes or annotations on the page image. The schema doesn"t provide details on possible values, so it"s assumed to be a boolean flag (e.g., "true" or "false").
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve user account settingsDOCUSIGN_RETRIEVE_USER_ACCOUNT_SETTINGSAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_USER_ACCOUNT_SETTINGSAcciónRetrieves 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.
Parámetros de entrada
userIdstringObligatorioThe ID of the user to access. This parameter is required and must be a valid user identifier within the specified account. Note that users can only access their own information. Even a user with Admin rights cannot access another user"s settings using this endpoint.
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required to identify the specific DocuSign account for which the user settings are being retrieved. It must be a valid account identifier associated with the API credentials being used.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve user initials image for envelopesDOCUSIGN_RETRIEVE_USER_INITIALS_IMAGE_FOR_ENVELOPESAcciónRetrieves the initials image for a specified user within a docusign envelope. this endpoint allows you to fetch the user's initials image in its original upload format, with an option to include or exclude the chrome (added line and identifier around the image). it's particularly useful when you need to display or process a recipient's initials within the context of an envelope. note that for older envelopes, only chromed images might be available, so you may need to implement fallback logic if retrieving a non-chromed image fails. the endpoint requires specific authentication and authorization, ensuring that the requested user id matches the authenticated user and that the user is a member of the account.
DOCUSIGN_RETRIEVE_USER_INITIALS_IMAGE_FOR_ENVELOPESAcciónRetrieves the initials image for a specified user within a docusign envelope. this endpoint allows you to fetch the user's initials image in its original upload format, with an option to include or exclude the chrome (added line and identifier around the image). it's particularly useful when you need to display or process a recipient's initials within the context of an envelope. note that for older envelopes, only chromed images might be available, so you may need to implement fallback logic if retrieving a non-chromed image fails. the endpoint requires specific authentication and authorization, ensuring that the requested user id matches the authenticated user and that the user is a member of the account.
Parámetros de entrada
accountIdstringThe 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. Example: "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6".
envelopeIdstringObligatorioThe 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".
recipientIdstringObligatorioA 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".
include_chromestringAn 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveuserprofileimageDOCUSIGN_RETRIEVE_USER_PROFILE_IMAGEAcciónRetrieves 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.
DOCUSIGN_RETRIEVE_USER_PROFILE_IMAGEAcciónRetrieves 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.
Parámetros de entrada
userIdstringObligatorioThe 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.
encodingstringAn 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.
accountIdstringThe 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").
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve user profile informationDOCUSIGN_RETRIEVE_USER_PROFILE_INFORMATIONAcciónThis endpoint retrieves comprehensive user profile information for a specified user within a docusign account. it provides detailed data about the user's personal information, settings, preferences, and permissions. the endpoint is particularly useful for obtaining an in-depth view of a user's configuration within the docusign system, including their authentication methods, email notification settings, and locale preferences. it should be used when detailed user information is required for account management, user customization, or auditing purposes. note that users can only access their own information, and the userid parameter must match the authenticated user's id. the endpoint does not allow for modification of user settings; it is strictly for retrieval of existing information.
DOCUSIGN_RETRIEVE_USER_PROFILE_INFORMATIONAcciónThis endpoint retrieves comprehensive user profile information for a specified user within a docusign account. it provides detailed data about the user's personal information, settings, preferences, and permissions. the endpoint is particularly useful for obtaining an in-depth view of a user's configuration within the docusign system, including their authentication methods, email notification settings, and locale preferences. it should be used when detailed user information is required for account management, user customization, or auditing purposes. note that users can only access their own information, and the userid parameter must match the authenticated user's id. the endpoint does not allow for modification of user settings; it is strictly for retrieval of existing information.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve user signature definitionsDOCUSIGN_RETRIEVE_USER_SIGNATURE_DEFINITIONSAcciónThis endpoint retrieves the signature definitions for a specified user within a docusign account. it allows users to access their own signature information, including details about signature images, stamps, and associated metadata. the endpoint is useful for applications that need to display or manage user signatures within the docusign ecosystem. it supports retrieving different types of signatures based on the optional stamp type parameter. the response includes comprehensive information about each signature, such as creation date, image data, and various properties related to the signature's appearance and usage.
DOCUSIGN_RETRIEVE_USER_SIGNATURE_DEFINITIONSAcciónThis endpoint retrieves the signature definitions for a specified user within a docusign account. it allows users to access their own signature information, including details about signature images, stamps, and associated metadata. the endpoint is useful for applications that need to display or manage user signatures within the docusign ecosystem. it supports retrieving different types of signatures based on the optional stamp type parameter. the response includes comprehensive information about each signature, such as creation date, image data, and various properties related to the signature's appearance and usage.
Parámetros de entrada
userIdstringObligatorioThe 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.
accountIdstringThe 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.
stamp_typestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveusersignatureimageDOCUSIGN_RETRIEVE_USER_SIGNATURE_IMAGEAcciónRetrieves a specified user's signature or initials image from docusign. this endpoint allows you to fetch the image in its original upload format, with an option to include or exclude the chrome (frame) around the image. it's useful for applications that need to display or process user signatures. the endpoint requires specific user authentication and is limited to retrieving the authenticated user's own signature images. it supports various image types including stamps, signatures, and initials, making it versatile for different signature requirements in document workflows.
DOCUSIGN_RETRIEVE_USER_SIGNATURE_IMAGEAcciónRetrieves a specified user's signature or initials image from docusign. this endpoint allows you to fetch the image in its original upload format, with an option to include or exclude the chrome (frame) around the image. it's useful for applications that need to display or process user signatures. the endpoint requires specific user authentication and is limited to retrieving the authenticated user's own signature images. it supports various image types including stamps, signatures, and initials, making it versatile for different signature requirements in document workflows.
Parámetros de entrada
userIdstringObligatorioThe 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 required for user-specific image retrieval and authentication purposes.
accountIdstringThe 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.
imageTypestringObligatorioSpecifies 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.
signatureIdstringObligatorioThe 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.
include_chromestringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveusersignatureinformationDOCUSIGN_RETRIEVE_USER_SIGNATURE_INFORMATIONAcciónThis 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.
DOCUSIGN_RETRIEVE_USER_SIGNATURE_INFORMATIONAcciónThis 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.
Parámetros de entrada
userIdstringObligatorioThe ID of the user whose signature information is being accessed. This parameter is required and must match the authenticated user"s ID. Users can only access their own signature information, even if they have admin rights. The userId ensures that users are only retrieving their personal signature data.
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required to identify the specific DocuSign account for which the user signature information is being retrieved. It must be a valid account identifier associated with the authenticated user.
signatureIdstringObligatorioThe unique identifier for the signature to be retrieved. This can be either the signature ID or the signature name. When using a signature name, it"s recommended to URL encode it, especially if it contains spaces or special characters (e.g., "Bob Smith" should be encoded as "Bob%20Smith"). This parameter is required to specify which signature to retrieve.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RetrieveworkflowstepfortemplateDOCUSIGN_RETRIEVE_WORKFLOW_STEP_FOR_TEMPLATEAcciónRetrieves detailed information about a specific workflow step for a docusign envelope. this endpoint allows users to access the configuration and status of a single step within an envelope's workflow, including delayed routing settings and conditional recipient rules. it's particularly useful for monitoring the progress of complex, multi-step envelope processes or for troubleshooting issues with specific workflow steps. the endpoint provides read-only access to step details and should be used when you need to inspect or verify the current state and rules of a particular workflow step within an envelope. note that this endpoint does not allow modification of the workflow step; it is for retrieval purposes only.
DOCUSIGN_RETRIEVE_WORKFLOW_STEP_FOR_TEMPLATEAcciónRetrieves detailed information about a specific workflow step for a docusign envelope. this endpoint allows users to access the configuration and status of a single step within an envelope's workflow, including delayed routing settings and conditional recipient rules. it's particularly useful for monitoring the progress of complex, multi-step envelope processes or for troubleshooting issues with specific workflow steps. the endpoint provides read-only access to step details and should be used when you need to inspect or verify the current state and rules of a particular workflow step within an envelope. note that this endpoint does not allow modification of the workflow step; it is for retrieval purposes only.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe unique identifier of the envelope 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 envelope within the DocuSign system.
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Return all connect service usersDOCUSIGN_RETURN_ALL_CONNECT_SERVICE_USERSAcciónRetrieves 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.
DOCUSIGN_RETURN_ALL_CONNECT_SERVICE_USERSAcciónRetrieves 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.
Parámetros de entrada
countstringThe 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.
statusstringAn 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.
accountIdstringThe 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.
connectIdstringObligatorioThe unique identifier for the custom Connect configuration being accessed. This parameter is required and must be provided in the path of the request.
start_positionstringAn 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.
email_substringstringAn 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.
domain_users_onlystringAn 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.
user_name_substringstringAn 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".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ReturnbrandresourcemetadataforaccountDOCUSIGN_RETURN_BRAND_RESOURCE_METADATA_FOR_ACCOUNTAcciónRetrieves 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.
DOCUSIGN_RETURN_BRAND_RESOURCE_METADATA_FOR_ACCOUNTAcciónRetrieves 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.
Parámetros de entrada
brandIdstringObligatorioThe 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.
accountIdstringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ReturnenvelopetabdataforexistingenvelopeDOCUSIGN_RETURN_ENVELOPE_TAB_DATA_FOR_EXISTING_ENVELOPEAcciónRetrieves 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.
DOCUSIGN_RETURN_ENVELOPE_TAB_DATA_FOR_EXISTING_ENVELOPEAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ReturnscheduledsendingrulesforenvelopeDOCUSIGN_RETURN_SCHEDULED_SENDING_RULES_FOR_ENVELOPEAcciónRetrieves the scheduled sending rules for a specific envelope in docusign. this endpoint is used to get information about when and how an envelope is scheduled to be sent, including any delay rules or specific send dates. it's particularly useful for managing automated or timed document workflows. the endpoint returns details such as the bulk list id (if applicable), the resume date, specific rules for sending, and the current status of the scheduled sending job. note that if the specified envelope or workflow step does not have a scheduled sending object, this method will return a 404 error. this tool should be used when you need to check or verify the scheduled sending settings for a particular envelope in your docusign account.
DOCUSIGN_RETURN_SCHEDULED_SENDING_RULES_FOR_ENVELOPEAcciónRetrieves the scheduled sending rules for a specific envelope in docusign. this endpoint is used to get information about when and how an envelope is scheduled to be sent, including any delay rules or specific send dates. it's particularly useful for managing automated or timed document workflows. the endpoint returns details such as the bulk list id (if applicable), the resume date, specific rules for sending, and the current status of the scheduled sending job. note that if the specified envelope or workflow step does not have a scheduled sending object, this method will return a 404 error. this tool should be used when you need to check or verify the scheduled sending settings for a particular envelope in your docusign account.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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"
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Returns document page images based on inputDOCUSIGN_RETURNS_DOCUMENT_PAGE_IMAGES_BASED_ON_INPUTAcciónRetrieves 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.
DOCUSIGN_RETURNS_DOCUMENT_PAGE_IMAGES_BASED_ON_INPUTAcciónRetrieves 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.
Parámetros de entrada
dpistringAn 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.
countstringAn 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.
nocachestringAn 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.
accountIdstringThe 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.
max_widthstringAn 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
max_heightstringAn 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.
show_changesstringAn 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.
start_positionstringAn 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ReturntemplateworkflowdefinitionDOCUSIGN_RETURN_TEMPLATE_WORKFLOW_DEFINITIONAcciónRetrieves 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.
DOCUSIGN_RETURN_TEMPLATE_WORKFLOW_DEFINITIONAcciónRetrieves 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the template. It must be a valid string representing either an integer or a GUID.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Return users from connect serviceDOCUSIGN_RETURN_USERS_FROM_CONNECT_SERVICEAcciónRetrieves users associated with a specific docusign connect configuration for a given account. this endpoint allows account administrators to list and filter users linked to a custom connect setup, providing detailed user information such as email, account details, and user status. it's particularly useful for managing integrations and monitoring user access within a connect configuration. the endpoint supports pagination and various filtering options to handle large user lists efficiently.
DOCUSIGN_RETURN_USERS_FROM_CONNECT_SERVICEAcciónRetrieves users associated with a specific docusign connect configuration for a given account. this endpoint allows account administrators to list and filter users linked to a custom connect setup, providing detailed user information such as email, account details, and user status. it's particularly useful for managing integrations and monitoring user access within a connect configuration. the endpoint supports pagination and various filtering options to handle large user lists efficiently.
Parámetros de entrada
countstringAn 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.
statusstringAn optional filter parameter that allows filtering users based on their account status. It accepts a comma-separated list of statuses including: ActivationRequired, ActivationSent, Active, Closed, and Disabled. This parameter is useful for retrieving users in specific states, such as only active users or users requiring activation.
accountIdstringThe 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 to specify which account"s Connect configuration to query.
connectIdstringObligatorioThe unique identifier for the custom Connect configuration being accessed. This parameter is required and specifies which particular Connect setup"s users should be retrieved.
start_positionstringAn 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.
email_substringstringAn optional filter parameter that allows searching for users based on their email address. The search can match either the full email address or a substring of it. This is useful for finding specific users or groups of users with similar email domains.
list_included_usersstringAn optional parameter whose purpose is not clearly defined in the provided schema. Its usage and possible values should be clarified with the API documentation or support team.
user_name_substringstringAn optional filter parameter that allows searching for users based on their full or partial user name. The search does not require wildcard characters. This is useful for finding specific users when their exact username is not known.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RevokeenvelopecorrectionurlDOCUSIGN_REVOKE_ENVELOPE_CORRECTION_URLAcciónThis 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.
DOCUSIGN_REVOKE_ENVELOPE_CORRECTION_URLAcciónThis 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.
Parámetros de entrada
viewUrlstringaccountIdstringThe 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.
returnUrlstring(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.
envelopeIdstringObligatorioThe 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"
beginOnTaggerstringsuppressNavigationstringSpecifies whether the window is displayed with or without dressing.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Rotate page image for envelopeDOCUSIGN_ROTATE_PAGE_IMAGE_FOR_ENVELOPEAcciónThis 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.
DOCUSIGN_ROTATE_PAGE_IMAGE_FOR_ENVELOPEAcciónThis 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.
Parámetros de entrada
rotatestringSets the direction the page image is rotated. The possible settings are: left or right
passwordstringThe user"s encrypted password hash.
accountIdstringThe 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 envelope belongs to. For example: "12345" or "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6".
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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".
pageNumberstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
RotatetemplatepageimageDOCUSIGN_ROTATE_TEMPLATE_PAGE_IMAGEAcciónRotates 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.
DOCUSIGN_ROTATE_TEMPLATE_PAGE_IMAGEAcciónRotates 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.
Parámetros de entrada
rotatestringSets the direction the page image is rotated. The possible settings are: left or right
passwordstringThe user"s encrypted password hash.
accountIdstringThe 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 is used to specify which account the template belongs to.
documentIdstringObligatorioThe unique identifier of the document within the envelope. 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.
pageNumberstringObligatorioThe 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.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send EnvelopeDOCUSIGN_SEND_ENVELOPEAcciónSends a draft envelope by updating its status to 'sent'. example envelope id format: '93be49ab-xxxx-xxxx-xxxx-f752070d71ec'
DOCUSIGN_SEND_ENVELOPEAcciónSends a draft envelope by updating its status to 'sent'. example envelope id format: '93be49ab-xxxx-xxxx-xxxx-f752070d71ec'
Parámetros de entrada
statusstringThe desired status of the envelope: 'sent' or 'created'
account_idstringObligatorioThe external account number (int) or account ID GUID
envelope_idstringObligatorioThe envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set envelope purge config for accountDOCUSIGN_SET_ENVELOPE_PURGE_CONFIG_FOR_ACCOUNTAcciónSets the envelope purge configuration for a specified docusign account, allowing account administrators to define automatic document removal policies for completed and voided envelopes. this endpoint enables configuration of purge settings, including retention period, pii redaction, and removal of associated tabs and attachments. it should be used when setting up or updating document retention and purging policies for an account. the method requires account administrator privileges and is currently in beta status. note that enabling pii redaction requires also enabling the removal of tabs and envelope attachments.
DOCUSIGN_SET_ENVELOPE_PURGE_CONFIG_FOR_ACCOUNTAcciónSets the envelope purge configuration for a specified docusign account, allowing account administrators to define automatic document removal policies for completed and voided envelopes. this endpoint enables configuration of purge settings, including retention period, pii redaction, and removal of associated tabs and attachments. it should be used when setting up or updating document retention and purging policies for an account. the method requires account administrator privileges and is currently in beta status. note that enabling pii redaction requires also enabling the removal of tabs and envelope attachments.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the envelope purge configuration will be set. This parameter is required and must be provided in the path of the API request.
redactPIIstringWhen **true,** the system also redacts personally identifiable information (PII). **Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.**
retentionDaysstringThe number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`.
purgeEnvelopesstringWhen **true,** purging is enabled.
removeTabsAndEnvelopeAttachmentsstringWhen **true,** the system also purges the tabs and attachments associated with the envelopes.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set initials image for accountless signerDOCUSIGN_SET_INITIALS_IMAGE_FOR_ACCOUNTLESS_SIGNERAcciónThis 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.
DOCUSIGN_SET_INITIALS_IMAGE_FOR_ACCOUNTLESS_SIGNERAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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".
envelopeIdstringObligatorioThe 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".
recipientIdstringObligatorioA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set shared access for users and templatesDOCUSIGN_SET_SHARED_ACCESS_FOR_USERS_AND_TEMPLATESAcciónThis 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.
DOCUSIGN_SET_SHARED_ACCESS_FOR_USERS_AND_TEMPLATESAcciónThis 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.
Parámetros de entrada
nextUristringThe 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.
user_idsstringA 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.
accountIdstringThe account ID associated with the envelope.
item_typestringSpecifies 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.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
sharedAccessobject[]A list of shared access information of envelope and templates for the users specified in the request.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
errorDetails__messagestringA brief message describing the error condition.
errorDetails__errorCodestringThe code associated with the error condition.
preserve_existing_shared_accessstringWhen 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set signature image for no account signerDOCUSIGN_SET_SIGNATURE_IMAGE_FOR_NO_ACCOUNT_SIGNERAcciónThis 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.
DOCUSIGN_SET_SIGNATURE_IMAGE_FOR_NO_ACCOUNT_SIGNERAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
recipientIdstringObligatorioA 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set templates as account favoritesDOCUSIGN_SET_TEMPLATES_AS_ACCOUNT_FAVORITESAcciónThis 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.
DOCUSIGN_SET_TEMPLATES_AS_ACCOUNT_FAVORITESAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
favoriteTemplatesobject[]The favorite templates acted upon by the call.
errorDetails__messagestringA brief message describing the error condition.
templatesUpdatedCountintegerThe number of templates successfully updated by the call. This property is read-only.
errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set up connect oauth configurationDOCUSIGN_SET_UP_CONNECT_OAUTH_CONFIGURATIONAcciónSets up connect oauth configuration for a specified docusign account using a custom authorization server. this endpoint enables secure, oauth-based communication for docusign connect, allowing real-time notifications about envelope status changes. it should be used when integrating docusign connect with your own authorization server for enhanced security and control over webhook notifications. this tool is essential for account administrators setting up or updating connect oauth configurations, but requires connect to be enabled on the account.
DOCUSIGN_SET_UP_CONNECT_OAUTH_CONFIGURATIONAcciónSets up connect oauth configuration for a specified docusign account using a custom authorization server. this endpoint enables secure, oauth-based communication for docusign connect, allowing real-time notifications about envelope status changes. it should be used when integrating docusign connect with your own authorization server for enhanced security and control over webhook notifications. this tool is essential for account administrators setting up or updating connect oauth configurations, but requires connect to be enabled on the account.
Parámetros de entrada
scopestringThe 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`
clientIdstringThe client ID assigned to your app by your authorization server or OAuth service. This property is required.
accountIdstringThe 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.
clientSecretstringThe secret value provided by your authorization server. This property is required.
customParametersstringauthorizationServerUrlstringThe token URL for your authorization server or OAuth service. This property is required.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
SetusersignatureimageDOCUSIGN_SET_USER_SIGNATURE_IMAGEAcciónSets or updates a user's signature image, initials, or stamp in their docusign account. this endpoint allows for customization of various signature elements used in electronic document signing. it supports different image types including full signatures, initials, and stamps, with options for specifying placement and format of date stamps. use this when a user needs to add or modify their signature assets within their docusign account. the endpoint doesn't handle the actual document signing process but focuses on managing the signature assets used in signing.
DOCUSIGN_SET_USER_SIGNATURE_IMAGEAcciónSets or updates a user's signature image, initials, or stamp in their docusign account. this endpoint allows for customization of various signature elements used in electronic document signing. it supports different image types including full signatures, initials, and stamps, with options for specifying placement and format of date stamps. use this when a user needs to add or modify their signature assets within their docusign account. the endpoint doesn't handle the actual document signing process but focuses on managing the signature assets used in signing.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either an external account number (integer) or an account ID GUID (string). Required parameter to specify which account the signature image will be associated with.
imageTypestringObligatorioSpecifies the type of image being set. Must be one of the following values: "stamp_image", "signature_image", or "initials_image". This parameter is required to determine which type of signature element is being updated.
signatureIdstringObligatorioThe unique identifier for the specific signature, initials, or stamp being updated. This is a required parameter to ensure the correct signature element is modified.
transparent_pngstringAn optional query parameter that can be used to specify if the image should be in transparent PNG format. The expected value is a string, but the exact format and usage are not explicitly described in the provided documentation. Use this parameter if you need to ensure the uploaded image has a transparent background.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Share template with groupDOCUSIGN_SHARE_TEMPLATE_WITH_GROUPAcciónThis 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.
DOCUSIGN_SHARE_TEMPLATE_WITH_GROUPAcciónThis 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.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
nextUristringThe 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.
accountIdstringThe 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 helps identify which account the template belongs to and ensures the sharing operation is performed within the correct account context.
templateIdstringObligatorioThe unique identifier of the template to be shared. This parameter is required and must be provided in the path. It specifies which template will have its sharing settings updated. The templateId should be obtained from a previous template creation or listing operation.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
templatePartstringObligatorioSpecifies the part of the template to be shared. For this endpoint, the only valid value is "groups". This parameter is required and must be provided in the path. It indicates that the sharing operation is specifically for granting access to groups.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit batch historical envelopes to webhookDOCUSIGN_SUBMIT_BATCH_HISTORICAL_ENVELOPES_TO_WEBHOOKAcciónThis 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.
DOCUSIGN_SUBMIT_BATCH_HISTORICAL_ENVELOPES_TO_WEBHOOKAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopesstring[]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"]`
config__namestringThe name of the Connect configuration. This property is required.
config__eventsstring[]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](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property. The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) 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`
config__userIdsstring[]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.
config__allUsersstringWhen **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.
config__groupIdsstring[]config__passwordstringThe password for the Connect configuration. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.
config__userNamestringThe name of the user.
config__connectIdstringThe Docusign-generated ID for the Connect configuration. This property is read-only.
config__enableLogstringWhen **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.
config__sfObjectsobject[]An array of Salesforce objects.
config__disabledBystringconfig__includeHMACstringconfig__deliveryModestringThe delivery mode of the configuration. Valid values: * `SIM` * `Aggregate`
config__includeOAuthstringconfig__soapNamespacestringThe namespace of the SOAP interface. **Note:** If `useSoapInterface` is set to **true,** you must set this value.
config__allUsersExceptstringThis 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.**
config__envelopeEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `Delivered` * `Completed` * `Declined` * `Voided` **Note:** These values are case-sensitive.
config__senderOverridestringconfig__urlToPublishTostringThe web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
config__recipientEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `AutoResponded` * `Delivered` * `Completed` * `Declined` * `AuthenticationFailed` **Note:** These values are case-sensitive.
config__externalFolderIdstringThe ID of an external folder.
config__includeDocumentsstringReserved for Docusign.
config__requireMutualTlsstringWhen **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled.
config__useSoapInterfacestringWhen **true,** the notifications are sent to your endpoint as SOAP requests.
config__configurationTypestringThe type of the configuration. Valid values: * `custom`: Creates an account-level configuration * `customrecipient`: Creates a Recipient Connect configuration * `salesforce` * `eOriginal` This property is required.
config__eventData__formatstringReserved for Docusign.
config__integratorManagedstringconfig__eventData__versionstringSet 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.
config__salesforceAuthcodestringconfig__externalFolderLabelstringThe label for an external folder.
config__allowEnvelopePublishstringSet this value to **true** to enable the webhook. The default property is **false.**
config__salesforceApiVersionstringThe version of the Salesforce API that you are using.
config__includeCertSoapHeaderstringconfig__includeDocumentFieldsstringWhen **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.
config__salesforceCallBackUrlstringconfig__senderSelectableItemsstring[]This property sets the items that are available for selection when adding or editing Connect objects.
config__allowSalesforcePublishstringWhen **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.**
config__eventData__includeDatastring[]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](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope. - `recipients`: Include the recipients associated with the envelope. - `tabs`: Include the tabs associated with the envelope.
config__requiresAcknowledgementstringWhen **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.
config__includeEnvelopeVoidReasonstringWhen **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
config__includeTimeZoneInformationstringWhen **true,** Connect will include the envelope time zone information.
config__includeCertificateOfCompletionstringWhen **true,** the Connect Service includes the Certificate of Completion with completed envelopes.
config__signMessageWithX509CertificatestringWhen **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.
config__includeSenderAccountasCustomFieldstringWhen **true,** Connect will include the sender account as Custom Field in the data.
config__salesforceDocumentsAsContentFilesstringWhen **true,** Docusign can use documents in your Salesforce account for sending and signing.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Toggle api request loggingDOCUSIGN_TOGGLE_API_REQUEST_LOGGINGAcciónThis 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.
DOCUSIGN_TOGGLE_API_REQUEST_LOGGINGAcciónThis 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.
Parámetros de entrada
apiRequestLoggingstringWhen **true,** enables API request logging for the user.
apiRequestLogMaxEntriesstringSpecifies the maximum number of API requests to log.
apiRequestLogRemainingEntriesstringIndicates the remaining number of API requests that can be logged.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateaccountbrandsettingsDOCUSIGN_UPDATE_ACCOUNT_BRAND_SETTINGSAcciónThe 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.
DOCUSIGN_UPDATE_ACCOUNT_BRAND_SETTINGSAcciónThe 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.
Parámetros de entrada
linksobject[]An array of `brandLink` objects that contain information about the links that the brand uses.
colorsobject[]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
brandIdstringObligatorioThe ID used to identify a specific brand in API calls.
accountIdstringThe 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.
brandNamestringThe name of the brand.
brandCompanystringThe name of the company associated with the brand.
emailContentobject[]Deprecated.
landingPagesobject[]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.
logos__emailstringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
replace_brandstringA 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.
brandLanguagesstring[]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`)
logos__primarystringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
isSendingDefaultbooleanWhen **true,** the sending brand is the default brand for sending new envelopes.
isSigningDefaultbooleanWhen **true,** the siging brand is the default brand for the signing experience.
logos__secondarystringThe 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](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
resources__emailstringThe URI for the email resource file that the brand uses.
resources__sendingstringThe URI for the sending resource file that the brand uses.
resources__signingstringThe URI for the signing resource file that the brand uses.
isOrganizationBrandstringdefaultBrandLanguagestringThe 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`)
errorDetails__messagestringA brief message describing the error condition.
organizationBrandLogostringerrorDetails__errorCodestringThe code associated with the error condition.
isOverridingCompanyNamebooleanWhen **true,** the `brandCompany` property is overriding the name of the company in the account settings.
resources__signingCaptivestringThe URI for the captive (embedded) signing resource file that the brand uses.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateaccountcustomfieldDOCUSIGN_UPDATE_ACCOUNT_CUSTOM_FIELDAcciónThis 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.
DOCUSIGN_UPDATE_ACCOUNT_CUSTOM_FIELDAcciónThis 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.
Parámetros de entrada
namestringThe name of the custom field.
showstringWhen **true,** the custom field displays at the top of the Certificate of Completion.
valuestringSpecifies the value of the custom field. Maximum Length: 2,000 characters.
fieldIdstringThe ID of the custom field.
requiredstringWhen **true,** the signer must complete the custom field.
accountIdstringThe 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.
listItemsstring[]For a list custom field, this is an array of strings that represent the items in a list. Maximum Length: 2,000 characters.
customFieldIdstringObligatorioThe 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.
customFieldTypestringThe type of custom field. Valid values are: - `text` (default) - `list`
apply_to_templatesstringAn 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".
errorDetails__messagestringA brief message describing the error condition.
errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update account password rulesDOCUSIGN_UPDATE_ACCOUNT_PASSWORD_RULESAcciónThis endpoint updates the password rules for a docusign account. it allows account administrators to modify various password policy settings, including expiration, complexity requirements, lockout durations, and security question requirements. use this endpoint to enhance account security, comply with organizational policies, or adapt to changing security needs. the endpoint provides extensive customization options, from basic password requirements to complex, multi-factor authentication setups. note that changes made through this endpoint will affect all users within the specified account, so it should be used carefully and in accordance with your organization's security policies.
DOCUSIGN_UPDATE_ACCOUNT_PASSWORD_RULESAcciónThis endpoint updates the password rules for a docusign account. it allows account administrators to modify various password policy settings, including expiration, complexity requirements, lockout durations, and security question requirements. use this endpoint to enhance account security, comply with organizational policies, or adapt to changing security needs. the endpoint provides extensive customization options, from basic password requirements to complex, multi-factor authentication setups. note that changes made through this endpoint will affect all users within the specified account, so it should be used carefully and in accordance with your organization's security policies.
Parámetros de entrada
accountIdstringThe 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.
expirePasswordstringWhen **true,** passwords expire. The default value is `false`.
questionsRequiredstringThe number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.
expirePasswordDaysstringThe number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**
lockoutDurationTypestringThe interval associated with the user lockout after a failed login attempt. Possible values are: - `minutes` (default) - `hours` - `days`
passwordIncludeDigitstringWhen **true,** passwords must include a digit. The default value is `false`.
passwordStrengthTypestringThe 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`
minimumPasswordLengthstringThe minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.
lockoutDurationMinutesstringThe number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`.
minimumPasswordAgeDaysstringThe 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`.
passwordIncludeLowerCasestringWhen **true,** passwords must include a lowercase letter. The default value is `false`.
passwordIncludeUpperCasestringWhen **true,** passwords must include an uppercase letter. The default value is `false`.
passwordIncludeSpecialCharacterstringWhen **true,** passwords must include a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
lockoutDurationTypeMetadata__optionsstring[]An array of option strings supported by this setting.
passwordStrengthTypeMetadata__optionsobject[]An array of option strings supported by this setting.
passwordIncludeDigitOrSpecialCharacterstringWhen **true,** passwords must include either a digit or a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
expirePasswordDaysMetadata__maximumDaysstringexpirePasswordDaysMetadata__minimumDaysstringminimumPasswordAgeDaysMetadata__maximumAgestringminimumPasswordAgeDaysMetadata__minimumAgestringquestionsRequiredMetadata__maximumQuestionsstringThe 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`.
questionsRequiredMetadata__minimumQuestionsstringThe 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`.
minimumPasswordLengthMetadata__maximumLengthstringThe maximum number of entry characters supported by the custom tab.
minimumPasswordLengthMetadata__minimumLengthstringMinimum length of the access code string.
lockoutDurationMinutesMetadata__maximumMinutesstringlockoutDurationMinutesMetadata__minimumMinutesstring
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateaccountsettingsDOCUSIGN_UPDATE_ACCOUNT_SETTINGSAcciónUpdates various settings for a specified docusign account. this endpoint allows administrators to configure a wide range of account-level options, including security settings, compliance features, and user interface preferences. use this when you need to modify your docusign account configuration to align with organizational needs and policies. note that many settings require administrative privileges, and some may have interdependencies with other features.
DOCUSIGN_UPDATE_ACCOUNT_SETTINGSAcciónUpdates various settings for a specified docusign account. this endpoint allows administrators to configure a wide range of account-level options, including security settings, compliance features, and user interface preferences. use this when you need to modify your docusign account configuration to align with organizational needs and policies. note that many settings require administrative privileges, and some may have interdependencies with other features.
Parámetros de entrada
usesAPIstringWhen **true,** the account can use the API. **Note:** Only SysAdmin users can change this setting.
allowACEstringbulkSendstringWhen **true,** this user can use the bulk send feature for the account.
accountIdstringThe 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.
exitPromptstringaccountNamestringThe name on the account.
allowMarkupstringWhen **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.
autoNavRulestringSpecifies 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`
enableDSProstringReserved for Docusign.
expressSendstringBoolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.
hidePricingstringBoolean that specifies whether to hide the pricing functionality for an account.
isvOemEmbedstringallowSignNowstringWhen **true,** the account administrator can enable the Sign Now feature.
readOnlyModestringallowBulkSendstringWhen **true,** bulk send functionality is enabled for the account. **Note:** Only Admin users can change this setting.
allowInPersonstringWhen **true,** the account administrator can enable in-person signing. **Note:** Only SysAdmin users can change this setting.
allowWebFormsstringenableAutoNavstringWhen **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.
faxOutEnabledstringWhen **true,** fax delivery to recipients is allowed for the account. **Note:** Only Admin users can change this setting.
idCheckExpirestringDetermines 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.
showTutorialsstringWhen **true,** show tutorials.
adoptSigConfigstringWhen **true,** [Signature Adoption Configuration](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=dsz1583277358168.html) is enabled. **Note:** Only Admin users can change this setting.
allowIDVLevel1stringWhen **true,** IDV Level 1 is allowed. The default value is **false.**
allowIDVLevel2stringallowIDVLevel3stringallowRemindersstringWhen **true,** an account administrator can to turn on reminders and expiration defaults for the account. **Note:** Only Admin users can change this setting.
enableVaultingstringWhen **true,** Vaulting is enabled for the account.
finishReminderstringrsaVeridUserIdstringThe 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.
sessionTimeoutstringThe 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.
signDateFormatstringThe 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.
signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
useDerivedKeysstringReserved for Docusign.
advancedCorrectstringWhen **true,** the Advanced Correction feature is enabled for this account.
allowCDWithdrawstringWhen **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.
allowExpressionstringIf the account plan does not include calculated fields, this setting allows an account to use them.
allowSharedTabsstringWhen **true,** shared tabs are enabled for the account. **Note:** Only Admin users can change this setting.
bccEmailArchivestringBoolean 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.
cfrUseWideImagestringBoolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.
enableClickPlusstringenablePowerFormstringWhen **true,** enables PowerForms for the account. **Note:** Only SysAdmin users can change this setting.
idCheckRequiredstringIndicates 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.
rsaVeridRulesetstringThe 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.
allowAutoTaggingstringWhen **true,** auto-tagging is enabled for the account.
allowIDVPlatformstringallowMergeFieldsstringWhen **true,** the account can use [merge fields](https://support.docusign.com/s/document-item?bundleId=evk1581360654067&topicId=ipy1581360621906.html) with Docusign for Salesforce.
allowSMSDeliverystringcanSelfBrandSendstringWhen **true,** account administrators can self-brand their sending console through the Docusign console.
canSelfBrandSignstringWhen **true,** account administrators can self-brand their signing console through the Docusign console.
convertPdfFieldsstringBoolean 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.
disableMobileAppstringWhen **true,** the mobile app distributor key is prevented from connecting for account users.
enableClickwrapsstringBoolean that specifies whether clickwraps are enabled in your app. A [clickwrap](/docs/click-api/click101/) is an iframe that you embed in your own website or app.
enableWitnessingstringReserved for Docusign.
enforceTlsEmailsstringinSessionEnabledstringWhen **true,** the account can send in-session (embedded) envelopes. **Note:** Only Admin users can change this setting.
rsaVeridPasswordstringThe 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.
setRecipSignLangstringWhen **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.
signTimeShowAmPmstringWhen **true,** the time shows the AM or PM indicator.
signingUiVersionstringReserved for Docusign.
timezoneOffsetUIstringSpecifies 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`
useNewBlobForPdfstringReserved for Docusign.
validationsBrandstringValid values are: - `docusign` - `account`
waterMarkEnabledstringWhen **true,** the [watermark feature](https://support.docusign.com/s/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account) is enabled for the account.
allowDataDownloadstringWhen **true,** senders can download form data from the envelopes that they send. **Note:** Only Admin users can change this setting.
allowEHankoStampsstringWhen **true,** [eHanko stamps](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=dys1578456666697.html) are enabled.
allowRemoteNotarystringdisplayBetaSwitchstringBoolean that specifies whether to display a Beta switch for your app.
documentRetentionstringSets 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.
enableReportLinksstringEnables direct links to envelopes in reports for administrators in the following scopes: - `NoEnvelopes` - `AllEnvelopes` - `OnlyOwnEnvelopes`
enableSendToAgentstringWhen **true,** this account can use the Agent recipient type. **Note:** Only SysAdmin users can change this setting.
enableSignOnPaperstringWhen **true,** a sender can allow signers to use the sign on paper option. **Note:** Only Admin users can change this setting.
idCheckExpireDaysstringThe 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.
setRecipEmailLangstringWhen **true,** senders can set the email language to use for each recipient. **Note:** Only Admin users can change this setting.
socialIdRecipAuthstringWhen **true,** recipients can use [social ids](https://support.docusign.com/guides/signer-authentication) when signing
timezoneOffsetAPIstringSpecifies 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`
validationsReportstringValid values are: - `none` - `life_sciences_part11`
allowManagedStampsstringWhen **true,** [Managed Stamps](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=cex1583277417267.html) are enabled.
allowOrganizationsstringBoolean that specifies whether [Docusign Admin](/docs/admin-api/) is enabled for the account.
allowSigningGroupsstringWhen **true,** the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only.
allowSocialIdLoginstringDeprecated.
allowValueInsightsstringdisableUserSharingstringWhen **true,** the User Sharing feature is disabled for the account.
documentVisibilitystringConfigures 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.**
enableBccDummyLinkstringenableSendToManagestringWhen **true,** this account can use the Editor recipient type. **Note:** Only Admin users can change this setting.
envelopeSearchModestringsignatureProvidersstring[]Names of electronic or digital signature providers that can be used.
signerAttachConcatstringWhen **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.
validationsAllowedstringBoolean that specifies whether validations on recipient email domains are allowed.
validationsCadencestringValid values are: - `none` - `monthly`
validationsEnabledstringWhen **true,** enables validations.
allowConnectOAuthUIstringallowDelayedRoutingstring"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowENoteEOriginalstringSpecifies whether eNote eOriginal integration is enabled.
allowIDVLevel1TrialstringallowMemberTimeZonestringWhen **true,** account users can set their own [time zone settings](https://support.docusign.com/s/articles/How-do-I-modify-time-zone-settings-for-my-account). **Note:** Only Admin users can change this setting.
allowNonUSPhoneAuthstringSpecifies whether users can use international numbers for phone authentication.
allowOfflineSigningstringWhen **true,** [offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch) is enabled for the account. **Note:** Only Admin users can change this setting.
allowSignerReassignstringWhen **true,** the recipient of an envelope sent from this account can reassign it to another person. **Note:** Only Admin users can change this setting.
authenticationCheckstringSets 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.
billingAddress__faxstringA fax number associated with the address, if one is available.
dataPopulationScopestringSpecifies 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.
enableAdmHealthcarestringAccount Level Flag that determines the availability to use ADM Healthcare fields
enableContentSearchstringenableIDFxIntuitKBAstringenableSocialIdLoginstringDeprecated.
enableStrikeThroughstringWhen **true,** enables strikethrough formatting in documents.
rsaVeridAccountNamestringThe 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.
sbsTransactionLevelstringsendingTagsFontNamestringThe 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`
sendingTagsFontSizestringThe 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`
singleSignOnEnabledstringWhen **true,** single sign-on (SSO) is enabled.
useSmartContractsV1stringallowAutoNavSettingsstringWhen **true,** auto-navigation can be enabled for this account.
allowDocGenDocumentsstringallowEnvelopeCorrectstringWhen **true,** the envelope correction feature is enabled. **Note:** Only Admin users can change this setting.
allowServerTemplatesstringWhen **true,** the account can use templates.
allowSignNowMetadatastringMetadata that indicates whether the `allowSignNow` property is editable.
allowSignatureStampsstringWhen **true,** Signature Stamps are enabled. **Note:** Only Admin users can change this setting.
allowSigningInsightsstringbillingAddress__citystringThe user"s city. Maximum length: 40 characters.
disableMobileSendingstringWhen **true,** sending from a mobile application is disabled. **Note:** Only Admin users can change this setting.
emailTemplateVersionstringSpecifies 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.
enableAdvancedSearchstringenablePDFAConversionstringenableReservedDomainstringWhen **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.
enableSignWithNotarystringWhen **true,** Sign with Notary functionality is enabled for the account. **Note:** Only Admin users can change this setting.
enableSmartContractsstringWhen **true,** blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false.**
expressSendAllowTabsstringBoolean 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).
idCheckExpireMinutesstringThe number of minutes before user authentication credentials expire.
identityVerificationobject[]Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>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).
maximumSigningGroupsstringThe 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.
mobileSessionTimeoutstringThe 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.
requireDeclineReasonstringWhen **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.
sendingTagsFontColorstringThe 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`
useAccountLevelEmailstringReserved for Docusign.
useNewEnvelopeSearchstringaccountDateTimeFormatstringUTC date/time format for the account.
allowAccessCodeFormatstringWhen **true,** the configured [Access Code Format](/docs/esign-rest-api/reference/accounts/accounts/get/#accessCodeFormat) page is enabled for account administrators. **Note:** Only Admin users can change this setting.
allowAgreementActionsstringallowDelegatedSigningstringallowRecipientConnectstringallowScheduledSendingstring"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowWhatsAppDeliverystringanchorPopulationScopestringThis 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.
billingAddress__phonestringA phone number associated with the address.
canUseSalesforceOAuthstringcaptureVoiceRecordingstringReserved for Docusign.
disableSignerCertViewstringWhen **true,** signers cannot view certificates of completion.
disableStyleSignaturestringWhen **true,** the **Select Style** option is hidden from signers and they must draw their signature instead.
enableDSigExpressPensstringenableInBrowserEditorstringenablePowerFormDirectstringWhen **true,** enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. **Note:** Only Admin users can change this setting.
idCheckConfigurationsobject[]A list of ID check configuration objects.
mergeMixedModeResultsstringoptInMobileSigningV02stringBoolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.
optOutNewPlatformSealstringBoolean that specifies whether to allow envelope senders to opt out of using the new platform seal.
sharedTemplateFoldersstringBoolean that specifies whether an account can use Shared Template Folders.
signerCanSignOnMobilestringWhen **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting.
signerMustHaveAccountstringWhen **true,** senders can only send an envelope to a recipient that has a Docusign account. **Note:** Only Account Administrators can change this setting.
signerMustLoginToSignstringWhen **true,** signers must log in to the Docusign platform to sign an envelope. **Note:** Only Admin users can change this setting.
signingSessionTimeoutstringThe number of minutes that a signing session stays alive without any activity.
useConsumerDisclosurestringWhen **true,** the account uses an Electronic Record and Signature Disclosure Statement. **Note:** Only Admin users can change this setting.
useMultiAppGroupsDatastringaccountDefaultLanguagestringallowEnvelopeReportingstringSpecifies whether the account has access to reports.
allowPaymentProcessingstringWhen **true,** payment processing is enabled for the account. **Note:** Only Admin users can change this setting.
allowPhoneAuthOverridestringBoolean that specifies whether users can override phone authentication.
allowSecurityAppliancestringBoolean that specifies whether a Docusign Signature Appliance can be used with the account.
allowSigningExtensionsstringBoolean that specifies whether Signing and App Extensions are allowed.
chromeSignatureEnabledstringBoolean that specifies whether the signers of the envelopes from this account use a signature with a Docusign chrome around it or not.
disableUploadSignaturestringWhen **true,** signers cannot upload custom image files of their signature and initials. **Note:** Only Admin users can change this setting.
draftEnvelopeRetentionstringenableAdvancedPaymentsstringWhen **true,** enables Advanced Payments for the account.
enableCalculatedFieldsstringWhen **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.**
enableEsignCommunitiesstringenableLargeFileSupportstringenableScheduledReleasestringWhen **true,** scheduled releases are enabled. The default value is **false.**
enableTransactionPointstringReserved for Docusign.
forbidAddingUserStampsstringguidedFormsHtmlAllowedstringWhen **true,** HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account.
inPersonSigningEnabledstringWhen **true,** in-person signing is enabled for the account.
signerCanCreateAccountstringWhen **true,** a signer can create a Docusign account after signing. **Note:** Only Admin users can change this setting.
startInAdvancedCorrectstringWhen **true,** when initiating correction of an in-flight envelope the sender starts in advanced correct mode.
allowAgentNameEmailEditstringWhen **true,** an agent recipient can change the email addresses of recipients later in the signing order.
allowDocumentVisibilitystringWhen **true,** the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account.
allowSendToIntermediarystringWhen **true,** the account admin can enable the Send to Intermediary feature on the account.
attachCompletedEnvelopestringWhen **true,** envelope documents are included as a PDF file attachment to "signing completed" emails. **Note:** Only SysAdmin users can change this setting.
betaSwitchConfigurationstringReserved for Docusign.
billingAddress__countrystringThe user"s country. Maximum length: 50 characters.
disableMultipleSessionsstringWhen **true,** account users cannot be logged into multiple sessions at the same time. **Note:** Only Admin users can change this setting.
enableAccountWideSearchstringenablePaymentProcessingstringWhen **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.
enableResponsiveSigningstringWhen **true,** enables responsive signing.
enableSMSAuthenticationstringWhen **true,** the account can use SMS authentication. **Note:** Only Admin users can change this setting.
enableSignerAttachmentsstringWhen **true,** users can use the signing attachments feature to request attachments from signers. **Note:** Only Admin users can change this setting.
enableUnifiedRepositorystringhideAccountAddressInCoCstringBoolean that specifies whether to hide the account address in the Certificate of Completion.
inPersonIDCheckQuestionstringA 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.
inSessionSuppressEmailsstringWhen **true,** emails are not sent to the in-session (embedded) recipients on an envelope. **Note:** Only Admin users can change this setting.
maxNumberOfCustomStampsstringThe maximum number of custom stamps.
showLocalizedWatermarksstringBoolean that specifies whether localized watermarks are displayed.
signerLoginRequirementsstringSets 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.
universalSignatureOptInstringReserved for Docusign.
usesAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
usesAPIMetadata__uiHintstringReserved for Docusign.
usesAPIMetadata__uiTypestringReserved for Docusign.
allowACEMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowACEMetadata__uiHintstringReserved for Docusign.
allowACEMetadata__uiTypestringReserved for Docusign.
allowDocumentDisclosuresstringBoolean that specifies whether disclosure documents can be included in envelopes.
allowPhoneAuthenticationstringBoolean that specifies whether phone authentication is enabled for the account.
billingAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
billingAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
billingAddress__zipPlus4stringbulkSendMaxCopiesInBatchstringbulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
bulkSendMetadata__uiHintstringReserved for Docusign.
bulkSendMetadata__uiTypestringReserved for Docusign.
conditionalFieldsEnabledstringWhen **true,** conditional fields can be used in documents. **Note:** Only Admin users can change this setting.
disableSignerHistoryViewstringWhen **true,** signers cannot view envelope history.
enableAdvancedPowerFormsstringWhen **true,** enables advanced PowerForms for the account.
enableContactSuggestionsstringenableDSigEUAdvancedPensstringenableInboxRelevanceSortstringenableRequireSignOnPaperstringWhen **true,** the account can use the `requireSignOnPaper` option. **Note:** Only Admin users can change this setting.
enableSMSDeliveryPrimarystringenableSendToIntermediarystringWhen **true,** this account can use the Intermediary recipient type. **Note:** Only Admin users can change this setting, and only if `allowSendToIntermediary` is set.
externalSignaturePadTypestringSpecifies the signature pad type. Valid values are: - `none` - `topaz` - `e_padv9` - `e_pad_integrisign` - `topaz_sigplusextlite` **Note:** Only Admin users can change this setting.
optInUniversalSignaturesstringpkiSignDownloadedPDFDocsstringThe 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.
recipientsCanSignOfflinestringWhen **true,** recipients receiving envelopes from this account can sign offline. **Note:** Only Admin users can change this setting.
simplifiedSendingEnabledstringWhen **true,** simplified sending is enabled for the account. The default value is **false.**
usesAPIMetadata__optionsstring[]An array of option strings supported by this setting.
usesAPIMetadata__uiOrderstringReserved for Docusign.
allowACEMetadata__optionsstring[]An array of option strings supported by this setting.
allowACEMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeCustomFieldsstringSpecifies whether [envelope custom fields](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=mns1578456285568.html) are enabled.
allowExternalSignaturePadstringWhen **true,** the account can configure and use signature pads for their recipients. **Note:** Only Admin users can change this setting.
allowOrganizationBrandingstringallowPerformanceAnalyticsstringallowPrivateSigningGroupsstringReserved for Docusign. This property returns the value **false** when listing account settings. This property is read-only.
allowResourceFileBrandingstringWhen **true,** resource files can be uploaded in branding.
allowSigningRadioDeselectstringBoolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](/docs/esign-soap-api/reference/sending-group/tab/).
bulkSendActionResendLimitstringbulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
bulkSendMetadata__uiOrderstringReserved for Docusign.
enableAccessCodeGeneratorstringWhen **true,** enables Access Code Generator on the account.
enableSequentialSigningUIstringWhen **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.
enableSignOnPaperOverridestringWhen **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.
enableWebFormsRuntimeAPIsstringspecifyDocumentVisibilitystringWhen **true,** senders can specify the visibility of the documents in an envelope at the recipient level.
useSAFESignerCertificatesstringWhen **true,** signers are required to use SAFE digital signatures.
allowMultipleBrandProfilesstringSpecifies whether the account supports multiple brands.
allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
allowTransactionsWorkspacestringautoProvisionSignerAccountstringBoolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)
billingAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
documentRetentionPurgeTabsstringWhen **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.
enableClickPlusCustomStylestringenableSequentialSigningAPIstringWhen **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.
envelopeIntegrationAllowedstringShows 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.
envelopeIntegrationEnabledstringWhen **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.
exitPromptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
exitPromptMetadata__uiHintstringReserved for Docusign.
exitPromptMetadata__uiTypestringReserved for Docusign.
numberOfActiveCustomStampsstringThe number of active custom stamps associated with the account. Docusign calculates this number automatically. This property is only visible to the Docusign account manager.
pdfMaxIndividualUploadSizestringrequire21CFRpt11CompliancestringWhen **true,** recipients are required to use a 21 CFR part 11-compliant signing experience. **Note:** Only Admin users can change this setting.
skipAuthCompletedEnvelopesstringWhen **true,** do not require authentication prompt for viewing completed envelopes
useEnvelopeSearchMixedModestringaccountNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountNameMetadata__uiHintstringReserved for Docusign.
accountNameMetadata__uiTypestringReserved for Docusign.
allowConnectSendFinishLaterstringReserved for Docusign.
allowExternalLinkedAccountsstringallowMarkupMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowMarkupMetadata__uiHintstringReserved for Docusign.
allowMarkupMetadata__uiTypestringReserved for Docusign.
allowOcrOfEnvelopeDocumentsstringallowSignerReassignOverridestringWhen **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.
allowUsersToAccessDirectorystringautoNavRuleMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
autoNavRuleMetadata__uiHintstringReserved for Docusign.
autoNavRuleMetadata__uiTypestringReserved for Docusign.
commentEmailShowMessageTextstringWhen **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.
consumerDisclosureFrequencystringSpeficies 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`.
disableAutoTemplateMatchingstringenableClickPlusCustomFieldsstringenableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSProMetadata__uiHintstringReserved for Docusign.
enableDSProMetadata__uiTypestringReserved for Docusign.
enableDSigIDCheckForAESPensstringenableSearchServiceAzureUristringenableSearchSiteSpecificApistringexitPromptMetadata__optionsstring[]An array of option strings supported by this setting.
exitPromptMetadata__uiOrderstringReserved for Docusign.
expressSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
expressSendMetadata__uiHintstringReserved for Docusign.
expressSendMetadata__uiTypestringReserved for Docusign.
hidePricingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
hidePricingMetadata__uiHintstringReserved for Docusign.
hidePricingMetadata__uiTypestringReserved for Docusign.
isvOemEmbedMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
isvOemEmbedMetaData__uiHintstringReserved for Docusign.
isvOemEmbedMetaData__uiTypestringReserved for Docusign.
maximumUsersPerSigningGroupstringThe 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.
pdfMaxChunkedUploadPartSizestringsenderCanSignInEachLocationstringWhen **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.
wurflMinAllowableScreenSizestringThe smallest screen allowed.
accountNameMetadata__optionsstring[]An array of option strings supported by this setting.
accountNameMetadata__uiOrderstringReserved for Docusign.
advancedSearchEnableTabFieldstringallowAccountMemberNameChangestringBoolean that specifies whether member names can be changed in the account.
allowAgreementOrchestrationsstringallowConnectUnifiedPayloadUIstringallowEnvelopeCustodyTransferstringSpecifies whether the account is able to manage rules that [transfer ownership](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=xqx1583277378404.html) of envelopes within the same account.
allowMarkupMetadata__optionsstring[]An array of option strings supported by this setting.
allowMarkupMetadata__uiOrderstringReserved for Docusign.
allowSendToCertifiedDeliverystringWhen **true,** the account admin can enable the Send to Certified Delivery feature on the account.
autoNavRuleMetadata__optionsstring[]An array of option strings supported by this setting.
autoNavRuleMetadata__uiOrderstringReserved for Docusign.
defaultSigningResponsiveViewstringenableAgreementActionsForCLMstringenableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSProMetadata__uiOrderstringReserved for Docusign.
enableDSigIDVerificationPensstringenvelopeStampingDefaultValuestringWhen **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.
expressSendMetadata__optionsstring[]An array of option strings supported by this setting.
expressSendMetadata__uiOrderstringReserved for Docusign.
hidePricingMetadata__optionsstring[]An array of option strings supported by this setting.
hidePricingMetadata__uiOrderstringReserved for Docusign.
isvOemEmbedMetaData__optionsstring[]An array of option strings supported by this setting.
isvOemEmbedMetaData__uiOrderstringReserved for Docusign.
pdfMaxChunkedUploadTotalSizestringreadOnlyModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
readOnlyModeMetadata__uiHintstringReserved for Docusign.
readOnlyModeMetadata__uiTypestringReserved for Docusign.
requireSignerCertificateTypestringSets 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.
showConditionalRoutingOnSendstringWhen **true,** Conditional Routing options display to senders during the sending experience.
showInitialConditionalFieldsstringBoolean that specifies whether conditional field options are initially displayed (before a user makes entries).
useSignatureProviderPlatformstringBoolean that specifies whether the account uses the digital signature provider platform to eSign.
allowBulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowBulkSendMetadata__uiHintstringReserved for Docusign.
allowBulkSendMetadata__uiTypestringReserved for Docusign.
allowEnvelopePublishReportingstringWhen **true,** envelope publishing reporting is enabled. **Note:** Only Admin users can change this setting.
allowExpressSignerCertificatestringWhen **true,** signers are required to use Express Digital Signatures. **Note:** Only Admin users can change this setting.
allowInPersonElectronicNotarystringAccount-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
allowInPersonMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowInPersonMetadata__uiHintstringReserved for Docusign.
allowInPersonMetadata__uiTypestringReserved for Docusign.
allowParticipantRecipientTypestringallowSignDocumentFromHomePagestringWhen **true,** recipients can sign documents from the home page. **Note:** Only Admin users can change this setting.
allowWebFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowWebFormsMetadata__uiHintstringReserved for Docusign.
allowWebFormsMetadata__uiTypestringReserved for Docusign.
cfr21SimplifiedSigningEnabledstringcommentsAllowEnvelopeOverridestringWhen **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.
disableBulkSendRecipientLimitstringenableAdvancedEnvelopesSearchstringenableAutoNavMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAutoNavMetadata__uiHintstringReserved for Docusign.
enableAutoNavMetadata__uiTypestringReserved for Docusign.
enableClickPlusDynamicContentstringenableIDFxPhoneAuthenticationstringenableSendingTagsFontSettingsstringWhen **true,** enables fonts to be set on tags for the account.
enforceTemplateNameUniquenessstringWhen **true,** the template name must be unique.
faxOutEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
faxOutEnabledMetadata__uiHintstringReserved for Docusign.
faxOutEnabledMetadata__uiTypestringReserved for Docusign.
idCheckExpireMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idCheckExpireMetadata__uiHintstringReserved for Docusign.
idCheckExpireMetadata__uiTypestringReserved for Docusign.
idfxKBAAuthenticationOverridestringlinkedExternalPrimaryAccountsobject[]readOnlyModeMetadata__optionsstring[]An array of option strings supported by this setting.
readOnlyModeMetadata__uiOrderstringReserved for Docusign.
requireExternalUserManagementstringWhen **true,** the account requires external management of users. **Note:** Only Admin users can change this setting.
senderMustAuthenticateSigningstringWhen **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.
showTutorialsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showTutorialsMetadata__uiHintstringReserved for Docusign.
showTutorialsMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustReadstringWhen **true,** account users must both view and accept supplemental documents when signing.
supplementalDocumentsMustViewstringWhen **true,** account users must view supplemental documents when signing.
adoptSigConfigMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
adoptSigConfigMetadata__uiHintstringReserved for Docusign.
adoptSigConfigMetadata__uiTypestringReserved for Docusign.
allowAccountManagementGranularstringWhen **true,** the account can be managed on a per-user basis. **Note:** Only Admin users can change this setting.
allowBulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
allowBulkSendMetadata__uiOrderstringReserved for Docusign.
allowIDVLevel1Metadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVLevel1Metadata__uiHintstringReserved for Docusign.
allowIDVLevel1Metadata__uiTypestringReserved for Docusign.
allowIDVLevel2Metadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVLevel2Metadata__uiHintstringReserved for Docusign.
allowIDVLevel2Metadata__uiTypestringReserved for Docusign.
allowIDVLevel3Metadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVLevel3Metadata__uiHintstringReserved for Docusign.
allowIDVLevel3Metadata__uiTypestringReserved for Docusign.
allowInPersonMetadata__optionsstring[]An array of option strings supported by this setting.
allowInPersonMetadata__uiOrderstringReserved for Docusign.
allowMultipleSignerAttachmentsstringWhen **true,** recipients can upload multiple signer attachments with a single attachment. **Note:** Only Admin users can change this setting.
allowOrganizationSsoManagementstringallowRemindersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowRemindersMetadata__uiHintstringReserved for Docusign.
allowRemindersMetadata__uiTypestringReserved for Docusign.
allowWebFormsMetadata__optionsstring[]An array of option strings supported by this setting.
allowWebFormsMetadata__uiOrderstringReserved for Docusign.
billingAddressMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
billingAddressMetadata__uiHintstringReserved for Docusign.
billingAddressMetadata__uiTypestringReserved for Docusign.
disableMobilePushNotificationsstringWhen **true,** push notifications are disabled for the account. **Note:** Only Admin users can change this setting.
documentConversionRestrictionsstringSets 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.
enableAgreementActionsForESignstringenableAutoNavMetadata__optionsstring[]An array of option strings supported by this setting.
enableAutoNavMetadata__uiOrderstringReserved for Docusign.
enableSigningExtensionCommentsstringWhen **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.
enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableVaultingMetadata__uiHintstringReserved for Docusign.
enableVaultingMetadata__uiTypestringReserved for Docusign.
faxOutEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
faxOutEnabledMetadata__uiOrderstringReserved for Docusign.
finishReminderMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
finishReminderMetadata__uiHintstringReserved for Docusign.
finishReminderMetadata__uiTypestringReserved for Docusign.
idCheckExpireMetadata__optionsstring[]An array of option strings supported by this setting.
idCheckExpireMetadata__uiOrderstringReserved for Docusign.
ignoreErrorIfAnchorTabNotFoundstringReserved for Docusign.
isConnectDocumentFieldsEnabledstringsendToCertifiedDeliveryEnabledstringWhen true, the account can use the certified deliveries recipient type.
sessionTimeoutMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sessionTimeoutMetadata__uiHintstringReserved for Docusign.
sessionTimeoutMetadata__uiTypestringReserved for Docusign.
showTutorialsMetadata__optionsstring[]An array of option strings supported by this setting.
showTutorialsMetadata__uiOrderstringReserved for Docusign.
signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signDateFormatMetadata__uiHintstringReserved for Docusign.
signDateFormatMetadata__uiTypestringReserved for Docusign.
signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signTimeFormatMetadata__uiHintstringReserved for Docusign.
signTimeFormatMetadata__uiTypestringReserved for Docusign.
suppressCertificateEnforcementstringBoolean that specifies whether or not API calls require a x509 cert in the header of the call.
useDerivedKeysMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useDerivedKeysMetadata__uiHintstringReserved for Docusign.
useDerivedKeysMetadata__uiTypestringReserved for Docusign.
usesAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
writeReminderToEnvelopeHistorystringWhen **true,** sent reminders are included in the envelope history.
accessCodeFormat__minimumLengthstringMinimum length of the access code string.
adoptSigConfigMetadata__optionsstring[]An array of option strings supported by this setting.
adoptSigConfigMetadata__uiOrderstringReserved for Docusign.
advancedCorrectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
advancedCorrectMetadata__uiHintstringReserved for Docusign.
advancedCorrectMetadata__uiTypestringReserved for Docusign.
allowACEMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowCDWithdrawMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowCDWithdrawMetadata__uiHintstringReserved for Docusign.
allowCDWithdrawMetadata__uiTypestringReserved for Docusign.
allowConnectHttpListenerConfigsstringBoolean that specifies whether a Connect configuration can use HTTP listeners.
allowConsumerDisclosureOverridestringWhen **true,** the account has the ability to change the [Consumer Disclosure](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=aqg1583277336549.html) setting.
allowDocumentsOnSignedEnvelopesstringBoolean that specifies whether notifications can include the envelope"s signed document.
allowExpressionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowExpressionMetadata__uiHintstringReserved for Docusign.
allowExpressionMetadata__uiTypestringReserved for Docusign.
allowIDVLevel1Metadata__optionsstring[]An array of option strings supported by this setting.
allowIDVLevel1Metadata__uiOrderstringReserved for Docusign.
allowIDVLevel2Metadata__optionsstring[]An array of option strings supported by this setting.
allowIDVLevel2Metadata__uiOrderstringReserved for Docusign.
allowIDVLevel3Metadata__optionsstring[]An array of option strings supported by this setting.
allowIDVLevel3Metadata__uiOrderstringReserved for Docusign.
allowOpenTrustSignerCertificatestringWhen **true,** senders can use OpenTrust signer certificates. **Note:** Only Admin users can change this setting.
allowRemindersMetadata__optionsstring[]An array of option strings supported by this setting.
allowRemindersMetadata__uiOrderstringReserved for Docusign.
allowSharedTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSharedTabsMetadata__uiHintstringReserved for Docusign.
allowSharedTabsMetadata__uiTypestringReserved for Docusign.
allowThirdPartyElectronicNotarystringAccount level flag that determines the availability to perform Third Party Notary (3PN) actions.
bccEmailArchiveMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
bccEmailArchiveMetadata__uiHintstringReserved for Docusign.
bccEmailArchiveMetadata__uiTypestringReserved for Docusign.
billingAddressMetadata__optionsstring[]An array of option strings supported by this setting.
billingAddressMetadata__uiOrderstringReserved for Docusign.
billingAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
cfrUseWideImageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
cfrUseWideImageMetadata__uiHintstringReserved for Docusign.
cfrUseWideImageMetadata__uiTypestringReserved for Docusign.
checkForMultipleAdminsOnAccountstringenableClickPlusMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickPlusMetaData__uiHintstringReserved for Docusign.
enableClickPlusMetaData__uiTypestringReserved for Docusign.
enableCombinedPDFDownloadForSBSstringenableEnvelopeStampingByDSAdminstringWhen **true,** enables the Docusign administrator to control envelope stamping for an account (placement of the `envelopeId`).
enablePowerFormMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enablePowerFormMetadata__uiHintstringReserved for Docusign.
enablePowerFormMetadata__uiTypestringReserved for Docusign.
enableRecipientDomainValidationstringReserved for Docusign.
enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
enableVaultingMetadata__uiOrderstringReserved for Docusign.
finishReminderMetadata__optionsstring[]An array of option strings supported by this setting.
finishReminderMetadata__uiOrderstringReserved for Docusign.
guidedFormsHtmlConversionPolicystringidCheckRequiredMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idCheckRequiredMetadata__uiHintstringReserved for Docusign.
idCheckRequiredMetadata__uiTypestringReserved for Docusign.
idfxPhoneAuthenticationOverridestringsessionTimeoutMetadata__optionsstring[]An array of option strings supported by this setting.
sessionTimeoutMetadata__uiOrderstringReserved for Docusign.
signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
signDateFormatMetadata__uiOrderstringReserved for Docusign.
signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
signTimeFormatMetadata__uiOrderstringReserved for Docusign.
supplementalDocumentsMustAcceptstringWhen **true,** account users must accept supplemental documents when signing.
useDerivedKeysMetadata__optionsstring[]An array of option strings supported by this setting.
useDerivedKeysMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__formatRequiredstringBoolean specifying whether this format configuration is required.
accessCodeFormat__letterRequiredstringBoolean specifying whether alphabetical characters are required in the access code string.
accessCodeFormat__numberRequiredstringBoolean specifying whether numerical characters (0-9) are required in the access code string.
advancedCorrectMetadata__optionsstring[]An array of option strings supported by this setting.
advancedCorrectMetadata__uiOrderstringReserved for Docusign.
allowAutoTaggingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAutoTaggingMetadata__uiHintstringReserved for Docusign.
allowAutoTaggingMetadata__uiTypestringReserved for Docusign.
allowCDWithdrawMetadata__optionsstring[]An array of option strings supported by this setting.
allowCDWithdrawMetadata__uiOrderstringReserved for Docusign.
allowConnectEnvelopeRemovedEventstringallowExpressionMetadata__optionsstring[]An array of option strings supported by this setting.
allowExpressionMetadata__uiOrderstringReserved for Docusign.
allowExtendedSendingResourceFilestringBoolean that specifies whether resource files can be used for extended sending.
allowIDVForEUQualifiedSignaturesstringallowIDVPlatformMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVPlatformMetadata__uiHintstringReserved for Docusign.
allowIDVPlatformMetadata__uiTypestringReserved for Docusign.
allowMergeFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowMergeFieldsMetadata__uiHintstringReserved for Docusign.
allowMergeFieldsMetadata__uiTypestringReserved for Docusign.
allowOrganizationDocusignMonitorstringallowSMSDeliveryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSMSDeliveryMetadata__uiHintstringReserved for Docusign.
allowSMSDeliveryMetadata__uiTypestringReserved for Docusign.
allowSharedTabsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSharedTabsMetadata__uiOrderstringReserved for Docusign.
bccEmailArchiveMetadata__optionsstring[]An array of option strings supported by this setting.
bccEmailArchiveMetadata__uiOrderstringReserved for Docusign.
canSelfBrandSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSelfBrandSendMetadata__uiHintstringReserved for Docusign.
canSelfBrandSendMetadata__uiTypestringReserved for Docusign.
canSelfBrandSignMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSelfBrandSignMetadata__uiHintstringReserved for Docusign.
canSelfBrandSignMetadata__uiTypestringReserved for Docusign.
cfrUseWideImageMetadata__optionsstring[]An array of option strings supported by this setting.
cfrUseWideImageMetadata__uiOrderstringReserved for Docusign.
convertPdfFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
convertPdfFieldsMetadata__uiHintstringReserved for Docusign.
convertPdfFieldsMetadata__uiTypestringReserved for Docusign.
disableMobileAppMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableMobileAppMetadata__uiHintstringReserved for Docusign.
disableMobileAppMetadata__uiTypestringReserved for Docusign.
enableClickPlusMetaData__optionsstring[]An array of option strings supported by this setting.
enableClickPlusMetaData__uiOrderstringReserved for Docusign.
enableClickwrapsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickwrapsMetadata__uiHintstringReserved for Docusign.
enableClickwrapsMetadata__uiTypestringReserved for Docusign.
enableDataVerificationExtensionsstringenablePowerFormMetadata__optionsstring[]An array of option strings supported by this setting.
enablePowerFormMetadata__uiOrderstringReserved for Docusign.
enableWitnessingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableWitnessingMetadata__uiHintstringReserved for Docusign.
enableWitnessingMetadata__uiTypestringReserved for Docusign.
enforceTlsEmailsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enforceTlsEmailsMetadata__uiHintstringReserved for Docusign.
enforceTlsEmailsMetadata__uiTypestringReserved for Docusign.
hasRecipientConnectClaimedDomainstringidCheckRequiredMetadata__optionsstring[]An array of option strings supported by this setting.
idCheckRequiredMetadata__uiOrderstringReserved for Docusign.
inSessionEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
inSessionEnabledMetadata__uiHintstringReserved for Docusign.
inSessionEnabledMetadata__uiTypestringReserved for Docusign.
selfSignedRecipientEmailDocumentstringSets 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.
sendLockoutRecipientNotificationstringsetRecipSignLangMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
setRecipSignLangMetadata__uiHintstringReserved for Docusign.
setRecipSignLangMetadata__uiTypestringReserved for Docusign.
signTimeShowAmPmMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signTimeShowAmPmMetadata__uiHintstringReserved for Docusign.
signTimeShowAmPmMetadata__uiTypestringReserved for Docusign.
signingUiVersionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signingUiVersionMetadata__uiHintstringReserved for Docusign.
signingUiVersionMetadata__uiTypestringReserved for Docusign.
timezoneOffsetUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneOffsetUIMetadata__uiHintstringReserved for Docusign.
timezoneOffsetUIMetadata__uiTypestringReserved for Docusign.
useNewBlobForPdfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useNewBlobForPdfMetadata__uiHintstringReserved for Docusign.
useNewBlobForPdfMetadata__uiTypestringReserved for Docusign.
validationsBrandMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
validationsBrandMetadata__uiHintstringReserved for Docusign.
validationsBrandMetadata__uiTypestringReserved for Docusign.
waterMarkEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
waterMarkEnabledMetadata__uiHintstringReserved for Docusign.
waterMarkEnabledMetadata__uiTypestringReserved for Docusign.
allowAutoTaggingMetadata__optionsstring[]An array of option strings supported by this setting.
allowAutoTaggingMetadata__uiOrderstringReserved for Docusign.
allowDataDownloadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDataDownloadMetadata__uiHintstringReserved for Docusign.
allowDataDownloadMetadata__uiTypestringReserved for Docusign.
allowEHankoStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEHankoStampsMetadata__uiHintstringReserved for Docusign.
allowEHankoStampsMetadata__uiTypestringReserved for Docusign.
allowIDVPlatformMetadata__optionsstring[]An array of option strings supported by this setting.
allowIDVPlatformMetadata__uiOrderstringReserved for Docusign.
allowMergeFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
allowMergeFieldsMetadata__uiOrderstringReserved for Docusign.
allowPendingDestinationUrlEditionstringallowRemoteNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowRemoteNotaryMetadata__uiHintstringReserved for Docusign.
allowRemoteNotaryMetadata__uiTypestringReserved for Docusign.
allowSMSDeliveryMetadata__optionsstring[]An array of option strings supported by this setting.
allowSMSDeliveryMetadata__uiOrderstringReserved for Docusign.
allowSetEmbeddedRecipientStartURLstringcanSelfBrandSendMetadata__optionsstring[]An array of option strings supported by this setting.
canSelfBrandSendMetadata__uiOrderstringReserved for Docusign.
canSelfBrandSignMetadata__optionsstring[]An array of option strings supported by this setting.
canSelfBrandSignMetadata__uiOrderstringReserved for Docusign.
convertPdfFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
convertPdfFieldsMetadata__uiOrderstringReserved for Docusign.
disableMobileAppMetadata__optionsstring[]An array of option strings supported by this setting.
disableMobileAppMetadata__uiOrderstringReserved for Docusign.
displayBetaSwitchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
displayBetaSwitchMetadata__uiHintstringReserved for Docusign.
displayBetaSwitchMetadata__uiTypestringReserved for Docusign.
documentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
documentRetentionMetadata__uiHintstringReserved for Docusign.
documentRetentionMetadata__uiTypestringReserved for Docusign.
enableClickPlusConditionalContentstringenableClickwrapsMetadata__optionsstring[]An array of option strings supported by this setting.
enableClickwrapsMetadata__uiOrderstringReserved for Docusign.
enableDSigIDCheckRemoteForQESPensstringenableMultiUserRepositoryFeaturesstringenableReportLinksMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableReportLinksMetadata__uiHintstringReserved for Docusign.
enableReportLinksMetadata__uiTypestringReserved for Docusign.
enableSendToAgentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSendToAgentMetadata__uiHintstringReserved for Docusign.
enableSendToAgentMetadata__uiTypestringReserved for Docusign.
enableSignOnPaperMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignOnPaperMetadata__uiHintstringReserved for Docusign.
enableSignOnPaperMetadata__uiTypestringReserved for Docusign.
enableWitnessingMetadata__optionsstring[]An array of option strings supported by this setting.
enableWitnessingMetadata__uiOrderstringReserved for Docusign.
enforceTlsEmailsMetadata__optionsstring[]An array of option strings supported by this setting.
enforceTlsEmailsMetadata__uiOrderstringReserved for Docusign.
exitPromptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idCheckExpireDaysMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idCheckExpireDaysMetadata__uiHintstringReserved for Docusign.
idCheckExpireDaysMetadata__uiTypestringReserved for Docusign.
inSessionEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
inSessionEnabledMetadata__uiOrderstringReserved for Docusign.
setRecipEmailLangMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
setRecipEmailLangMetadata__uiHintstringReserved for Docusign.
setRecipEmailLangMetadata__uiTypestringReserved for Docusign.
setRecipSignLangMetadata__optionsstring[]An array of option strings supported by this setting.
setRecipSignLangMetadata__uiOrderstringReserved for Docusign.
signTimeShowAmPmMetadata__optionsstring[]An array of option strings supported by this setting.
signTimeShowAmPmMetadata__uiOrderstringReserved for Docusign.
signingUiVersionMetadata__optionsstring[]An array of option strings supported by this setting.
signingUiVersionMetadata__uiOrderstringReserved for Docusign.
socialIdRecipAuthMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
socialIdRecipAuthMetadata__uiHintstringReserved for Docusign.
socialIdRecipAuthMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__allowTabOrderstringWhen **true,** account users can set a tab order for the signing process. **Note:** Only Admin users can change this setting.
timezoneOffsetAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneOffsetAPIMetadata__uiHintstringReserved for Docusign.
timezoneOffsetAPIMetadata__uiTypestringReserved for Docusign.
timezoneOffsetUIMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneOffsetUIMetadata__uiOrderstringReserved for Docusign.
useNewBlobForPdfMetadata__optionsstring[]An array of option strings supported by this setting.
useNewBlobForPdfMetadata__uiOrderstringReserved for Docusign.
validationsBrandMetadata__optionsstring[]An array of option strings supported by this setting.
validationsBrandMetadata__uiOrderstringReserved for Docusign.
validationsReportMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
validationsReportMetadata__uiHintstringReserved for Docusign.
validationsReportMetadata__uiTypestringReserved for Docusign.
waterMarkEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
waterMarkEnabledMetadata__uiOrderstringReserved for Docusign.
AllowConnectIdentityVerificationUIstringaccountNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDataDownloadMetadata__optionsstring[]An array of option strings supported by this setting.
allowDataDownloadMetadata__uiOrderstringReserved for Docusign.
allowEHankoStampsMetadata__optionsstring[]An array of option strings supported by this setting.
allowEHankoStampsMetadata__uiOrderstringReserved for Docusign.
allowManagedStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowManagedStampsMetadata__uiHintstringReserved for Docusign.
allowManagedStampsMetadata__uiTypestringReserved for Docusign.
allowMarkupMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseRemoteNotarystringallowOrganizationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationsMetadata__uiHintstringReserved for Docusign.
allowOrganizationsMetadata__uiTypestringReserved for Docusign.
allowRemoteNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowRemoteNotaryMetadata__uiOrderstringReserved for Docusign.
allowSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSigningGroupsMetadata__uiHintstringReserved for Docusign.
allowSigningGroupsMetadata__uiTypestringReserved for Docusign.
allowSocialIdLoginMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSocialIdLoginMetadata__uiHintstringReserved for Docusign.
allowSocialIdLoginMetadata__uiTypestringReserved for Docusign.
allowTransactionsWorkspaceOriginalstringallowValueInsightsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowValueInsightsMetadata__uiHintstringReserved for Docusign.
allowValueInsightsMetadata__uiTypestringReserved for Docusign.
anchorTagVersionedPlacementEnabledstringReserved for Docusign.
autoNavRuleMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableUserSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableUserSharingMetadata__uiHintstringReserved for Docusign.
disableUserSharingMetadata__uiTypestringReserved for Docusign.
displayBetaSwitchMetadata__optionsstring[]An array of option strings supported by this setting.
displayBetaSwitchMetadata__uiOrderstringReserved for Docusign.
documentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
documentRetentionMetadata__uiOrderstringReserved for Docusign.
documentVisibilityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
documentVisibilityMetadata__uiHintstringReserved for Docusign.
documentVisibilityMetadata__uiTypestringReserved for Docusign.
enableBccDummyLinkMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableBccDummyLinkMetadata__uiHintstringReserved for Docusign.
enableBccDummyLinkMetadata__uiTypestringReserved for Docusign.
enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableReportLinksMetadata__optionsstring[]An array of option strings supported by this setting.
enableReportLinksMetadata__uiOrderstringReserved for Docusign.
enableSendToAgentMetadata__optionsstring[]An array of option strings supported by this setting.
enableSendToAgentMetadata__uiOrderstringReserved for Docusign.
enableSendToManageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSendToManageMetadata__uiHintstringReserved for Docusign.
enableSendToManageMetadata__uiTypestringReserved for Docusign.
enableSignOnPaperMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignOnPaperMetadata__uiOrderstringReserved for Docusign.
envelopeSearchModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
envelopeSearchModeMetadata__uiHintstringReserved for Docusign.
envelopeSearchModeMetadata__uiTypestringReserved for Docusign.
expressSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
hidePricingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idCheckExpireDaysMetadata__optionsstring[]An array of option strings supported by this setting.
idCheckExpireDaysMetadata__uiOrderstringReserved for Docusign.
isvOemEmbedMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
setRecipEmailLangMetadata__optionsstring[]An array of option strings supported by this setting.
setRecipEmailLangMetadata__uiOrderstringReserved for Docusign.
signatureProvidersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signatureProvidersMetadata__uiHintstringReserved for Docusign.
signatureProvidersMetadata__uiTypestringReserved for Docusign.
signerAttachConcatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerAttachConcatMetadata__uiHintstringReserved for Docusign.
signerAttachConcatMetadata__uiTypestringReserved for Docusign.
signerShowSecureFieldInitialValuesstringWhen **true,** the initial values of all SecureFields are written to the document when it is sent. **Note:** Only Admin users can change this setting.
socialIdRecipAuthMetadata__optionsstring[]An array of option strings supported by this setting.
socialIdRecipAuthMetadata__uiOrderstringReserved for Docusign.
timezoneOffsetAPIMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneOffsetAPIMetadata__uiOrderstringReserved for Docusign.
useConsumerDisclosureWithinAccountstringWhen **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
validationsAllowedMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
validationsAllowedMetadata__uiHintstringReserved for Docusign.
validationsAllowedMetadata__uiTypestringReserved for Docusign.
validationsCadenceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
validationsCadenceMetadata__uiHintstringReserved for Docusign.
validationsCadenceMetadata__uiTypestringReserved for Docusign.
validationsEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
validationsEnabledMetadata__uiHintstringReserved for Docusign.
validationsEnabledMetadata__uiTypestringReserved for Docusign.
validationsReportMetadata__optionsstring[]An array of option strings supported by this setting.
validationsReportMetadata__uiOrderstringReserved for Docusign.
accountUISettings__askAnAdmin__namestringaccountUISettings__hideUseATemplatestringWhen **true,** the **Templates** menu is hidden from account users who are not Admins. The default value is **false.**
advancedSearchEnableTemplateIdFieldstringallowDelayedRoutingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDelayedRoutingMetadata__uiHintstringReserved for Docusign.
allowDelayedRoutingMetadata__uiTypestringReserved for Docusign.
allowENoteEOriginalMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowENoteEOriginalMetadata__uiHintstringReserved for Docusign.
allowENoteEOriginalMetadata__uiTypestringReserved for Docusign.
allowIDVLevel1TrialMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVLevel1TrialMetadata__uiHintstringReserved for Docusign.
allowIDVLevel1TrialMetadata__uiTypestringReserved for Docusign.
allowManagedStampsMetadata__optionsstring[]An array of option strings supported by this setting.
allowManagedStampsMetadata__uiOrderstringReserved for Docusign.
allowMemberTimeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowMemberTimeZoneMetadata__uiHintstringReserved for Docusign.
allowMemberTimeZoneMetadata__uiTypestringReserved for Docusign.
allowNonUSPhoneAuthMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowNonUSPhoneAuthMetadata__uiHintstringReserved for Docusign.
allowNonUSPhoneAuthMetadata__uiTypestringReserved for Docusign.
allowOfflineSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOfflineSigningMetadata__uiHintstringReserved for Docusign.
allowOfflineSigningMetadata__uiTypestringReserved for Docusign.
allowOrganizationsMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationsMetadata__uiOrderstringReserved for Docusign.
allowSafeBioPharmaSignerCertificatestringWhen **true,** account administrators can specify that signers are required to use SAFE-BioPharma digital signatures. **Note:** Only Admin users can change this setting.
allowSignerReassignMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSignerReassignMetadata__uiHintstringReserved for Docusign.
allowSignerReassignMetadata__uiTypestringReserved for Docusign.
allowSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSigningGroupsMetadata__uiOrderstringReserved for Docusign.
allowSocialIdLoginMetadata__optionsstring[]An array of option strings supported by this setting.
allowSocialIdLoginMetadata__uiOrderstringReserved for Docusign.
allowValueInsightsMetadata__optionsstring[]An array of option strings supported by this setting.
allowValueInsightsMetadata__uiOrderstringReserved for Docusign.
authenticationCheckMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
authenticationCheckMetadata__uiHintstringReserved for Docusign.
authenticationCheckMetadata__uiTypestringReserved for Docusign.
dataPopulationScopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
dataPopulationScopeMetadata__uiHintstringReserved for Docusign.
dataPopulationScopeMetadata__uiTypestringReserved for Docusign.
disableUserSharingMetadata__optionsstring[]An array of option strings supported by this setting.
disableUserSharingMetadata__uiOrderstringReserved for Docusign.
documentVisibilityMetadata__optionsstring[]An array of option strings supported by this setting.
documentVisibilityMetadata__uiOrderstringReserved for Docusign.
enableAdmHealthcareMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdmHealthcareMetadata__uiHintstringReserved for Docusign.
enableAdmHealthcareMetadata__uiTypestringReserved for Docusign.
enableBccDummyLinkMetadata__optionsstring[]An array of option strings supported by this setting.
enableBccDummyLinkMetadata__uiOrderstringReserved for Docusign.
enableContentSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableContentSearchMetadata__uiHintstringReserved for Docusign.
enableContentSearchMetadata__uiTypestringReserved for Docusign.
enableDSigIDCheckInPersonForQESPensstringenableDSigIDVerificationPremierPensstringenableESignAPIHourlyLimitManagementstringenableIDFxIntuitKBAMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableIDFxIntuitKBAMetadata__uiHintstringReserved for Docusign.
enableIDFxIntuitKBAMetadata__uiTypestringReserved for Docusign.
enableSendToManageMetadata__optionsstring[]An array of option strings supported by this setting.
enableSendToManageMetadata__uiOrderstringReserved for Docusign.
enableSigningExtensionConversationsstringWhen **true,** enables conversation functionality.
enableSocialIdLoginMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSocialIdLoginMetadata__uiHintstringReserved for Docusign.
enableSocialIdLoginMetadata__uiTypestringReserved for Docusign.
enableStrikeThroughMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableStrikeThroughMetadata__uiHintstringReserved for Docusign.
enableStrikeThroughMetadata__uiTypestringReserved for Docusign.
envelopeSearchModeMetadata__optionsstring[]An array of option strings supported by this setting.
envelopeSearchModeMetadata__uiOrderstringReserved for Docusign.
optOutAutoNavTextAndTabColorUpdatesstringBoolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.
readOnlyModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sendingTagsFontNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sendingTagsFontNameMetadata__uiHintstringReserved for Docusign.
sendingTagsFontNameMetadata__uiTypestringReserved for Docusign.
sendingTagsFontSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sendingTagsFontSizeMetadata__uiHintstringReserved for Docusign.
sendingTagsFontSizeMetadata__uiTypestringReserved for Docusign.
showCompleteDialogInEmbeddedSessionstringBoolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.
signDateTimeAccountLanguageOverridestringsignDateTimeAccountTimezoneOverridestringsignatureProvidersMetadata__optionsstring[]An array of option strings supported by this setting.
signatureProvidersMetadata__uiOrderstringReserved for Docusign.
signerAttachConcatMetadata__optionsstring[]An array of option strings supported by this setting.
signerAttachConcatMetadata__uiOrderstringReserved for Docusign.
singleSignOnEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
singleSignOnEnabledMetadata__uiHintstringReserved for Docusign.
singleSignOnEnabledMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__drawTabsEnabledstringtabAccountSettings__listTabsEnabledstringWhen **true,** list tabs are enabled.
tabAccountSettings__noteTabsEnabledstringWhen **true,** note tabs are enabled.
tabAccountSettings__tabScaleEnabledstringReserved for Docusign.
tabAccountSettings__textTabsEnabledstringWhen **true,** text tabs are enabled.
useDocuSignExpressSignerCertificatestringWhen **true,** signers are required to use Express Digital Signatures.
validationsAllowedMetadata__optionsstring[]An array of option strings supported by this setting.
validationsAllowedMetadata__uiOrderstringReserved for Docusign.
validationsCadenceMetadata__optionsstring[]An array of option strings supported by this setting.
validationsCadenceMetadata__uiOrderstringReserved for Docusign.
validationsEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
validationsEnabledMetadata__uiOrderstringReserved for Docusign.
accountUISettings__askAnAdmin__emailstringaccountUISettings__askAnAdmin__phonestringallowAutoNavSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAutoNavSettingsMetadata__uiHintstringReserved for Docusign.
allowAutoNavSettingsMetadata__uiTypestringReserved for Docusign.
allowBulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDelayedRoutingMetadata__optionsstring[]An array of option strings supported by this setting.
allowDelayedRoutingMetadata__uiOrderstringReserved for Docusign.
allowDocGenDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDocGenDocumentsMetadata__uiHintstringReserved for Docusign.
allowDocGenDocumentsMetadata__uiTypestringReserved for Docusign.
allowENoteEOriginalMetadata__optionsstring[]An array of option strings supported by this setting.
allowENoteEOriginalMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeCorrectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopeCorrectMetadata__uiHintstringReserved for Docusign.
allowEnvelopeCorrectMetadata__uiTypestringReserved for Docusign.
allowIDVLevel1TrialMetadata__optionsstring[]An array of option strings supported by this setting.
allowIDVLevel1TrialMetadata__uiOrderstringReserved for Docusign.
allowInPersonMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowMemberTimeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
allowMemberTimeZoneMetadata__uiOrderstringReserved for Docusign.
allowNonUSPhoneAuthMetadata__optionsstring[]An array of option strings supported by this setting.
allowNonUSPhoneAuthMetadata__uiOrderstringReserved for Docusign.
allowOfflineSigningMetadata__optionsstring[]An array of option strings supported by this setting.
allowOfflineSigningMetadata__uiOrderstringReserved for Docusign.
allowOrganizationDocusignMonitorFreestringallowServerTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowServerTemplatesMetadata__uiHintstringReserved for Docusign.
allowServerTemplatesMetadata__uiTypestringReserved for Docusign.
allowSignatureStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSignatureStampsMetadata__uiHintstringReserved for Docusign.
allowSignatureStampsMetadata__uiTypestringReserved for Docusign.
allowSignerReassignMetadata__optionsstring[]An array of option strings supported by this setting.
allowSignerReassignMetadata__uiOrderstringReserved for Docusign.
allowSigningInsightsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSigningInsightsMetadata__uiHintstringReserved for Docusign.
allowSigningInsightsMetadata__uiTypestringReserved for Docusign.
allowWebFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
authenticationCheckMetadata__optionsstring[]An array of option strings supported by this setting.
authenticationCheckMetadata__uiOrderstringReserved for Docusign.
bulkSendMaxUnprocessedEnvelopesCountstringdataPopulationScopeMetadata__optionsstring[]An array of option strings supported by this setting.
dataPopulationScopeMetadata__uiOrderstringReserved for Docusign.
defaultToAdvancedEnvelopesFilterFormstringdisableMobileSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableMobileSendingMetadata__uiHintstringReserved for Docusign.
disableMobileSendingMetadata__uiTypestringReserved for Docusign.
emailTemplateVersionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
emailTemplateVersionMetadata__uiHintstringReserved for Docusign.
emailTemplateVersionMetadata__uiTypestringReserved for Docusign.
enableAdmHealthcareMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdmHealthcareMetadata__uiOrderstringReserved for Docusign.
enableAdvancedSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdvancedSearchMetadata__uiHintstringReserved for Docusign.
enableAdvancedSearchMetadata__uiTypestringReserved for Docusign.
enableAutoNavMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableContentSearchMetadata__optionsstring[]An array of option strings supported by this setting.
enableContentSearchMetadata__uiOrderstringReserved for Docusign.
enableEnvelopeStampingByAccountAdminstringWhen **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.**
enableIDFxIntuitKBAMetadata__optionsstring[]An array of option strings supported by this setting.
enableIDFxIntuitKBAMetadata__uiOrderstringReserved for Docusign.
enablePDFAConversionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enablePDFAConversionMetadata__uiHintstringReserved for Docusign.
enablePDFAConversionMetadata__uiTypestringReserved for Docusign.
enableRecipientMayProvidePhoneNumberstringenableReservedDomainMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableReservedDomainMetadata__uiHintstringReserved for Docusign.
enableReservedDomainMetadata__uiTypestringReserved for Docusign.
enableSignWithNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignWithNotaryMetadata__uiHintstringReserved for Docusign.
enableSignWithNotaryMetadata__uiTypestringReserved for Docusign.
enableSigningOrderSettingsForAccountstringWhen **true,** switches Signing Order to On by default for new envelopes.
enableSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSmartContractsMetadata__uiHintstringReserved for Docusign.
enableSmartContractsMetadata__uiTypestringReserved for Docusign.
enableSocialIdLoginMetadata__optionsstring[]An array of option strings supported by this setting.
enableSocialIdLoginMetadata__uiOrderstringReserved for Docusign.
enableStrikeThroughMetadata__optionsstring[]An array of option strings supported by this setting.
enableStrikeThroughMetadata__uiOrderstringReserved for Docusign.
expressSendAllowTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
expressSendAllowTabsMetadata__uiHintstringReserved for Docusign.
expressSendAllowTabsMetadata__uiTypestringReserved for Docusign.
faxOutEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idCheckExpireMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idCheckExpireMinutesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idCheckExpireMinutesMetadata__uiHintstringReserved for Docusign.
idCheckExpireMinutesMetadata__uiTypestringReserved for Docusign.
identityVerificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
identityVerificationMetadata__uiHintstringReserved for Docusign.
identityVerificationMetadata__uiTypestringReserved for Docusign.
maximumSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
maximumSigningGroupsMetadata__uiHintstringReserved for Docusign.
maximumSigningGroupsMetadata__uiTypestringReserved for Docusign.
mobileSessionTimeoutMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mobileSessionTimeoutMetadata__uiHintstringReserved for Docusign.
mobileSessionTimeoutMetadata__uiTypestringReserved for Docusign.
requireDeclineReasonMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
requireDeclineReasonMetadata__uiHintstringReserved for Docusign.
requireDeclineReasonMetadata__uiTypestringReserved for Docusign.
sendingTagsFontColorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sendingTagsFontColorMetadata__uiHintstringReserved for Docusign.
sendingTagsFontColorMetadata__uiTypestringReserved for Docusign.
sendingTagsFontNameMetadata__optionsstring[]An array of option strings supported by this setting.
sendingTagsFontNameMetadata__uiOrderstringReserved for Docusign.
sendingTagsFontSizeMetadata__optionsstring[]An array of option strings supported by this setting.
sendingTagsFontSizeMetadata__uiOrderstringReserved for Docusign.
showTutorialsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerAttachCertificateToEnvelopePDFstringWhen **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.
singleSignOnEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
singleSignOnEnabledMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__radioTabsEnabledstringWhen **true,** radio button tabs are enabled.
useAccountLevelEmailMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useAccountLevelEmailMetadata__uiHintstringReserved for Docusign.
useAccountLevelEmailMetadata__uiTypestringReserved for Docusign.
useNewEnvelopeSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useNewEnvelopeSearchMetadata__uiHintstringReserved for Docusign.
useNewEnvelopeSearchMetadata__uiTypestringReserved for Docusign.
accountDateTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountDateTimeFormatMetadata__uiHintstringReserved for Docusign.
accountDateTimeFormatMetadata__uiTypestringReserved for Docusign.
accountUISettings__enableAdminMessagestringaccountUISettings__hideSendAnEnvelopestringadoptSigConfigMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
advancedSearchEnableTemplateNameFieldstringallowAccessCodeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAccessCodeFormatMetadata__uiHintstringReserved for Docusign.
allowAccessCodeFormatMetadata__uiTypestringReserved for Docusign.
allowAgreementActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAgreementActionsMetadata__uiHintstringReserved for Docusign.
allowAgreementActionsMetadata__uiTypestringReserved for Docusign.
allowAutoNavSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
allowAutoNavSettingsMetadata__uiOrderstringReserved for Docusign.
allowDelegatedSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDelegatedSigningMetadata__uiHintstringReserved for Docusign.
allowDelegatedSigningMetadata__uiTypestringReserved for Docusign.
allowDocGenDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
allowDocGenDocumentsMetadata__uiOrderstringReserved for Docusign.
allowEditingEnvelopesOnBehalfOfOthersstringallowEnvelopeCorrectMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopeCorrectMetadata__uiOrderstringReserved for Docusign.
allowIDVLevel1Metadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowIDVLevel2Metadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowIDVLevel3Metadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDomainUserManagementstringallowRecipientConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowRecipientConnectMetadata__uiHintstringReserved for Docusign.
allowRecipientConnectMetadata__uiTypestringReserved for Docusign.
allowRemindersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowScheduledSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowScheduledSendingMetadata__uiHintstringReserved for Docusign.
allowScheduledSendingMetadata__uiTypestringReserved for Docusign.
allowSendingEnvelopesOnBehalfOfOthersstringallowServerTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
allowServerTemplatesMetadata__uiOrderstringReserved for Docusign.
allowSignatureStampsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSignatureStampsMetadata__uiOrderstringReserved for Docusign.
allowSigningInsightsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSigningInsightsMetadata__uiOrderstringReserved for Docusign.
allowWhatsAppDeliveryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowWhatsAppDeliveryMetadata__uiHintstringReserved for Docusign.
allowWhatsAppDeliveryMetadata__uiTypestringReserved for Docusign.
anchorPopulationScopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
anchorPopulationScopeMetadata__uiHintstringReserved for Docusign.
anchorPopulationScopeMetadata__uiTypestringReserved for Docusign.
billingAddressMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canUseSalesforceOAuthMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canUseSalesforceOAuthMetadata__uiHintstringReserved for Docusign.
canUseSalesforceOAuthMetadata__uiTypestringReserved for Docusign.
captureVoiceRecordingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
captureVoiceRecordingMetadata__uiHintstringReserved for Docusign.
captureVoiceRecordingMetadata__uiTypestringReserved for Docusign.
disableMobileSendingMetadata__optionsstring[]An array of option strings supported by this setting.
disableMobileSendingMetadata__uiOrderstringReserved for Docusign.
disableSignerCertViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableSignerCertViewMetadata__uiHintstringReserved for Docusign.
disableSignerCertViewMetadata__uiTypestringReserved for Docusign.
disableStyleSignatureMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableStyleSignatureMetadata__uiHintstringReserved for Docusign.
disableStyleSignatureMetadata__uiTypestringReserved for Docusign.
emailTemplateVersionMetadata__optionsstring[]An array of option strings supported by this setting.
emailTemplateVersionMetadata__uiOrderstringReserved for Docusign.
enableAdvancedSearchMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdvancedSearchMetadata__uiOrderstringReserved for Docusign.
enableDSigExpressPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigExpressPensMetadata__uiHintstringReserved for Docusign.
enableDSigExpressPensMetadata__uiTypestringReserved for Docusign.
enableIDFxAccountlessSMSAuthForPart11stringenableInBrowserEditorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableInBrowserEditorMetadata__uiHintstringReserved for Docusign.
enableInBrowserEditorMetadata__uiTypestringReserved for Docusign.
enablePDFAConversionMetadata__optionsstring[]An array of option strings supported by this setting.
enablePDFAConversionMetadata__uiOrderstringReserved for Docusign.
enablePowerFormDirectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enablePowerFormDirectMetadata__uiHintstringReserved for Docusign.
enablePowerFormDirectMetadata__uiTypestringReserved for Docusign.
enableReservedDomainMetadata__optionsstring[]An array of option strings supported by this setting.
enableReservedDomainMetadata__uiOrderstringReserved for Docusign.
enableSignWithNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignWithNotaryMetadata__uiOrderstringReserved for Docusign.
enableSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSmartContractsMetadata__uiOrderstringReserved for Docusign.
enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableWebFormsSeparateUserPermissionsstringexpressSendAllowTabsMetadata__optionsstring[]An array of option strings supported by this setting.
expressSendAllowTabsMetadata__uiOrderstringReserved for Docusign.
finishReminderMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idCheckExpireMinutesMetadata__optionsstring[]An array of option strings supported by this setting.
idCheckExpireMinutesMetadata__uiOrderstringReserved for Docusign.
identityVerificationMetadata__optionsstring[]An array of option strings supported by this setting.
identityVerificationMetadata__uiOrderstringReserved for Docusign.
maximumSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
maximumSigningGroupsMetadata__uiOrderstringReserved for Docusign.
mergeMixedModeResultsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeMixedModeResultsMetadata__uiHintstringReserved for Docusign.
mergeMixedModeResultsMetadata__uiTypestringReserved for Docusign.
mobileSessionTimeoutMetadata__optionsstring[]An array of option strings supported by this setting.
mobileSessionTimeoutMetadata__uiOrderstringReserved for Docusign.
optInMobileSigningV02Metadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
optInMobileSigningV02Metadata__uiHintstringReserved for Docusign.
optInMobileSigningV02Metadata__uiTypestringReserved for Docusign.
recipientSigningAutoNavigationControlstringWhen **true,** recipients receiving envelopes from this account can override auto-navigation functionality. **Note:** Only Admin users can change this setting.
requireDeclineReasonMetadata__optionsstring[]An array of option strings supported by this setting.
requireDeclineReasonMetadata__uiOrderstringReserved for Docusign.
sendingTagsFontColorMetadata__optionsstring[]An array of option strings supported by this setting.
sendingTagsFontColorMetadata__uiOrderstringReserved for Docusign.
sessionTimeoutMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sharedTemplateFoldersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sharedTemplateFoldersMetadata__uiHintstringReserved for Docusign.
sharedTemplateFoldersMetadata__uiTypestringReserved for Docusign.
signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerCanSignOnMobileMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerCanSignOnMobileMetadata__uiHintstringReserved for Docusign.
signerCanSignOnMobileMetadata__uiTypestringReserved for Docusign.
signerMustHaveAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerMustHaveAccountMetadata__uiHintstringReserved for Docusign.
signerMustHaveAccountMetadata__uiTypestringReserved for Docusign.
signerMustLoginToSignMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerMustLoginToSignMetadata__uiHintstringReserved for Docusign.
signerMustLoginToSignMetadata__uiTypestringReserved for Docusign.
signingSessionTimeoutMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signingSessionTimeoutMetadata__uiHintstringReserved for Docusign.
signingSessionTimeoutMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabLockingEnabledstringWhen **true,** tab locking is enabled. **Note:** Only Admin users can change this setting.
useAccountLevelEmailMetadata__optionsstring[]An array of option strings supported by this setting.
useAccountLevelEmailMetadata__uiOrderstringReserved for Docusign.
useConsumerDisclosureMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useConsumerDisclosureMetadata__uiHintstringReserved for Docusign.
useConsumerDisclosureMetadata__uiTypestringReserved for Docusign.
useDerivedKeysMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useMultiAppGroupsDataMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useMultiAppGroupsDataMetadata__uiHintstringReserved for Docusign.
useMultiAppGroupsDataMetadata__uiTypestringReserved for Docusign.
useNewEnvelopeSearchMetadata__optionsstring[]An array of option strings supported by this setting.
useNewEnvelopeSearchMetadata__uiOrderstringReserved for Docusign.
accountDateTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
accountDateTimeFormatMetadata__uiOrderstringReserved for Docusign.
accountDefaultLanguageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountDefaultLanguageMetadata__uiHintstringReserved for Docusign.
accountDefaultLanguageMetadata__uiTypestringReserved for Docusign.
accountUISettings__askAnAdmin__messagestringaccountUISettings__enableEnvelopeTypesstringadvancedCorrectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowAccessCodeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
allowAccessCodeFormatMetadata__uiOrderstringReserved for Docusign.
allowAgreementActionsMetadata__optionsstring[]An array of option strings supported by this setting.
allowAgreementActionsMetadata__uiOrderstringReserved for Docusign.
allowCDWithdrawMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDelegatedSigningMetadata__optionsstring[]An array of option strings supported by this setting.
allowDelegatedSigningMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopeReportingMetadata__uiHintstringReserved for Docusign.
allowEnvelopeReportingMetadata__uiTypestringReserved for Docusign.
allowExpressionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowManagingEnvelopesOnBehalfOfOthersstringallowPaymentProcessingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPaymentProcessingMetadata__uiHintstringReserved for Docusign.
allowPaymentProcessingMetadata__uiTypestringReserved for Docusign.
allowPhoneAuthOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPhoneAuthOverrideMetadata__uiHintstringReserved for Docusign.
allowPhoneAuthOverrideMetadata__uiTypestringReserved for Docusign.
allowRecipientConnectMetadata__optionsstring[]An array of option strings supported by this setting.
allowRecipientConnectMetadata__uiOrderstringReserved for Docusign.
allowScheduledSendingMetadata__optionsstring[]An array of option strings supported by this setting.
allowScheduledSendingMetadata__uiOrderstringReserved for Docusign.
allowSecurityApplianceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSecurityApplianceMetadata__uiHintstringReserved for Docusign.
allowSecurityApplianceMetadata__uiTypestringReserved for Docusign.
allowSharedTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSigningExtensionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSigningExtensionsMetadata__uiHintstringReserved for Docusign.
allowSigningExtensionsMetadata__uiTypestringReserved for Docusign.
allowWhatsAppDeliveryMetadata__optionsstring[]An array of option strings supported by this setting.
allowWhatsAppDeliveryMetadata__uiOrderstringReserved for Docusign.
anchorPopulationScopeMetadata__optionsstring[]An array of option strings supported by this setting.
anchorPopulationScopeMetadata__uiOrderstringReserved for Docusign.
bccEmailArchiveMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canUseSalesforceOAuthMetadata__optionsstring[]An array of option strings supported by this setting.
canUseSalesforceOAuthMetadata__uiOrderstringReserved for Docusign.
captureVoiceRecordingMetadata__optionsstring[]An array of option strings supported by this setting.
captureVoiceRecordingMetadata__uiOrderstringReserved for Docusign.
cfrUseWideImageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
chromeSignatureEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
chromeSignatureEnabledMetadata__uiHintstringReserved for Docusign.
chromeSignatureEnabledMetadata__uiTypestringReserved for Docusign.
disableSignerCertViewMetadata__optionsstring[]An array of option strings supported by this setting.
disableSignerCertViewMetadata__uiOrderstringReserved for Docusign.
disableStyleSignatureMetadata__optionsstring[]An array of option strings supported by this setting.
disableStyleSignatureMetadata__uiOrderstringReserved for Docusign.
disableUploadSignatureMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableUploadSignatureMetadata__uiHintstringReserved for Docusign.
disableUploadSignatureMetadata__uiTypestringReserved for Docusign.
draftEnvelopeRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
draftEnvelopeRetentionMetadata__uiHintstringReserved for Docusign.
draftEnvelopeRetentionMetadata__uiTypestringReserved for Docusign.
dss_SIGN_29182_SlideUpBar_RadminOptionstringenableAdvancedPaymentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdvancedPaymentsMetadata__uiHintstringReserved for Docusign.
enableAdvancedPaymentsMetadata__uiTypestringReserved for Docusign.
enableCalculatedFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableCalculatedFieldsMetadata__uiHintstringReserved for Docusign.
enableCalculatedFieldsMetadata__uiTypestringReserved for Docusign.
enableClickPlusMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCommentsHistoryDownloadInSigningstringenableDSigExpressPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigExpressPensMetadata__uiOrderstringReserved for Docusign.
enableEsignCommunitiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableEsignCommunitiesMetadata__uiHintstringReserved for Docusign.
enableEsignCommunitiesMetadata__uiTypestringReserved for Docusign.
enableIdfxPhoneAuthSignatureAuthStatusstringenableInBrowserEditorMetadata__optionsstring[]An array of option strings supported by this setting.
enableInBrowserEditorMetadata__uiOrderstringReserved for Docusign.
enableLargeFileSupportMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableLargeFileSupportMetadata__uiHintstringReserved for Docusign.
enableLargeFileSupportMetadata__uiTypestringReserved for Docusign.
enablePowerFormDirectMetadata__optionsstring[]An array of option strings supported by this setting.
enablePowerFormDirectMetadata__uiOrderstringReserved for Docusign.
enablePowerFormMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableScheduledReleaseMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableScheduledReleaseMetadata__uiHintstringReserved for Docusign.
enableScheduledReleaseMetadata__uiTypestringReserved for Docusign.
enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableTransactionPointMetadata__uiHintstringReserved for Docusign.
enableTransactionPointMetadata__uiTypestringReserved for Docusign.
externalDocumentSources__boxnetEnabledstringThe account is enabled to allow external documents to be attached from BoxNet.
forbidAddingUserStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
forbidAddingUserStampsMetadata__uiHintstringReserved for Docusign.
forbidAddingUserStampsMetadata__uiTypestringReserved for Docusign.
guidedFormsHtmlAllowedMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
guidedFormsHtmlAllowedMetadata__uiHintstringReserved for Docusign.
guidedFormsHtmlAllowedMetadata__uiTypestringReserved for Docusign.
idCheckRequiredMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
inPersonSigningEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
inPersonSigningEnabledMetadata__uiHintstringReserved for Docusign.
inPersonSigningEnabledMetadata__uiTypestringReserved for Docusign.
mergeMixedModeResultsMetadata__optionsstring[]An array of option strings supported by this setting.
mergeMixedModeResultsMetadata__uiOrderstringReserved for Docusign.
optInMobileSigningV02Metadata__optionsstring[]An array of option strings supported by this setting.
optInMobileSigningV02Metadata__uiOrderstringReserved for Docusign.
sharedTemplateFoldersMetadata__optionsstring[]An array of option strings supported by this setting.
sharedTemplateFoldersMetadata__uiOrderstringReserved for Docusign.
signerCanCreateAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerCanCreateAccountMetadata__uiHintstringReserved for Docusign.
signerCanCreateAccountMetadata__uiTypestringReserved for Docusign.
signerCanSignOnMobileMetadata__optionsstring[]An array of option strings supported by this setting.
signerCanSignOnMobileMetadata__uiOrderstringReserved for Docusign.
signerMustHaveAccountMetadata__optionsstring[]An array of option strings supported by this setting.
signerMustHaveAccountMetadata__uiOrderstringReserved for Docusign.
signerMustLoginToSignMetadata__optionsstring[]An array of option strings supported by this setting.
signerMustLoginToSignMetadata__uiOrderstringReserved for Docusign.
signingSessionTimeoutMetadata__optionsstring[]An array of option strings supported by this setting.
signingSessionTimeoutMetadata__uiOrderstringReserved for Docusign.
startInAdvancedCorrectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
startInAdvancedCorrectMetadata__uiHintstringReserved for Docusign.
startInAdvancedCorrectMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__prefillTabsEnabledstringtabAccountSettings__tabLocationEnabledstringReserved for Docusign.
useConsumerDisclosureMetadata__optionsstring[]An array of option strings supported by this setting.
useConsumerDisclosureMetadata__uiOrderstringReserved for Docusign.
useMultiAppGroupsDataMetadata__optionsstring[]An array of option strings supported by this setting.
useMultiAppGroupsDataMetadata__uiOrderstringReserved for Docusign.
useNewEnvelopeSearchOnlyWithSearchTermstringaccountDefaultLanguageMetadata__optionsstring[]An array of option strings supported by this setting.
accountDefaultLanguageMetadata__uiOrderstringReserved for Docusign.
allowAgentNameEmailEditMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAgentNameEmailEditMetadata__uiHintstringReserved for Docusign.
allowAgentNameEmailEditMetadata__uiTypestringReserved for Docusign.
allowAutoTaggingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDocumentVisibilityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDocumentVisibilityMetadata__uiHintstringReserved for Docusign.
allowDocumentVisibilityMetadata__uiTypestringReserved for Docusign.
allowEnvelopeReportingMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopeReportingMetadata__uiOrderstringReserved for Docusign.
allowIDVPlatformMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowMergeFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPaymentProcessingMetadata__optionsstring[]An array of option strings supported by this setting.
allowPaymentProcessingMetadata__uiOrderstringReserved for Docusign.
allowPhoneAuthOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
allowPhoneAuthOverrideMetadata__uiOrderstringReserved for Docusign.
allowSMSDeliveryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSecurityApplianceMetadata__optionsstring[]An array of option strings supported by this setting.
allowSecurityApplianceMetadata__uiOrderstringReserved for Docusign.
allowSendToIntermediaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSendToIntermediaryMetadata__uiHintstringReserved for Docusign.
allowSendToIntermediaryMetadata__uiTypestringReserved for Docusign.
allowSigningExtensionsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSigningExtensionsMetadata__uiOrderstringReserved for Docusign.
attachCompletedEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
attachCompletedEnvelopeMetadata__uiHintstringReserved for Docusign.
attachCompletedEnvelopeMetadata__uiTypestringReserved for Docusign.
betaSwitchConfigurationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
betaSwitchConfigurationMetadata__uiHintstringReserved for Docusign.
betaSwitchConfigurationMetadata__uiTypestringReserved for Docusign.
canSelfBrandSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canSelfBrandSignMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
chromeSignatureEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
chromeSignatureEnabledMetadata__uiOrderstringReserved for Docusign.
convertPdfFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableMobileAppMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableMultipleSessionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableMultipleSessionsMetadata__uiHintstringReserved for Docusign.
disableMultipleSessionsMetadata__uiTypestringReserved for Docusign.
disableUploadSignatureMetadata__optionsstring[]An array of option strings supported by this setting.
disableUploadSignatureMetadata__uiOrderstringReserved for Docusign.
draftEnvelopeRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
draftEnvelopeRetentionMetadata__uiOrderstringReserved for Docusign.
enableAccountWideSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAccountWideSearchMetadata__uiHintstringReserved for Docusign.
enableAccountWideSearchMetadata__uiTypestringReserved for Docusign.
enableAdvancedPaymentsMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdvancedPaymentsMetadata__uiOrderstringReserved for Docusign.
enableCalculatedFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
enableCalculatedFieldsMetadata__uiOrderstringReserved for Docusign.
enableClickwrapsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableEsignCommunitiesMetadata__optionsstring[]An array of option strings supported by this setting.
enableEsignCommunitiesMetadata__uiOrderstringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypestringenableLargeFileSupportMetadata__optionsstring[]An array of option strings supported by this setting.
enableLargeFileSupportMetadata__uiOrderstringReserved for Docusign.
enablePaymentProcessingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enablePaymentProcessingMetadata__uiHintstringReserved for Docusign.
enablePaymentProcessingMetadata__uiTypestringReserved for Docusign.
enablePremiumDataVerificationExtensionsstringenableResponsiveSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableResponsiveSigningMetadata__uiHintstringReserved for Docusign.
enableResponsiveSigningMetadata__uiTypestringReserved for Docusign.
enableSMSAuthenticationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSMSAuthenticationMetadata__uiHintstringReserved for Docusign.
enableSMSAuthenticationMetadata__uiTypestringReserved for Docusign.
enableSMSDeliveryAdditionalNotificationstringenableScheduledReleaseMetadata__optionsstring[]An array of option strings supported by this setting.
enableScheduledReleaseMetadata__uiOrderstringReserved for Docusign.
enableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
enableUnifiedRepositoryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableUnifiedRepositoryMetadata__uiHintstringReserved for Docusign.
enableUnifiedRepositoryMetadata__uiTypestringReserved for Docusign.
enableWitnessingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enforceTlsEmailsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__dropboxEnabledstringThe account is enabled to allow external documents to be attached from DropBox.
forbidAddingUserStampsMetadata__optionsstring[]An array of option strings supported by this setting.
forbidAddingUserStampsMetadata__uiOrderstringReserved for Docusign.
guidedFormsHtmlAllowedMetadata__optionsstring[]An array of option strings supported by this setting.
guidedFormsHtmlAllowedMetadata__uiOrderstringReserved for Docusign.
hideAccountAddressInCoCMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
hideAccountAddressInCoCMetadata__uiHintstringReserved for Docusign.
hideAccountAddressInCoCMetadata__uiTypestringReserved for Docusign.
inPersonIDCheckQuestionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
inPersonIDCheckQuestionMetadata__uiHintstringReserved for Docusign.
inPersonIDCheckQuestionMetadata__uiTypestringReserved for Docusign.
inPersonSigningEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
inPersonSigningEnabledMetadata__uiOrderstringReserved for Docusign.
inSessionEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
inSessionSuppressEmailsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
inSessionSuppressEmailsMetadata__uiHintstringReserved for Docusign.
inSessionSuppressEmailsMetadata__uiTypestringReserved for Docusign.
phoneAuthRecipientMayProvidePhoneNumberstringWhen **true,** senders can allow recipients to provide a phone number for the Phone Authentication process. **Note:** Only Admin users can change this setting.
setRecipSignLangMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showLocalizedWatermarksMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showLocalizedWatermarksMetadata__uiHintstringReserved for Docusign.
showLocalizedWatermarksMetadata__uiTypestringReserved for Docusign.
signTimeShowAmPmMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerCanCreateAccountMetadata__optionsstring[]An array of option strings supported by this setting.
signerCanCreateAccountMetadata__uiOrderstringReserved for Docusign.
signerInSessionUseEnvelopeCompleteEmailstringWhen **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.
signerLoginRequirementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerLoginRequirementsMetadata__uiHintstringReserved for Docusign.
signerLoginRequirementsMetadata__uiTypestringReserved for Docusign.
signingUiVersionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
startInAdvancedCorrectMetadata__optionsstring[]An array of option strings supported by this setting.
startInAdvancedCorrectMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__checkboxTabsEnabledstringWhen **true,** checkbox tabs are enabled.
tabAccountSettings__tabDataLabelEnabledstringWhen **true,** [data labels](https://support.docusign.com/en/videos/Data-Labels) are enabled. **Note:** Only Admin users can change this setting.
timezoneOffsetUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useNewBlobForPdfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
validationsBrandMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
waterMarkEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountNotification__userOverrideEnabledstringWhen **true,** the user can override envelope expirations.
allowAdvancedRecipientRoutingConditionalstringWhen **true,** [Conditional Routing](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=aqm1578456487908.html) is enabled for the account as part of Docusign"s Advanced Recipient Routing feature.
allowAgentNameEmailEditMetadata__optionsstring[]An array of option strings supported by this setting.
allowAgentNameEmailEditMetadata__uiOrderstringReserved for Docusign.
allowDataDownloadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDocumentDisclosuresMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDocumentDisclosuresMetadata__uiHintstringReserved for Docusign.
allowDocumentDisclosuresMetadata__uiTypestringReserved for Docusign.
allowDocumentVisibilityMetadata__optionsstring[]An array of option strings supported by this setting.
allowDocumentVisibilityMetadata__uiOrderstringReserved for Docusign.
allowEHankoStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPhoneAuthenticationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPhoneAuthenticationMetadata__uiHintstringReserved for Docusign.
allowPhoneAuthenticationMetadata__uiTypestringReserved for Docusign.
allowRemoteNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendToIntermediaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowSendToIntermediaryMetadata__uiOrderstringReserved for Docusign.
attachCompletedEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
attachCompletedEnvelopeMetadata__uiOrderstringReserved for Docusign.
betaSwitchConfigurationMetadata__optionsstring[]An array of option strings supported by this setting.
betaSwitchConfigurationMetadata__uiOrderstringReserved for Docusign.
conditionalFieldsEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
conditionalFieldsEnabledMetadata__uiHintstringReserved for Docusign.
conditionalFieldsEnabledMetadata__uiTypestringReserved for Docusign.
disableMultipleSessionsMetadata__optionsstring[]An array of option strings supported by this setting.
disableMultipleSessionsMetadata__uiOrderstringReserved for Docusign.
disableSignerHistoryViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableSignerHistoryViewMetadata__uiHintstringReserved for Docusign.
disableSignerHistoryViewMetadata__uiTypestringReserved for Docusign.
displayBetaSwitchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
documentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAccountWideSearchMetadata__optionsstring[]An array of option strings supported by this setting.
enableAccountWideSearchMetadata__uiOrderstringReserved for Docusign.
enableAdditionalAdvancedWebFormsFeaturesstringenableAdvancedPowerFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdvancedPowerFormsMetadata__uiHintstringReserved for Docusign.
enableAdvancedPowerFormsMetadata__uiTypestringReserved for Docusign.
enableContactSuggestionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableContactSuggestionsMetadata__uiHintstringReserved for Docusign.
enableContactSuggestionsMetadata__uiTypestringReserved for Docusign.
enableCustomerSatisfactionMetricTrackingstringWhen **true,** enables customer satisfaction metric tracking for the account.
enableDSigEUAdvancedPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigEUAdvancedPensMetadata__uiHintstringReserved for Docusign.
enableDSigEUAdvancedPensMetadata__uiTypestringReserved for Docusign.
enableInboxRelevanceSortMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableInboxRelevanceSortMetadata__uiHintstringReserved for Docusign.
enableInboxRelevanceSortMetadata__uiTypestringReserved for Docusign.
enablePaymentProcessingMetadata__optionsstring[]An array of option strings supported by this setting.
enablePaymentProcessingMetadata__uiOrderstringReserved for Docusign.
enableReportLinksMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableRequireSignOnPaperMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableRequireSignOnPaperMetadata__uiHintstringReserved for Docusign.
enableRequireSignOnPaperMetadata__uiTypestringReserved for Docusign.
enableResponsiveSigningMetadata__optionsstring[]An array of option strings supported by this setting.
enableResponsiveSigningMetadata__uiOrderstringReserved for Docusign.
enableSMSAuthenticationMetadata__optionsstring[]An array of option strings supported by this setting.
enableSMSAuthenticationMetadata__uiOrderstringReserved for Docusign.
enableSendToAgentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSendToIntermediaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSendToIntermediaryMetadata__uiHintstringReserved for Docusign.
enableSendToIntermediaryMetadata__uiTypestringReserved for Docusign.
enableSignOnPaperMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
enableUnifiedRepositoryMetadata__optionsstring[]An array of option strings supported by this setting.
enableUnifiedRepositoryMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__oneDriveEnabledstringThe account is enabled to allow external documents to be attached from OneDrive.
externalSignaturePadTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalSignaturePadTypeMetadata__uiHintstringReserved for Docusign.
externalSignaturePadTypeMetadata__uiTypestringReserved for Docusign.
hideAccountAddressInCoCMetadata__optionsstring[]An array of option strings supported by this setting.
hideAccountAddressInCoCMetadata__uiOrderstringReserved for Docusign.
idCheckExpireDaysMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
inPersonIDCheckQuestionMetadata__optionsstring[]An array of option strings supported by this setting.
inPersonIDCheckQuestionMetadata__uiOrderstringReserved for Docusign.
inSessionSuppressEmailsMetadata__optionsstring[]An array of option strings supported by this setting.
inSessionSuppressEmailsMetadata__uiOrderstringReserved for Docusign.
pkiSignDownloadedPDFDocsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
pkiSignDownloadedPDFDocsMetadata__uiHintstringReserved for Docusign.
pkiSignDownloadedPDFDocsMetadata__uiTypestringReserved for Docusign.
recipientsCanSignOfflineMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
recipientsCanSignOfflineMetadata__uiHintstringReserved for Docusign.
recipientsCanSignOfflineMetadata__uiTypestringReserved for Docusign.
setRecipEmailLangMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showLocalizedWatermarksMetadata__optionsstring[]An array of option strings supported by this setting.
showLocalizedWatermarksMetadata__uiOrderstringReserved for Docusign.
signerLoginRequirementsMetadata__optionsstring[]An array of option strings supported by this setting.
signerLoginRequirementsMetadata__uiOrderstringReserved for Docusign.
simplifiedSendingEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
simplifiedSendingEnabledMetadata__uiHintstringReserved for Docusign.
simplifiedSendingEnabledMetadata__uiTypestringReserved for Docusign.
socialIdRecipAuthMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__dataFieldSizeEnabledstringWhen **true,** setting character limits for input fields is enabled.
tabAccountSettings__numericalTabsEnabledstringtimezoneOffsetAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
validationsReportMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__clickwrapSchemaVersionstringaccountUISettings__shouldRedactAccessCodestringallowDocumentDisclosuresMetadata__optionsstring[]An array of option strings supported by this setting.
allowDocumentDisclosuresMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeCustomFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopeCustomFieldsMetadata__uiHintstringReserved for Docusign.
allowEnvelopeCustomFieldsMetadata__uiTypestringReserved for Docusign.
allowExternalSignaturePadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowExternalSignaturePadMetadata__uiHintstringReserved for Docusign.
allowExternalSignaturePadMetadata__uiTypestringReserved for Docusign.
allowManagedStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationBrandingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationBrandingMetadata__uiHintstringReserved for Docusign.
allowOrganizationBrandingMetadata__uiTypestringReserved for Docusign.
allowOrganizationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPerformanceAnalyticsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPerformanceAnalyticsMetadata__uiHintstringReserved for Docusign.
allowPerformanceAnalyticsMetadata__uiTypestringReserved for Docusign.
allowPhoneAuthenticationMetadata__optionsstring[]An array of option strings supported by this setting.
allowPhoneAuthenticationMetadata__uiOrderstringReserved for Docusign.
allowPrivateSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPrivateSigningGroupsMetadata__uiHintstringReserved for Docusign.
allowPrivateSigningGroupsMetadata__uiTypestringReserved for Docusign.
allowResourceFileBrandingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowResourceFileBrandingMetadata__uiHintstringReserved for Docusign.
allowResourceFileBrandingMetadata__uiTypestringReserved for Docusign.
allowSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSigningRadioDeselectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSigningRadioDeselectMetadata__uiHintstringReserved for Docusign.
allowSigningRadioDeselectMetadata__uiTypestringReserved for Docusign.
allowSocialIdLoginMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowValueInsightsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
conditionalFieldsEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
conditionalFieldsEnabledMetadata__uiOrderstringReserved for Docusign.
disableSignerHistoryViewMetadata__optionsstring[]An array of option strings supported by this setting.
disableSignerHistoryViewMetadata__uiOrderstringReserved for Docusign.
disableUserSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
documentVisibilityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAccessCodeGeneratorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAccessCodeGeneratorMetadata__uiHintstringReserved for Docusign.
enableAccessCodeGeneratorMetadata__uiTypestringReserved for Docusign.
enableAdvancedPowerFormsMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdvancedPowerFormsMetadata__uiOrderstringReserved for Docusign.
enableBccDummyLinkMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableContactSuggestionsMetadata__optionsstring[]An array of option strings supported by this setting.
enableContactSuggestionsMetadata__uiOrderstringReserved for Docusign.
enableDSigEUAdvancedPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigEUAdvancedPensMetadata__uiOrderstringReserved for Docusign.
enableInboxRelevanceSortMetadata__optionsstring[]An array of option strings supported by this setting.
enableInboxRelevanceSortMetadata__uiOrderstringReserved for Docusign.
enableRequireSignOnPaperMetadata__optionsstring[]An array of option strings supported by this setting.
enableRequireSignOnPaperMetadata__uiOrderstringReserved for Docusign.
enableSendToIntermediaryMetadata__optionsstring[]An array of option strings supported by this setting.
enableSendToIntermediaryMetadata__uiOrderstringReserved for Docusign.
enableSendToManageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
enableWebFormsRuntimeAPIsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableWebFormsRuntimeAPIsMetadata__uiHintstringReserved for Docusign.
enableWebFormsRuntimeAPIsMetadata__uiTypestringReserved for Docusign.
envelopeSearchModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalSignaturePadTypeMetadata__optionsstring[]An array of option strings supported by this setting.
externalSignaturePadTypeMetadata__uiOrderstringReserved for Docusign.
pkiSignDownloadedPDFDocsMetadata__optionsstring[]An array of option strings supported by this setting.
pkiSignDownloadedPDFDocsMetadata__uiOrderstringReserved for Docusign.
recipientsCanSignOfflineMetadata__optionsstring[]An array of option strings supported by this setting.
recipientsCanSignOfflineMetadata__uiOrderstringReserved for Docusign.
signatureProvidersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerAttachConcatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
simplifiedSendingEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
simplifiedSendingEnabledMetadata__uiOrderstringReserved for Docusign.
specifyDocumentVisibilityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
specifyDocumentVisibilityMetadata__uiHintstringReserved for Docusign.
specifyDocumentVisibilityMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__dataFieldRegexEnabledstringWhen **true,** regular expressions are enabled for tabs that contain data fields.
useSAFESignerCertificatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useSAFESignerCertificatesMetadata__uiHintstringReserved for Docusign.
useSAFESignerCertificatesMetadata__uiTypestringReserved for Docusign.
validationsAllowedMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
validationsCadenceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
validationsEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
EnvelopeLimitsTotalDocumentSizeAllowedInMBstringaccessCodeFormat__specialCharacterRequiredstringBoolean specifying whether special characters are required in the access code string. The string cannot contain the special characters "<", ">", "&", or "#".
allowDelayedRoutingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowENoteEOriginalMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopeCustomFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopeCustomFieldsMetadata__uiOrderstringReserved for Docusign.
allowExternalSignaturePadMetadata__optionsstring[]An array of option strings supported by this setting.
allowExternalSignaturePadMetadata__uiOrderstringReserved for Docusign.
allowIDVLevel1TrialMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowMemberTimeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowMultipleBrandProfilesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowMultipleBrandProfilesMetadata__uiHintstringReserved for Docusign.
allowMultipleBrandProfilesMetadata__uiTypestringReserved for Docusign.
allowNonUSPhoneAuthMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOfflineSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationBrandingMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationBrandingMetadata__uiOrderstringReserved for Docusign.
allowPerformanceAnalyticsMetadata__optionsstring[]An array of option strings supported by this setting.
allowPerformanceAnalyticsMetadata__uiOrderstringReserved for Docusign.
allowPrivateSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
allowPrivateSigningGroupsMetadata__uiOrderstringReserved for Docusign.
allowResourceFileBrandingMetadata__optionsstring[]An array of option strings supported by this setting.
allowResourceFileBrandingMetadata__uiOrderstringReserved for Docusign.
allowSignerReassignMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSigningRadioDeselectMetadata__optionsstring[]An array of option strings supported by this setting.
allowSigningRadioDeselectMetadata__uiOrderstringReserved for Docusign.
allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
allowTransactionsWorkspaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowTransactionsWorkspaceMetadata__uiHintstringReserved for Docusign.
allowTransactionsWorkspaceMetadata__uiTypestringReserved for Docusign.
authenticationCheckMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
autoProvisionSignerAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
autoProvisionSignerAccountMetadata__uiHintstringReserved for Docusign.
autoProvisionSignerAccountMetadata__uiTypestringReserved for Docusign.
dataPopulationScopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAccessCodeGeneratorMetadata__optionsstring[]An array of option strings supported by this setting.
enableAccessCodeGeneratorMetadata__uiOrderstringReserved for Docusign.
enableAdmHealthcareMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableClickPlusCustomStyleMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickPlusCustomStyleMetaData__uiHintstringReserved for Docusign.
enableClickPlusCustomStyleMetaData__uiTypestringReserved for Docusign.
enableContentSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIDFxIntuitKBAMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
enableSocialIdLoginMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableStrikeThroughMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableWebFormsRuntimeAPIsMetadata__optionsstring[]An array of option strings supported by this setting.
enableWebFormsRuntimeAPIsMetadata__uiOrderstringReserved for Docusign.
envelopeIntegrationAllowedMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
envelopeIntegrationAllowedMetadata__uiHintstringReserved for Docusign.
envelopeIntegrationAllowedMetadata__uiTypestringReserved for Docusign.
envelopeIntegrationEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
envelopeIntegrationEnabledMetadata__uiHintstringReserved for Docusign.
envelopeIntegrationEnabledMetadata__uiTypestringReserved for Docusign.
externalDocumentSources__salesforceEnabledstringThe account is enabled to allow external documents to be attached from Salesforce.
pdfMaxIndividualUploadSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
pdfMaxIndividualUploadSizeMetadata__uiHintstringReserved for Docusign.
pdfMaxIndividualUploadSizeMetadata__uiTypestringReserved for Docusign.
require21CFRpt11ComplianceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
require21CFRpt11ComplianceMetadata__uiHintstringReserved for Docusign.
require21CFRpt11ComplianceMetadata__uiTypestringReserved for Docusign.
sendingTagsFontNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sendingTagsFontSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
singleSignOnEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
skipAuthCompletedEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
skipAuthCompletedEnvelopesMetadata__uiHintstringReserved for Docusign.
skipAuthCompletedEnvelopesMetadata__uiTypestringReserved for Docusign.
specifyDocumentVisibilityMetadata__optionsstring[]An array of option strings supported by this setting.
specifyDocumentVisibilityMetadata__uiOrderstringReserved for Docusign.
useEnvelopeSearchMixedModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useEnvelopeSearchMixedModeMetadata__uiHintstringReserved for Docusign.
useEnvelopeSearchMixedModeMetadata__uiTypestringReserved for Docusign.
useSAFESignerCertificatesMetadata__optionsstring[]An array of option strings supported by this setting.
useSAFESignerCertificatesMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableLegacySendflowLinkstringaccountUISettings__removeEnvelopeForwardingstringallowAutoNavSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowConnectSendFinishLaterMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowConnectSendFinishLaterMetadata__uiHintstringReserved for Docusign.
allowConnectSendFinishLaterMetadata__uiTypestringReserved for Docusign.
allowDocGenDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopeCorrectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowExternalLinkedAccountsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowExternalLinkedAccountsMetadata__uiHintstringReserved for Docusign.
allowExternalLinkedAccountsMetadata__uiTypestringReserved for Docusign.
allowMultipleBrandProfilesMetadata__optionsstring[]An array of option strings supported by this setting.
allowMultipleBrandProfilesMetadata__uiOrderstringReserved for Docusign.
allowOcrOfEnvelopeDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOcrOfEnvelopeDocumentsMetadata__uiHintstringReserved for Docusign.
allowOcrOfEnvelopeDocumentsMetadata__uiTypestringReserved for Docusign.
allowServerTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSignatureStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSignerReassignOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSignerReassignOverrideMetadata__uiHintstringReserved for Docusign.
allowSignerReassignOverrideMetadata__uiTypestringReserved for Docusign.
allowSigningInsightsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
allowTransactionsWorkspaceMetadata__optionsstring[]An array of option strings supported by this setting.
allowTransactionsWorkspaceMetadata__uiOrderstringReserved for Docusign.
allowUsersToAccessDirectoryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowUsersToAccessDirectoryMetadata__uiHintstringReserved for Docusign.
allowUsersToAccessDirectoryMetadata__uiTypestringReserved for Docusign.
autoProvisionSignerAccountMetadata__optionsstring[]An array of option strings supported by this setting.
autoProvisionSignerAccountMetadata__uiOrderstringReserved for Docusign.
commentEmailShowMessageTextMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
commentEmailShowMessageTextMetadata__uiHintstringReserved for Docusign.
commentEmailShowMessageTextMetadata__uiTypestringReserved for Docusign.
consumerDisclosureFrequencyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
consumerDisclosureFrequencyMetadata__uiHintstringReserved for Docusign.
consumerDisclosureFrequencyMetadata__uiTypestringReserved for Docusign.
disableAutoTemplateMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableAutoTemplateMatchingMetadata__uiHintstringReserved for Docusign.
disableAutoTemplateMatchingMetadata__uiTypestringReserved for Docusign.
disableMobileSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerbstringemailTemplateVersionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdvancedSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableClickPlusCustomFieldsMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickPlusCustomFieldsMetaData__uiHintstringReserved for Docusign.
enableClickPlusCustomFieldsMetaData__uiTypestringReserved for Docusign.
enableClickPlusCustomStyleMetaData__optionsstring[]An array of option strings supported by this setting.
enableClickPlusCustomStyleMetaData__uiOrderstringReserved for Docusign.
enableDSigIDCheckForAESPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigIDCheckForAESPensMetadata__uiHintstringReserved for Docusign.
enableDSigIDCheckForAESPensMetadata__uiTypestringReserved for Docusign.
enablePDFAConversionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableReservedDomainMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSearchServiceAzureUriMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSearchServiceAzureUriMetadata__uiHintstringReserved for Docusign.
enableSearchServiceAzureUriMetadata__uiTypestringReserved for Docusign.
enableSearchSiteSpecificApiMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSearchSiteSpecificApiMetadata__uiHintstringReserved for Docusign.
enableSearchSiteSpecificApiMetadata__uiTypestringReserved for Docusign.
enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
enableSignWithNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
envelopeIntegrationAllowedMetadata__optionsstring[]An array of option strings supported by this setting.
envelopeIntegrationAllowedMetadata__uiOrderstringReserved for Docusign.
envelopeIntegrationEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
envelopeIntegrationEnabledMetadata__uiOrderstringReserved for Docusign.
expressSendAllowTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__googleDriveEnabledstringThe account is enabled to allow external documents to be attached from Google Drive.
idCheckExpireMinutesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
identityVerificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
maximumSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
maximumUsersPerSigningGroupMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
maximumUsersPerSigningGroupMetadata__uiHintstringReserved for Docusign.
maximumUsersPerSigningGroupMetadata__uiTypestringReserved for Docusign.
mobileSessionTimeoutMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
pdfMaxChunkedUploadPartSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
pdfMaxChunkedUploadPartSizeMetadata__uiHintstringReserved for Docusign.
pdfMaxChunkedUploadPartSizeMetadata__uiTypestringReserved for Docusign.
pdfMaxIndividualUploadSizeMetadata__optionsstring[]An array of option strings supported by this setting.
pdfMaxIndividualUploadSizeMetadata__uiOrderstringReserved for Docusign.
require21CFRpt11ComplianceMetadata__optionsstring[]An array of option strings supported by this setting.
require21CFRpt11ComplianceMetadata__uiOrderstringReserved for Docusign.
requireDeclineReasonMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderCanSignInEachLocationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
senderCanSignInEachLocationMetadata__uiHintstringReserved for Docusign.
senderCanSignInEachLocationMetadata__uiTypestringReserved for Docusign.
sendingTagsFontColorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
skipAuthCompletedEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
skipAuthCompletedEnvelopesMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__calculatedFieldsEnabledstringWhen **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs.
tabAccountSettings__savingCustomTabsEnabledstringWhen **true,** saving custom tabs is enabled.
tabAccountSettings__sharedCustomTabsEnabledstringWhen **true,** shared custom tabs are enabled.
useAccountLevelEmailMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useEnvelopeSearchMixedModeMetadata__optionsstring[]An array of option strings supported by this setting.
useEnvelopeSearchMixedModeMetadata__uiOrderstringReserved for Docusign.
useNewEnvelopeSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
wurflMinAllowableScreenSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
wurflMinAllowableScreenSizeMetadata__uiHintstringReserved for Docusign.
wurflMinAllowableScreenSizeMetadata__uiTypestringReserved for Docusign.
accountDateTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountNotification__expirations__expireWarnstringAn 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.
accountUISettings__adminMessage__baseMessagestringaccountUISettings__hasExternalLinkedAccountsstringaccountUISettings__hideUseATemplateInPreparestringadvancedSearchEnableTabFieldMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
advancedSearchEnableTabFieldMetadata__uiHintstringReserved for Docusign.
advancedSearchEnableTabFieldMetadata__uiTypestringReserved for Docusign.
allowAccessCodeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowAccountMemberNameChangeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAccountMemberNameChangeMetadata__uiHintstringReserved for Docusign.
allowAccountMemberNameChangeMetadata__uiTypestringReserved for Docusign.
allowAgreementActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowAgreementOrchestrationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAgreementOrchestrationsMetadata__uiHintstringReserved for Docusign.
allowAgreementOrchestrationsMetadata__uiTypestringReserved for Docusign.
allowConnectSendFinishLaterMetadata__optionsstring[]An array of option strings supported by this setting.
allowConnectSendFinishLaterMetadata__uiOrderstringReserved for Docusign.
allowDelegatedSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopeCustodyTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopeCustodyTransferMetadata__uiHintstringReserved for Docusign.
allowEnvelopeCustodyTransferMetadata__uiTypestringReserved for Docusign.
allowExternalLinkedAccountsMetadata__optionsstring[]An array of option strings supported by this setting.
allowExternalLinkedAccountsMetadata__uiOrderstringReserved for Docusign.
allowOcrOfEnvelopeDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
allowOcrOfEnvelopeDocumentsMetadata__uiOrderstringReserved for Docusign.
allowRecipientConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowScheduledSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendToCertifiedDeliveryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSendToCertifiedDeliveryMetadata__uiHintstringReserved for Docusign.
allowSendToCertifiedDeliveryMetadata__uiTypestringReserved for Docusign.
allowSignerReassignOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
allowSignerReassignOverrideMetadata__uiOrderstringReserved for Docusign.
allowUsersToAccessDirectoryMetadata__optionsstring[]An array of option strings supported by this setting.
allowUsersToAccessDirectoryMetadata__uiOrderstringReserved for Docusign.
allowWhatsAppDeliveryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
anchorPopulationScopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canUseSalesforceOAuthMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
captureVoiceRecordingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
commentEmailShowMessageTextMetadata__optionsstring[]An array of option strings supported by this setting.
commentEmailShowMessageTextMetadata__uiOrderstringReserved for Docusign.
consumerDisclosureFrequencyMetadata__optionsstring[]An array of option strings supported by this setting.
consumerDisclosureFrequencyMetadata__uiOrderstringReserved for Docusign.
defaultSigningResponsiveViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
defaultSigningResponsiveViewMetadata__uiHintstringReserved for Docusign.
defaultSigningResponsiveViewMetadata__uiTypestringReserved for Docusign.
disableAutoTemplateMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
disableAutoTemplateMatchingMetadata__uiOrderstringReserved for Docusign.
disableSignerCertViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableStyleSignatureMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAgreementActionsForCLMMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAgreementActionsForCLMMetadata__uiHintstringReserved for Docusign.
enableAgreementActionsForCLMMetadata__uiTypestringReserved for Docusign.
enableClickPlusCustomFieldsMetaData__optionsstring[]An array of option strings supported by this setting.
enableClickPlusCustomFieldsMetaData__uiOrderstringReserved for Docusign.
enableDSigExpressPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckForAESPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigIDCheckForAESPensMetadata__uiOrderstringReserved for Docusign.
enableDSigIDVerificationPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigIDVerificationPensMetadata__uiHintstringReserved for Docusign.
enableDSigIDVerificationPensMetadata__uiTypestringReserved for Docusign.
enableInBrowserEditorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableInboxBrowseViewsPoweredByElasticSearchstringenablePowerFormDirectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSearchServiceAzureUriMetadata__optionsstring[]An array of option strings supported by this setting.
enableSearchServiceAzureUriMetadata__uiOrderstringReserved for Docusign.
enableSearchSiteSpecificApiMetadata__optionsstring[]An array of option strings supported by this setting.
enableSearchSiteSpecificApiMetadata__uiOrderstringReserved for Docusign.
envelopeStampingDefaultValueMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
envelopeStampingDefaultValueMetadata__uiHintstringReserved for Docusign.
envelopeStampingDefaultValueMetadata__uiTypestringReserved for Docusign.
maximumUsersPerSigningGroupMetadata__optionsstring[]An array of option strings supported by this setting.
maximumUsersPerSigningGroupMetadata__uiOrderstringReserved for Docusign.
mergeMixedModeResultsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optInMobileSigningV02Metadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
pdfMaxChunkedUploadPartSizeMetadata__optionsstring[]An array of option strings supported by this setting.
pdfMaxChunkedUploadPartSizeMetadata__uiOrderstringReserved for Docusign.
pdfMaxChunkedUploadTotalSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
pdfMaxChunkedUploadTotalSizeMetadata__uiHintstringReserved for Docusign.
pdfMaxChunkedUploadTotalSizeMetadata__uiTypestringReserved for Docusign.
requireSignerCertificateTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
requireSignerCertificateTypeMetadata__uiHintstringReserved for Docusign.
requireSignerCertificateTypeMetadata__uiTypestringReserved for Docusign.
selfSignedRecipientEmailDocumentUserOverridestringWhen **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.
senderCanSignInEachLocationMetadata__optionsstring[]An array of option strings supported by this setting.
senderCanSignInEachLocationMetadata__uiOrderstringReserved for Docusign.
sharedTemplateFoldersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showConditionalRoutingOnSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showConditionalRoutingOnSendMetadata__uiHintstringReserved for Docusign.
showConditionalRoutingOnSendMetadata__uiTypestringReserved for Docusign.
showInitialConditionalFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showInitialConditionalFieldsMetadata__uiHintstringReserved for Docusign.
showInitialConditionalFieldsMetadata__uiTypestringReserved for Docusign.
signerCanSignOnMobileMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerMustHaveAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerMustLoginToSignMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signingSessionTimeoutMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__drawTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__drawTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__drawTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__listTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__listTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__listTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__noteTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__noteTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__noteTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabScaleMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__tabScaleMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__tabScaleMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabTextFormattingEnabledstringWhen **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.
tabAccountSettings__textTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__textTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__textTabsMetadata__uiTypestringReserved for Docusign.
useConsumerDisclosureMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useMultiAppGroupsDataMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useSignatureProviderPlatformMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useSignatureProviderPlatformMetadata__uiHintstringReserved for Docusign.
useSignatureProviderPlatformMetadata__uiTypestringReserved for Docusign.
wurflMinAllowableScreenSizeMetadata__optionsstring[]An array of option strings supported by this setting.
wurflMinAllowableScreenSizeMetadata__uiOrderstringReserved for Docusign.
accountDefaultLanguageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountNotification__expirations__expireAfterstringAn integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**
accountNotification__reminders__reminderDelaystringAn 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.
accountUISettings__enableEnvelopeCopyWithDatastringadvancedSearchEnableTabFieldMetadata__optionsstring[]An array of option strings supported by this setting.
advancedSearchEnableTabFieldMetadata__uiOrderstringReserved for Docusign.
allowAccountMemberNameChangeMetadata__optionsstring[]An array of option strings supported by this setting.
allowAccountMemberNameChangeMetadata__uiOrderstringReserved for Docusign.
allowAgreementOrchestrationsMetadata__optionsstring[]An array of option strings supported by this setting.
allowAgreementOrchestrationsMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeCustodyTransferMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopeCustodyTransferMetadata__uiOrderstringReserved for Docusign.
allowEnvelopePublishReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopePublishReportingMetadata__uiHintstringReserved for Docusign.
allowEnvelopePublishReportingMetadata__uiTypestringReserved for Docusign.
allowEnvelopeReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowExpressSignerCertificateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowExpressSignerCertificateMetadata__uiHintstringReserved for Docusign.
allowExpressSignerCertificateMetadata__uiTypestringReserved for Docusign.
allowInPersonElectronicNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowInPersonElectronicNotaryMetadata__uiHintstringReserved for Docusign.
allowInPersonElectronicNotaryMetadata__uiTypestringReserved for Docusign.
allowParticipantRecipientTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowParticipantRecipientTypeMetadata__uiHintstringReserved for Docusign.
allowParticipantRecipientTypeMetadata__uiTypestringReserved for Docusign.
allowPaymentProcessingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPhoneAuthOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSecurityApplianceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendToCertifiedDeliveryMetadata__optionsstring[]An array of option strings supported by this setting.
allowSendToCertifiedDeliveryMetadata__uiOrderstringReserved for Docusign.
allowSignDocumentFromHomePageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSignDocumentFromHomePageMetadata__uiHintstringReserved for Docusign.
allowSignDocumentFromHomePageMetadata__uiTypestringReserved for Docusign.
allowSigningExtensionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
cfr21SimplifiedSigningEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
cfr21SimplifiedSigningEnabledMetadata__uiHintstringReserved for Docusign.
cfr21SimplifiedSigningEnabledMetadata__uiTypestringReserved for Docusign.
chromeSignatureEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
commentsAllowEnvelopeOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
commentsAllowEnvelopeOverrideMetadata__uiHintstringReserved for Docusign.
commentsAllowEnvelopeOverrideMetadata__uiTypestringReserved for Docusign.
defaultSigningResponsiveViewMetadata__optionsstring[]An array of option strings supported by this setting.
defaultSigningResponsiveViewMetadata__uiOrderstringReserved for Docusign.
disableBulkSendRecipientLimitMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableBulkSendRecipientLimitMetaData__uiHintstringReserved for Docusign.
disableBulkSendRecipientLimitMetaData__uiTypestringReserved for Docusign.
disableUploadSignatureMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
draftEnvelopeRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdvancedEnvelopesSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdvancedEnvelopesSearchMetadata__uiHintstringReserved for Docusign.
enableAdvancedEnvelopesSearchMetadata__uiTypestringReserved for Docusign.
enableAdvancedPaymentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAgreementActionsForCLMMetadata__optionsstring[]An array of option strings supported by this setting.
enableAgreementActionsForCLMMetadata__uiOrderstringReserved for Docusign.
enableCalculatedFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableClickPlusDynamicContentMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickPlusDynamicContentMetaData__uiHintstringReserved for Docusign.
enableClickPlusDynamicContentMetaData__uiTypestringReserved for Docusign.
enableDSigIDVerificationPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigIDVerificationPensMetadata__uiOrderstringReserved for Docusign.
enableEnforceTlsEmailsSettingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableEnforceTlsEmailsSettingMetadata__uiHintstringReserved for Docusign.
enableEnforceTlsEmailsSettingMetadata__uiTypestringReserved for Docusign.
enableEsignCommunitiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIDFxPhoneAuthenticationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableIDFxPhoneAuthenticationMetadata__uiHintstringReserved for Docusign.
enableIDFxPhoneAuthenticationMetadata__uiTypestringReserved for Docusign.
enableLargeFileSupportMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableScheduledReleaseMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSendingTagsFontSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSendingTagsFontSettingsMetadata__uiHintstringReserved for Docusign.
enableSendingTagsFontSettingsMetadata__uiTypestringReserved for Docusign.
enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enforceTemplateNameUniquenessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enforceTemplateNameUniquenessMetadata__uiHintstringReserved for Docusign.
enforceTemplateNameUniquenessMetadata__uiTypestringReserved for Docusign.
envelopeStampingDefaultValueMetadata__optionsstring[]An array of option strings supported by this setting.
envelopeStampingDefaultValueMetadata__uiOrderstringReserved for Docusign.
forbidAddingUserStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
guidedFormsHtmlAllowedMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idfxKBAAuthenticationOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idfxKBAAuthenticationOverrideMetadata__uiHintstringReserved for Docusign.
idfxKBAAuthenticationOverrideMetadata__uiTypestringReserved for Docusign.
inPersonSigningEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optOutNewPlatformSealPlatformMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
optOutNewPlatformSealPlatformMetadata__uiHintstringReserved for Docusign.
optOutNewPlatformSealPlatformMetadata__uiTypestringReserved for Docusign.
pdfMaxChunkedUploadTotalSizeMetadata__optionsstring[]An array of option strings supported by this setting.
pdfMaxChunkedUploadTotalSizeMetadata__uiOrderstringReserved for Docusign.
requireExternalUserManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
requireExternalUserManagementMetadata__uiHintstringReserved for Docusign.
requireExternalUserManagementMetadata__uiTypestringReserved for Docusign.
requireSignerCertificateTypeMetadata__optionsstring[]An array of option strings supported by this setting.
requireSignerCertificateTypeMetadata__uiOrderstringReserved for Docusign.
senderMustAuthenticateSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
senderMustAuthenticateSigningMetadata__uiHintstringReserved for Docusign.
senderMustAuthenticateSigningMetadata__uiTypestringReserved for Docusign.
showConditionalRoutingOnSendMetadata__optionsstring[]An array of option strings supported by this setting.
showConditionalRoutingOnSendMetadata__uiOrderstringReserved for Docusign.
showInitialConditionalFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
showInitialConditionalFieldsMetadata__uiOrderstringReserved for Docusign.
signerCanCreateAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
startInAdvancedCorrectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__approveDeclineTabsEnabledstringWhen **true,** approve and decline tabs are enabled.
tabAccountSettings__drawTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__drawTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__enableTabAgreementDetailsstringtabAccountSettings__firstLastEmailTabsEnabledstringReserved for Docusign.
tabAccountSettings__listTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__listTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__noteTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__noteTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__radioTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__radioTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__radioTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabScaleMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__tabScaleMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__textTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__textTabsMetadata__uiOrderstringReserved for Docusign.
useSignatureProviderPlatformMetadata__optionsstring[]An array of option strings supported by this setting.
useSignatureProviderPlatformMetadata__uiOrderstringReserved for Docusign.
allowAccountManagementGranularMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAccountManagementGranularMetadata__uiHintstringReserved for Docusign.
allowAccountManagementGranularMetadata__uiTypestringReserved for Docusign.
allowAgentNameEmailEditMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDocumentVisibilityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopePublishReportingMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopePublishReportingMetadata__uiOrderstringReserved for Docusign.
allowExpressSignerCertificateMetadata__optionsstring[]An array of option strings supported by this setting.
allowExpressSignerCertificateMetadata__uiOrderstringReserved for Docusign.
allowInPersonElectronicNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowInPersonElectronicNotaryMetadata__uiOrderstringReserved for Docusign.
allowMultipleSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowMultipleSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
allowMultipleSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
allowOrganizationSsoManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationSsoManagementMetadata__uiHintstringReserved for Docusign.
allowOrganizationSsoManagementMetadata__uiTypestringReserved for Docusign.
allowOrganizationToUseInPersonElectronicNotarystringOrganization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
allowParticipantRecipientTypeMetadata__optionsstring[]An array of option strings supported by this setting.
allowParticipantRecipientTypeMetadata__uiOrderstringReserved for Docusign.
allowSendToIntermediaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSignDocumentFromHomePageMetadata__optionsstring[]An array of option strings supported by this setting.
allowSignDocumentFromHomePageMetadata__uiOrderstringReserved for Docusign.
attachCompletedEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
betaSwitchConfigurationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
cfr21SimplifiedSigningEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
cfr21SimplifiedSigningEnabledMetadata__uiOrderstringReserved for Docusign.
commentsAllowEnvelopeOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
commentsAllowEnvelopeOverrideMetadata__uiOrderstringReserved for Docusign.
disableBulkSendRecipientLimitMetaData__optionsstring[]An array of option strings supported by this setting.
disableBulkSendRecipientLimitMetaData__uiOrderstringReserved for Docusign.
disableMobilePushNotificationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableMobilePushNotificationsMetadata__uiHintstringReserved for Docusign.
disableMobilePushNotificationsMetadata__uiTypestringReserved for Docusign.
disableMultipleSessionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
documentConversionRestrictionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
documentConversionRestrictionsMetadata__uiHintstringReserved for Docusign.
documentConversionRestrictionsMetadata__uiTypestringReserved for Docusign.
enableAccountWideSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdvancedEnvelopesSearchMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdvancedEnvelopesSearchMetadata__uiOrderstringReserved for Docusign.
enableAgreementActionsForESignMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAgreementActionsForESignMetadata__uiHintstringReserved for Docusign.
enableAgreementActionsForESignMetadata__uiTypestringReserved for Docusign.
enableClickPlusDynamicContentMetaData__optionsstring[]An array of option strings supported by this setting.
enableClickPlusDynamicContentMetaData__uiOrderstringReserved for Docusign.
enableEnforceTlsEmailsSettingMetadata__optionsstring[]An array of option strings supported by this setting.
enableEnforceTlsEmailsSettingMetadata__uiOrderstringReserved for Docusign.
enableIDFxPhoneAuthenticationMetadata__optionsstring[]An array of option strings supported by this setting.
enableIDFxPhoneAuthenticationMetadata__uiOrderstringReserved for Docusign.
enablePaymentProcessingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableResponsiveSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSMSAuthenticationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSendingTagsFontSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSendingTagsFontSettingsMetadata__uiOrderstringReserved for Docusign.
enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningExtensionCommentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSigningExtensionCommentsMetadata__uiHintstringReserved for Docusign.
enableSigningExtensionCommentsMetadata__uiTypestringReserved for Docusign.
enableUnifiedRepositoryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enforceTemplateNameUniquenessMetadata__optionsstring[]An array of option strings supported by this setting.
enforceTemplateNameUniquenessMetadata__uiOrderstringReserved for Docusign.
hideAccountAddressInCoCMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idfxKBAAuthenticationOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
idfxKBAAuthenticationOverrideMetadata__uiOrderstringReserved for Docusign.
inPersonIDCheckQuestionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
inSessionSuppressEmailsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optOutNewPlatformSealPlatformMetadata__optionsstring[]An array of option strings supported by this setting.
optOutNewPlatformSealPlatformMetadata__uiOrderstringReserved for Docusign.
requireExternalUserManagementMetadata__optionsstring[]An array of option strings supported by this setting.
requireExternalUserManagementMetadata__uiOrderstringReserved for Docusign.
sendToCertifiedDeliveryEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sendToCertifiedDeliveryEnabledMetadata__uiHintstringReserved for Docusign.
sendToCertifiedDeliveryEnabledMetadata__uiTypestringReserved for Docusign.
senderMustAuthenticateSigningMetadata__optionsstring[]An array of option strings supported by this setting.
senderMustAuthenticateSigningMetadata__uiOrderstringReserved for Docusign.
showLocalizedWatermarksMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerLoginRequirementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
suppressCertificateEnforcementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
suppressCertificateEnforcementMetadata__uiHintstringReserved for Docusign.
suppressCertificateEnforcementMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__radioTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__radioTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__tabLockingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__tabLockingMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__tabLockingMetadata__uiTypestringReserved for Docusign.
useNewEnvelopeSearchOnlyWhenSearchingAfterDatestringwriteReminderToEnvelopeHistoryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
writeReminderToEnvelopeHistoryMetadata__uiHintstringReserved for Docusign.
writeReminderToEnvelopeHistoryMetadata__uiTypestringReserved for Docusign.
accessCodeFormat__minimumLengthMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accessCodeFormat__minimumLengthMetadata__uiHintstringReserved for Docusign.
accessCodeFormat__minimumLengthMetadata__uiTypestringReserved for Docusign.
accountNotification__expirations__expireEnabledstringWhen **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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html).
accountNotification__reminders__reminderEnabledstringWhen **true,** reminders are enabled. The default value is **false.**
accountUISettings__allowUsersToEditSharedAccessstringaccountUISettings__enableEasySignTemplateUploadstringallowAccountManagementGranularMetadata__optionsstring[]An array of option strings supported by this setting.
allowAccountManagementGranularMetadata__uiOrderstringReserved for Docusign.
allowConsumerDisclosureOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowConsumerDisclosureOverrideMetadata__uiHintstringReserved for Docusign.
allowConsumerDisclosureOverrideMetadata__uiTypestringReserved for Docusign.
allowDocumentDisclosuresMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDocumentsOnSignedEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowDocumentsOnSignedEnvelopesMetadata__uiHintstringReserved for Docusign.
allowDocumentsOnSignedEnvelopesMetadata__uiTypestringReserved for Docusign.
allowMultipleSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
allowMultipleSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
allowOpenTrustSignerCertificateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOpenTrustSignerCertificateMetadata__uiHintstringReserved for Docusign.
allowOpenTrustSignerCertificateMetadata__uiTypestringReserved for Docusign.
allowOrganizationSsoManagementMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationSsoManagementMetadata__uiOrderstringReserved for Docusign.
allowPhoneAuthenticationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowThirdPartyElectronicNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowThirdPartyElectronicNotaryMetadata__uiHintstringReserved for Docusign.
allowThirdPartyElectronicNotaryMetadata__uiTypestringReserved for Docusign.
checkForMultipleAdminsOnAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
checkForMultipleAdminsOnAccountMetadata__uiHintstringReserved for Docusign.
checkForMultipleAdminsOnAccountMetadata__uiTypestringReserved for Docusign.
conditionalFieldsEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableMobilePushNotificationsMetadata__optionsstring[]An array of option strings supported by this setting.
disableMobilePushNotificationsMetadata__uiOrderstringReserved for Docusign.
disableSignerHistoryViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
documentConversionRestrictionsMetadata__optionsstring[]An array of option strings supported by this setting.
documentConversionRestrictionsMetadata__uiOrderstringReserved for Docusign.
enableAdvancedPowerFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAgreementActionsForESignMetadata__optionsstring[]An array of option strings supported by this setting.
enableAgreementActionsForESignMetadata__uiOrderstringReserved for Docusign.
enableContactSuggestionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigEUAdvancedPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableEnvelopeStampingByDSAdminMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableEnvelopeStampingByDSAdminMetadata__uiHintstringReserved for Docusign.
enableEnvelopeStampingByDSAdminMetadata__uiTypestringReserved for Docusign.
enableInboxRelevanceSortMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableRecipientDomainValidationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableRecipientDomainValidationMetadata__uiHintstringReserved for Docusign.
enableRecipientDomainValidationMetadata__uiTypestringReserved for Docusign.
enableRequireSignOnPaperMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSendToIntermediaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningExtensionCommentsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSigningExtensionCommentsMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__boxnetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalDocumentSources__boxnetMetadata__uiHintstringReserved for Docusign.
externalDocumentSources__boxnetMetadata__uiTypestringReserved for Docusign.
externalSignaturePadTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
guidedFormsHtmlConversionPolicyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
guidedFormsHtmlConversionPolicyMetadata__uiHintstringReserved for Docusign.
guidedFormsHtmlConversionPolicyMetadata__uiTypestringReserved for Docusign.
idfxPhoneAuthenticationOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
idfxPhoneAuthenticationOverrideMetadata__uiHintstringReserved for Docusign.
idfxPhoneAuthenticationOverrideMetadata__uiTypestringReserved for Docusign.
pkiSignDownloadedPDFDocsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
recipientsCanSignOfflineMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sendToCertifiedDeliveryEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
sendToCertifiedDeliveryEnabledMetadata__uiOrderstringReserved for Docusign.
showMaskedFieldsWhenDownloadingDocumentAsSenderstringsimplifiedSendingEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
suppressCertificateEnforcementMetadata__optionsstring[]An array of option strings supported by this setting.
suppressCertificateEnforcementMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__prefillTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__prefillTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__prefillTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabLocationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__tabLocationMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__tabLocationMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabLockingMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__tabLockingMetadata__uiOrderstringReserved for Docusign.
writeReminderToEnvelopeHistoryMetadata__optionsstring[]An array of option strings supported by this setting.
writeReminderToEnvelopeHistoryMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__formatRequiredMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accessCodeFormat__formatRequiredMetadata__uiHintstringReserved for Docusign.
accessCodeFormat__formatRequiredMetadata__uiTypestringReserved for Docusign.
accessCodeFormat__letterRequiredMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accessCodeFormat__letterRequiredMetadata__uiHintstringReserved for Docusign.
accessCodeFormat__letterRequiredMetadata__uiTypestringReserved for Docusign.
accessCodeFormat__minimumLengthMetadata__optionsstring[]An array of option strings supported by this setting.
accessCodeFormat__minimumLengthMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__numberRequiredMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accessCodeFormat__numberRequiredMetadata__uiHintstringReserved for Docusign.
accessCodeFormat__numberRequiredMetadata__uiTypestringReserved for Docusign.
accountUISettings__adminMessage__moreInformationstringaccountUISettings__uploadNewImageToSignOrInitialstringallowConsumerDisclosureOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
allowConsumerDisclosureOverrideMetadata__uiOrderstringReserved for Docusign.
allowDocumentsOnSignedEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
allowDocumentsOnSignedEnvelopesMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeCustomFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowExtendedSendingResourceFileMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowExtendedSendingResourceFileMetadata__uiHintstringReserved for Docusign.
allowExtendedSendingResourceFileMetadata__uiTypestringReserved for Docusign.
allowExternalSignaturePadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowIDVForEUQualifiedSignaturesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowIDVForEUQualifiedSignaturesMetadata__uiHintstringReserved for Docusign.
allowIDVForEUQualifiedSignaturesMetadata__uiTypestringReserved for Docusign.
allowOpenTrustSignerCertificateMetadata__optionsstring[]An array of option strings supported by this setting.
allowOpenTrustSignerCertificateMetadata__uiOrderstringReserved for Docusign.
allowOrganizationBrandingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDocusignMonitorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationDocusignMonitorMetadata__uiHintstringReserved for Docusign.
allowOrganizationDocusignMonitorMetadata__uiTypestringReserved for Docusign.
allowOrganizationToUseThirdPartyElectronicNotarystringOrg level flag that determines the availability to perform Third Party Notary (3PN) actions.
allowPerformanceAnalyticsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPrivateSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowResourceFileBrandingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSigningRadioDeselectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowThirdPartyElectronicNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowThirdPartyElectronicNotaryMetadata__uiOrderstringReserved for Docusign.
checkForMultipleAdminsOnAccountMetadata__optionsstring[]An array of option strings supported by this setting.
checkForMultipleAdminsOnAccountMetadata__uiOrderstringReserved for Docusign.
enableAccessCodeGeneratorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDataVerificationExtensionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDataVerificationExtensionsMetadata__uiHintstringReserved for Docusign.
enableDataVerificationExtensionsMetadata__uiTypestringReserved for Docusign.
enableEnvelopeStampingByDSAdminMetadata__optionsstring[]An array of option strings supported by this setting.
enableEnvelopeStampingByDSAdminMetadata__uiOrderstringReserved for Docusign.
enableRecipientDomainValidationMetadata__optionsstring[]An array of option strings supported by this setting.
enableRecipientDomainValidationMetadata__uiOrderstringReserved for Docusign.
enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableWebFormsRuntimeAPIsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__boxnetMetadata__optionsstring[]An array of option strings supported by this setting.
externalDocumentSources__boxnetMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__dropboxMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalDocumentSources__dropboxMetadata__uiHintstringReserved for Docusign.
externalDocumentSources__dropboxMetadata__uiTypestringReserved for Docusign.
guidedFormsHtmlConversionPolicyMetadata__optionsstring[]An array of option strings supported by this setting.
guidedFormsHtmlConversionPolicyMetadata__uiOrderstringReserved for Docusign.
idfxPhoneAuthenticationOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
idfxPhoneAuthenticationOverrideMetadata__uiOrderstringReserved for Docusign.
selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
sendLockoutRecipientNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
sendLockoutRecipientNotificationMetadata__uiHintstringReserved for Docusign.
sendLockoutRecipientNotificationMetadata__uiTypestringReserved for Docusign.
specifyDocumentVisibilityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__checkBoxTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__checkBoxTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__checkBoxTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__prefillTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__prefillTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__tabDataLabelMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__tabDataLabelMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__tabDataLabelMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabLocationMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__tabLocationMetadata__uiOrderstringReserved for Docusign.
useSAFESignerCertificatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledstringaccessCodeFormat__formatRequiredMetadata__optionsstring[]An array of option strings supported by this setting.
accessCodeFormat__formatRequiredMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__letterRequiredMetadata__optionsstring[]An array of option strings supported by this setting.
accessCodeFormat__letterRequiredMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__numberRequiredMetadata__optionsstring[]An array of option strings supported by this setting.
accessCodeFormat__numberRequiredMetadata__uiOrderstringReserved for Docusign.
accountNotification__reminders__reminderFrequencystringAn integer specifying the interval in days between reminder emails. The default value is 0.
allowExtendedSendingResourceFileMetadata__optionsstring[]An array of option strings supported by this setting.
allowExtendedSendingResourceFileMetadata__uiOrderstringReserved for Docusign.
allowIDVForEUQualifiedSignaturesMetadata__optionsstring[]An array of option strings supported by this setting.
allowIDVForEUQualifiedSignaturesMetadata__uiOrderstringReserved for Docusign.
allowMultipleBrandProfilesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDocusignMonitorMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationDocusignMonitorMetadata__uiOrderstringReserved for Docusign.
allowPendingDestinationUrlEditionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPendingDestinationUrlEditionMetadata__uiHintstringReserved for Docusign.
allowPendingDestinationUrlEditionMetadata__uiTypestringReserved for Docusign.
allowSetEmbeddedRecipientStartURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSetEmbeddedRecipientStartURLMetadata__uiHintstringReserved for Docusign.
allowSetEmbeddedRecipientStartURLMetadata__uiTypestringReserved for Docusign.
allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTransactionsWorkspaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
autoProvisionSignerAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
dss_SIGN_28411_EnableLeavePagePrompt_RadminOptionstringenableClickPlusConditionalContentMetaData__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableClickPlusConditionalContentMetaData__uiHintstringReserved for Docusign.
enableClickPlusConditionalContentMetaData__uiTypestringReserved for Docusign.
enableClickPlusCustomStyleMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckRemoteForQESPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigIDCheckRemoteForQESPensMetadata__uiHintstringReserved for Docusign.
enableDSigIDCheckRemoteForQESPensMetadata__uiTypestringReserved for Docusign.
enableDataVerificationExtensionsMetadata__optionsstring[]An array of option strings supported by this setting.
enableDataVerificationExtensionsMetadata__uiOrderstringReserved for Docusign.
enableMultiUserRepositoryFeaturesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableMultiUserRepositoryFeaturesMetadata__uiHintstringReserved for Docusign.
enableMultiUserRepositoryFeaturesMetadata__uiTypestringReserved for Docusign.
enableParticipantRecipientSettingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableParticipantRecipientSettingMetadata__uiHintstringReserved for Docusign.
enableParticipantRecipientSettingMetadata__uiTypestringReserved for Docusign.
enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
envelopeIntegrationAllowedMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
envelopeIntegrationEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__dropboxMetadata__optionsstring[]An array of option strings supported by this setting.
externalDocumentSources__dropboxMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__oneDriveMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalDocumentSources__oneDriveMetadata__uiHintstringReserved for Docusign.
externalDocumentSources__oneDriveMetadata__uiTypestringReserved for Docusign.
pdfMaxIndividualUploadSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
require21CFRpt11ComplianceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
sendLockoutRecipientNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
sendLockoutRecipientNotificationMetadata__uiOrderstringReserved for Docusign.
skipAuthCompletedEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__allowTabOrderMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__allowTabOrderMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__allowTabOrderMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__checkBoxTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__checkBoxTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__dataFieldSizeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__dataFieldSizeMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__dataFieldSizeMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__numericalTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__numericalTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__numericalTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabDataLabelMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__tabDataLabelMetadata__uiOrderstringReserved for Docusign.
useEnvelopeSearchMixedModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__orderBasedRecipientIdGenerationstringallowConnectSendFinishLaterMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowExternalLinkedAccountsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOcrOfEnvelopeDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseRemoteNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationToUseRemoteNotaryMetadata__uiHintstringReserved for Docusign.
allowOrganizationToUseRemoteNotaryMetadata__uiTypestringReserved for Docusign.
allowPendingDestinationUrlEditionMetadata__optionsstring[]An array of option strings supported by this setting.
allowPendingDestinationUrlEditionMetadata__uiOrderstringReserved for Docusign.
allowSetEmbeddedRecipientStartURLMetadata__optionsstring[]An array of option strings supported by this setting.
allowSetEmbeddedRecipientStartURLMetadata__uiOrderstringReserved for Docusign.
allowSignerReassignOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTransactionsWorkspaceOriginalMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowTransactionsWorkspaceOriginalMetadata__uiHintstringReserved for Docusign.
allowTransactionsWorkspaceOriginalMetadata__uiTypestringReserved for Docusign.
allowUsersToAccessDirectoryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
anchorTagVersionedPlacementMetadataEnabled__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
anchorTagVersionedPlacementMetadataEnabled__uiHintstringReserved for Docusign.
anchorTagVersionedPlacementMetadataEnabled__uiTypestringReserved for Docusign.
commentEmailShowMessageTextMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
consumerDisclosureFrequencyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableAutoTemplateMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disablePurgeNotificationsForSenderMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disablePurgeNotificationsForSenderMetadata__uiHintstringReserved for Docusign.
disablePurgeNotificationsForSenderMetadata__uiTypestringReserved for Docusign.
enableClickPlusConditionalContentMetaData__optionsstring[]An array of option strings supported by this setting.
enableClickPlusConditionalContentMetaData__uiOrderstringReserved for Docusign.
enableClickPlusCustomFieldsMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckForAESPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckRemoteForQESPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigIDCheckRemoteForQESPensMetadata__uiOrderstringReserved for Docusign.
enableMultiUserRepositoryFeaturesMetadata__optionsstring[]An array of option strings supported by this setting.
enableMultiUserRepositoryFeaturesMetadata__uiOrderstringReserved for Docusign.
enableParticipantRecipientSettingMetadata__optionsstring[]An array of option strings supported by this setting.
enableParticipantRecipientSettingMetadata__uiOrderstringReserved for Docusign.
enableSearchServiceAzureUriMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSearchSiteSpecificApiMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__oneDriveMetadata__optionsstring[]An array of option strings supported by this setting.
externalDocumentSources__oneDriveMetadata__uiOrderstringReserved for Docusign.
maximumUsersPerSigningGroupMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
pdfMaxChunkedUploadPartSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderCanSignInEachLocationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerShowSecureFieldInitialValuesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerShowSecureFieldInitialValuesMetadata__uiHintstringReserved for Docusign.
signerShowSecureFieldInitialValuesMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__allowTabOrderMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__allowTabOrderMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__dataFieldRegexMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__dataFieldRegexMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__dataFieldRegexMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__dataFieldSizeMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__dataFieldSizeMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__numericalTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__numericalTabsMetadata__uiOrderstringReserved for Docusign.
useConsumerDisclosureWithinAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useConsumerDisclosureWithinAccountMetadata__uiHintstringReserved for Docusign.
useConsumerDisclosureWithinAccountMetadata__uiTypestringReserved for Docusign.
wurflMinAllowableScreenSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hideUseATemplateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__hideUseATemplateMetadata__uiHintstringReserved for Docusign.
accountUISettings__hideUseATemplateMetadata__uiTypestringReserved for Docusign.
advancedSearchEnableTabFieldMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
advancedSearchEnableTemplateIdFieldMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
advancedSearchEnableTemplateIdFieldMetadata__uiHintstringReserved for Docusign.
advancedSearchEnableTemplateIdFieldMetadata__uiTypestringReserved for Docusign.
allowAccountMemberNameChangeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowAgreementOrchestrationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopeCustodyTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseRemoteNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationToUseRemoteNotaryMetadata__uiOrderstringReserved for Docusign.
allowSafeBioPharmaSignerCertificateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSafeBioPharmaSignerCertificateMetadata__uiHintstringReserved for Docusign.
allowSafeBioPharmaSignerCertificateMetadata__uiTypestringReserved for Docusign.
allowSendToCertifiedDeliveryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTransactionsWorkspaceOriginalMetadata__optionsstring[]An array of option strings supported by this setting.
allowTransactionsWorkspaceOriginalMetadata__uiOrderstringReserved for Docusign.
anchorTagVersionedPlacementMetadataEnabled__optionsstring[]An array of option strings supported by this setting.
anchorTagVersionedPlacementMetadataEnabled__uiOrderstringReserved for Docusign.
defaultSigningResponsiveViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disablePurgeNotificationsForSenderMetadata__optionsstring[]An array of option strings supported by this setting.
disablePurgeNotificationsForSenderMetadata__uiOrderstringReserved for Docusign.
dss_EnableProvisioningPenConfiguration_RadminOptionstringdss_EnableSignatureTypeCustomTagRadmin_RadminOptionstringenableAgreementActionsForCLMMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckInPersonForQESPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigIDCheckInPersonForQESPensMetadata__uiHintstringReserved for Docusign.
enableDSigIDCheckInPersonForQESPensMetadata__uiTypestringReserved for Docusign.
enableDSigIDVerificationPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDVerificationPremierPensMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSigIDVerificationPremierPensMetadata__uiHintstringReserved for Docusign.
enableDSigIDVerificationPremierPensMetadata__uiTypestringReserved for Docusign.
enableESignAPIHourlyLimitManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableESignAPIHourlyLimitManagementMetadata__uiHintstringReserved for Docusign.
enableESignAPIHourlyLimitManagementMetadata__uiTypestringReserved for Docusign.
enableSigningExtensionConversationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSigningExtensionConversationsMetadata__uiHintstringReserved for Docusign.
enableSigningExtensionConversationsMetadata__uiTypestringReserved for Docusign.
envelopeStampingDefaultValueMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__salesforceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalDocumentSources__salesforceMetadata__uiHintstringReserved for Docusign.
externalDocumentSources__salesforceMetadata__uiTypestringReserved for Docusign.
optOutAutoNavTextAndTabColorUpdatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
optOutAutoNavTextAndTabColorUpdatesMetadata__uiHintstringReserved for Docusign.
optOutAutoNavTextAndTabColorUpdatesMetadata__uiTypestringReserved for Docusign.
pdfMaxChunkedUploadTotalSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
requireSignerCertificateTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showCompleteDialogInEmbeddedSessionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showCompleteDialogInEmbeddedSessionMetadata__uiHintstringReserved for Docusign.
showCompleteDialogInEmbeddedSessionMetadata__uiTypestringReserved for Docusign.
showConditionalRoutingOnSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showInitialConditionalFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signDateTimeAccountLanguageOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signDateTimeAccountLanguageOverrideMetadata__uiHintstringReserved for Docusign.
signDateTimeAccountLanguageOverrideMetadata__uiTypestringReserved for Docusign.
signDateTimeAccountTimezoneOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signDateTimeAccountTimezoneOverrideMetadata__uiHintstringReserved for Docusign.
signDateTimeAccountTimezoneOverrideMetadata__uiTypestringReserved for Docusign.
signerShowSecureFieldInitialValuesMetadata__optionsstring[]An array of option strings supported by this setting.
signerShowSecureFieldInitialValuesMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__dataFieldRegexMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__dataFieldRegexMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__drawTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__listTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__noteTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__tabScaleMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__textTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useConsumerDisclosureWithinAccountMetadata__optionsstring[]An array of option strings supported by this setting.
useConsumerDisclosureWithinAccountMetadata__uiOrderstringReserved for Docusign.
useDocuSignExpressSignerCertificateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useDocuSignExpressSignerCertificateMetadata__uiHintstringReserved for Docusign.
useDocuSignExpressSignerCertificateMetadata__uiTypestringReserved for Docusign.
useSignatureProviderPlatformMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hideUseATemplateMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__hideUseATemplateMetadata__uiOrderstringReserved for Docusign.
advancedSearchEnableTemplateIdFieldMetadata__optionsstring[]An array of option strings supported by this setting.
advancedSearchEnableTemplateIdFieldMetadata__uiOrderstringReserved for Docusign.
allowEnvelopePublishReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowExpressSignerCertificateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowInPersonElectronicNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDocusignMonitorFreeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationDocusignMonitorFreeMetadata__uiHintstringReserved for Docusign.
allowOrganizationDocusignMonitorFreeMetadata__uiTypestringReserved for Docusign.
allowParticipantRecipientTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSafeBioPharmaSignerCertificateMetadata__optionsstring[]An array of option strings supported by this setting.
allowSafeBioPharmaSignerCertificateMetadata__uiOrderstringReserved for Docusign.
allowSignDocumentFromHomePageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
cfr21SimplifiedSigningEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
commentsAllowEnvelopeOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
defaultToAdvancedEnvelopesFilterFormMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
defaultToAdvancedEnvelopesFilterFormMetadata__uiHintstringReserved for Docusign.
defaultToAdvancedEnvelopesFilterFormMetadata__uiTypestringReserved for Docusign.
disableBulkSendRecipientLimitMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdvancedEnvelopesSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableClickPlusDynamicContentMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckInPersonForQESPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigIDCheckInPersonForQESPensMetadata__uiOrderstringReserved for Docusign.
enableDSigIDVerificationPremierPensMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSigIDVerificationPremierPensMetadata__uiOrderstringReserved for Docusign.
enableESignAPIHourlyLimitManagementMetadata__optionsstring[]An array of option strings supported by this setting.
enableESignAPIHourlyLimitManagementMetadata__uiOrderstringReserved for Docusign.
enableEnforceTlsEmailsSettingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableEnvelopeStampingByAccountAdminMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableEnvelopeStampingByAccountAdminMetadata__uiHintstringReserved for Docusign.
enableEnvelopeStampingByAccountAdminMetadata__uiTypestringReserved for Docusign.
enableIDFxPhoneAuthenticationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableRecipientMayProvidePhoneNumberMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableRecipientMayProvidePhoneNumberMetadata__uiHintstringReserved for Docusign.
enableRecipientMayProvidePhoneNumberMetadata__uiTypestringReserved for Docusign.
enableSendingTagsFontSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningExtensionConversationsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSigningExtensionConversationsMetadata__uiOrderstringReserved for Docusign.
enableSigningOrderSettingsForAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSigningOrderSettingsForAccountMetadata__uiHintstringReserved for Docusign.
enableSigningOrderSettingsForAccountMetadata__uiTypestringReserved for Docusign.
enforceTemplateNameUniquenessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__googleDriveMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
externalDocumentSources__googleDriveMetadata__uiHintstringReserved for Docusign.
externalDocumentSources__googleDriveMetadata__uiTypestringReserved for Docusign.
externalDocumentSources__salesforceMetadata__optionsstring[]An array of option strings supported by this setting.
externalDocumentSources__salesforceMetadata__uiOrderstringReserved for Docusign.
idfxKBAAuthenticationOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optOutAutoNavTextAndTabColorUpdatesMetadata__optionsstring[]An array of option strings supported by this setting.
optOutAutoNavTextAndTabColorUpdatesMetadata__uiOrderstringReserved for Docusign.
optOutNewPlatformSealPlatformMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
requireExternalUserManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderMustAuthenticateSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showCompleteDialogInEmbeddedSessionMetadata__optionsstring[]An array of option strings supported by this setting.
showCompleteDialogInEmbeddedSessionMetadata__uiOrderstringReserved for Docusign.
signDateTimeAccountLanguageOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
signDateTimeAccountLanguageOverrideMetadata__uiOrderstringReserved for Docusign.
signDateTimeAccountTimezoneOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
signDateTimeAccountTimezoneOverrideMetadata__uiOrderstringReserved for Docusign.
signerAttachCertificateToEnvelopePDFMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerAttachCertificateToEnvelopePDFMetadata__uiHintstringReserved for Docusign.
signerAttachCertificateToEnvelopePDFMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__calculatedFieldsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__calculatedFieldsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__calculatedFieldsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__radioTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__savingCustomTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__savingCustomTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__savingCustomTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__sharedCustomTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__sharedCustomTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__sharedCustomTabsMetadata__uiTypestringReserved for Docusign.
useDocuSignExpressSignerCertificateMetadata__optionsstring[]An array of option strings supported by this setting.
useDocuSignExpressSignerCertificateMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableAdminMessageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableAdminMessageMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableAdminMessageMetadata__uiTypestringReserved for Docusign.
accountUISettings__hideSendAnEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__hideSendAnEnvelopeMetadata__uiHintstringReserved for Docusign.
accountUISettings__hideSendAnEnvelopeMetadata__uiTypestringReserved for Docusign.
advancedSearchEnableTemplateNameFieldMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
advancedSearchEnableTemplateNameFieldMetadata__uiHintstringReserved for Docusign.
advancedSearchEnableTemplateNameFieldMetadata__uiTypestringReserved for Docusign.
allowAccountManagementGranularMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEditingEnvelopesOnBehalfOfOthersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEditingEnvelopesOnBehalfOfOthersMetadata__uiHintstringReserved for Docusign.
allowEditingEnvelopesOnBehalfOfOthersMetadata__uiTypestringReserved for Docusign.
allowMultipleSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDocusignMonitorFreeMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationDocusignMonitorFreeMetadata__uiOrderstringReserved for Docusign.
allowOrganizationDomainUserManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationDomainUserManagementMetadata__uiHintstringReserved for Docusign.
allowOrganizationDomainUserManagementMetadata__uiTypestringReserved for Docusign.
allowOrganizationSsoManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendingEnvelopesOnBehalfOfOthersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSendingEnvelopesOnBehalfOfOthersMetadata__uiHintstringReserved for Docusign.
allowSendingEnvelopesOnBehalfOfOthersMetadata__uiTypestringReserved for Docusign.
defaultToAdvancedEnvelopesFilterFormMetadata__optionsstring[]An array of option strings supported by this setting.
defaultToAdvancedEnvelopesFilterFormMetadata__uiOrderstringReserved for Docusign.
disableMobilePushNotificationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
documentConversionRestrictionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAgreementActionsForESignMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableEnvelopeStampingByAccountAdminMetadata__optionsstring[]An array of option strings supported by this setting.
enableEnvelopeStampingByAccountAdminMetadata__uiOrderstringReserved for Docusign.
enableIDFxAccountlessSMSAuthForPart11Metadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableIDFxAccountlessSMSAuthForPart11Metadata__uiHintstringReserved for Docusign.
enableIDFxAccountlessSMSAuthForPart11Metadata__uiTypestringReserved for Docusign.
enableRecipientMayProvidePhoneNumberMetadata__optionsstring[]An array of option strings supported by this setting.
enableRecipientMayProvidePhoneNumberMetadata__uiOrderstringReserved for Docusign.
enableSigningExtensionCommentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningOrderSettingsForAccountMetadata__optionsstring[]An array of option strings supported by this setting.
enableSigningOrderSettingsForAccountMetadata__uiOrderstringReserved for Docusign.
enableWebFormsSeparateUserPermissionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableWebFormsSeparateUserPermissionsMetadata__uiHintstringReserved for Docusign.
enableWebFormsSeparateUserPermissionsMetadata__uiTypestringReserved for Docusign.
externalDocumentSources__googleDriveMetadata__optionsstring[]An array of option strings supported by this setting.
externalDocumentSources__googleDriveMetadata__uiOrderstringReserved for Docusign.
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__uiHintstringReserved for Docusign.
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__uiTypestringReserved for Docusign.
recipientSigningAutoNavigationControlMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
recipientSigningAutoNavigationControlMetadata__uiHintstringReserved for Docusign.
recipientSigningAutoNavigationControlMetadata__uiTypestringReserved for Docusign.
sendToCertifiedDeliveryEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerAttachCertificateToEnvelopePDFMetadata__optionsstring[]An array of option strings supported by this setting.
signerAttachCertificateToEnvelopePDFMetadata__uiOrderstringReserved for Docusign.
suppressCertificateEnforcementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__calculatedFieldsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__calculatedFieldsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__savingCustomTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__savingCustomTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__sharedCustomTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__sharedCustomTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__tabLockingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__tabTextFormattingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__tabTextFormattingMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__tabTextFormattingMetadata__uiTypestringReserved for Docusign.
writeReminderToEnvelopeHistoryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accessCodeFormat__minimumLengthMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableAdminMessageMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableAdminMessageMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableEnvelopeTypesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableEnvelopeTypesMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableEnvelopeTypesMetadata__uiTypestringReserved for Docusign.
accountUISettings__hideSendAnEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__hideSendAnEnvelopeMetadata__uiOrderstringReserved for Docusign.
advancedSearchEnableTemplateNameFieldMetadata__optionsstring[]An array of option strings supported by this setting.
advancedSearchEnableTemplateNameFieldMetadata__uiOrderstringReserved for Docusign.
allowConsumerDisclosureOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowDocumentsOnSignedEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEditingEnvelopesOnBehalfOfOthersMetadata__optionsstring[]An array of option strings supported by this setting.
allowEditingEnvelopesOnBehalfOfOthersMetadata__uiOrderstringReserved for Docusign.
allowManagingEnvelopesOnBehalfOfOthersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowManagingEnvelopesOnBehalfOfOthersMetadata__uiHintstringReserved for Docusign.
allowManagingEnvelopesOnBehalfOfOthersMetadata__uiTypestringReserved for Docusign.
allowOpenTrustSignerCertificateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDomainUserManagementMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationDomainUserManagementMetadata__uiOrderstringReserved for Docusign.
allowSendingEnvelopesOnBehalfOfOthersMetadata__optionsstring[]An array of option strings supported by this setting.
allowSendingEnvelopesOnBehalfOfOthersMetadata__uiOrderstringReserved for Docusign.
allowThirdPartyElectronicNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
checkForMultipleAdminsOnAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCommentsHistoryDownloadInSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableCommentsHistoryDownloadInSigningMetadata__uiHintstringReserved for Docusign.
enableCommentsHistoryDownloadInSigningMetadata__uiTypestringReserved for Docusign.
enableEnvelopeStampingByDSAdminMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIDFxAccountlessSMSAuthForPart11Metadata__optionsstring[]An array of option strings supported by this setting.
enableIDFxAccountlessSMSAuthForPart11Metadata__uiOrderstringReserved for Docusign.
enableIdfxPhoneAuthSignatureAuthStatusMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableIdfxPhoneAuthSignatureAuthStatusMetadata__uiHintstringReserved for Docusign.
enableIdfxPhoneAuthSignatureAuthStatusMetadata__uiTypestringReserved for Docusign.
enableRecipientDomainValidationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableWebFormsSeparateUserPermissionsMetadata__optionsstring[]An array of option strings supported by this setting.
enableWebFormsSeparateUserPermissionsMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__boxnetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
guidedFormsHtmlConversionPolicyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
idfxPhoneAuthenticationOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__optionsstring[]An array of option strings supported by this setting.
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__uiOrderstringReserved for Docusign.
recipientSigningAutoNavigationControlMetadata__optionsstring[]An array of option strings supported by this setting.
recipientSigningAutoNavigationControlMetadata__uiOrderstringReserved for Docusign.
supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__approveDeclineTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__approveDeclineTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__approveDeclineTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__firstLastEmailTabsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__firstLastEmailTabsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__firstLastEmailTabsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__prefillTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__tabLocationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__tabTextFormattingMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__tabTextFormattingMetadata__uiOrderstringReserved for Docusign.
useNewEnvelopeSearchOnlyWithSearchTermMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useNewEnvelopeSearchOnlyWithSearchTermMetadata__uiHintstringReserved for Docusign.
useNewEnvelopeSearchOnlyWithSearchTermMetadata__uiTypestringReserved for Docusign.
accessCodeFormat__formatRequiredMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accessCodeFormat__letterRequiredMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accessCodeFormat__numberRequiredMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEnvelopeTypesMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableEnvelopeTypesMetadata__uiOrderstringReserved for Docusign.
allowExtendedSendingResourceFileMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowIDVForEUQualifiedSignaturesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowManagingEnvelopesOnBehalfOfOthersMetadata__optionsstring[]An array of option strings supported by this setting.
allowManagingEnvelopesOnBehalfOfOthersMetadata__uiOrderstringReserved for Docusign.
allowOrganizationDocusignMonitorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCommentsHistoryDownloadInSigningMetadata__optionsstring[]An array of option strings supported by this setting.
enableCommentsHistoryDownloadInSigningMetadata__uiOrderstringReserved for Docusign.
enableDataVerificationExtensionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIdfxPhoneAuthSignatureAuthStatusMetadata__optionsstring[]An array of option strings supported by this setting.
enableIdfxPhoneAuthSignatureAuthStatusMetadata__uiOrderstringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
enablePremiumDataVerificationExtensionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enablePremiumDataVerificationExtensionsMetadata__uiHintstringReserved for Docusign.
enablePremiumDataVerificationExtensionsMetadata__uiTypestringReserved for Docusign.
enableSMSDeliveryAdditionalNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSMSDeliveryAdditionalNotificationMetadata__uiHintstringReserved for Docusign.
enableSMSDeliveryAdditionalNotificationMetadata__uiTypestringReserved for Docusign.
externalDocumentSources__dropboxMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
phoneAuthRecipientMayProvidePhoneNumberMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
phoneAuthRecipientMayProvidePhoneNumberMetadata__uiHintstringReserved for Docusign.
phoneAuthRecipientMayProvidePhoneNumberMetadata__uiTypestringReserved for Docusign.
selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
sendLockoutRecipientNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerInSessionUseEnvelopeCompleteEmailMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
signerInSessionUseEnvelopeCompleteEmailMetadata__uiHintstringReserved for Docusign.
signerInSessionUseEnvelopeCompleteEmailMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__approveDeclineTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__approveDeclineTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__checkBoxTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__firstLastEmailTabsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__firstLastEmailTabsMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__senderToChangeTabAssignmentsEnabledstringReserved for Docusign.
tabAccountSettings__tabDataLabelMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useNewEnvelopeSearchOnlyWithSearchTermMetadata__optionsstring[]An array of option strings supported by this setting.
useNewEnvelopeSearchOnlyWithSearchTermMetadata__uiOrderstringReserved for Docusign.
allowAdvancedRecipientRoutingConditionalMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAdvancedRecipientRoutingConditionalMetadata__uiHintstringReserved for Docusign.
allowAdvancedRecipientRoutingConditionalMetadata__uiTypestringReserved for Docusign.
allowPendingDestinationUrlEditionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSetEmbeddedRecipientStartURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdditionalAdvancedWebFormsFeaturesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableAdditionalAdvancedWebFormsFeaturesMetadata__uiHintstringReserved for Docusign.
enableAdditionalAdvancedWebFormsFeaturesMetadata__uiTypestringReserved for Docusign.
enableClickPlusConditionalContentMetaData__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCustomerSatisfactionMetricTrackingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableCustomerSatisfactionMetricTrackingMetadata__uiHintstringReserved for Docusign.
enableCustomerSatisfactionMetricTrackingMetadata__uiTypestringReserved for Docusign.
enableDSigIDCheckRemoteForQESPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
enableMultiUserRepositoryFeaturesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableParticipantRecipientSettingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enablePremiumDataVerificationExtensionsMetadata__optionsstring[]An array of option strings supported by this setting.
enablePremiumDataVerificationExtensionsMetadata__uiOrderstringReserved for Docusign.
enableSMSDeliveryAdditionalNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
enableSMSDeliveryAdditionalNotificationMetadata__uiOrderstringReserved for Docusign.
externalDocumentSources__oneDriveMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
phoneAuthRecipientMayProvidePhoneNumberMetadata__optionsstring[]An array of option strings supported by this setting.
phoneAuthRecipientMayProvidePhoneNumberMetadata__uiOrderstringReserved for Docusign.
signerInSessionUseEnvelopeCompleteEmailMetadata__optionsstring[]An array of option strings supported by this setting.
signerInSessionUseEnvelopeCompleteEmailMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__allowTabOrderMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__dataFieldSizeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__numericalTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__clickwrapSchemaVersionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__clickwrapSchemaVersionMetadata__uiHintstringReserved for Docusign.
accountUISettings__clickwrapSchemaVersionMetadata__uiTypestringReserved for Docusign.
accountUISettings__enableEasySignCanUseMultiTemplateApplystringaccountUISettings__shouldRedactAccessCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__shouldRedactAccessCodeMetadata__uiHintstringReserved for Docusign.
accountUISettings__shouldRedactAccessCodeMetadata__uiTypestringReserved for Docusign.
allowAdvancedRecipientRoutingConditionalMetadata__optionsstring[]An array of option strings supported by this setting.
allowAdvancedRecipientRoutingConditionalMetadata__uiOrderstringReserved for Docusign.
allowOrganizationToUseRemoteNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTransactionsWorkspaceOriginalMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
anchorTagVersionedPlacementMetadataEnabled__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disablePurgeNotificationsForSenderMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableAdditionalAdvancedWebFormsFeaturesMetadata__optionsstring[]An array of option strings supported by this setting.
enableAdditionalAdvancedWebFormsFeaturesMetadata__uiOrderstringReserved for Docusign.
enableCustomerSatisfactionMetricTrackingMetadata__optionsstring[]An array of option strings supported by this setting.
enableCustomerSatisfactionMetricTrackingMetadata__uiOrderstringReserved for Docusign.
signerShowSecureFieldInitialValuesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__dataFieldRegexMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useConsumerDisclosureWithinAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__uiHintstringReserved for Docusign.
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__uiTypestringReserved for Docusign.
accessCodeFormat__specialCharacterRequiredMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accessCodeFormat__specialCharacterRequiredMetadata__uiHintstringReserved for Docusign.
accessCodeFormat__specialCharacterRequiredMetadata__uiTypestringReserved for Docusign.
accountUISettings__clickwrapSchemaVersionMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__clickwrapSchemaVersionMetadata__uiOrderstringReserved for Docusign.
accountUISettings__hideUseATemplateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__shouldRedactAccessCodeMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__shouldRedactAccessCodeMetadata__uiOrderstringReserved for Docusign.
advancedSearchEnableTemplateIdFieldMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSafeBioPharmaSignerCertificateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDCheckInPersonForQESPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableDSigIDVerificationPremierPensMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableESignAPIHourlyLimitManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningExtensionConversationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__salesforceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optOutAutoNavTextAndTabColorUpdatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showCompleteDialogInEmbeddedSessionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signDateTimeAccountLanguageOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signDateTimeAccountTimezoneOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useDocuSignExpressSignerCertificateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__optionsstring[]An array of option strings supported by this setting.
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__uiOrderstringReserved for Docusign.
accessCodeFormat__specialCharacterRequiredMetadata__optionsstring[]An array of option strings supported by this setting.
accessCodeFormat__specialCharacterRequiredMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableLegacySendflowLinkMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableLegacySendflowLinkMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableLegacySendflowLinkMetadata__uiTypestringReserved for Docusign.
accountUISettings__removeEnvelopeForwardingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__removeEnvelopeForwardingMetadata__uiHintstringReserved for Docusign.
accountUISettings__removeEnvelopeForwardingMetadata__uiTypestringReserved for Docusign.
allowOrganizationDocusignMonitorFreeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
defaultToAdvancedEnvelopesFilterFormMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableEnvelopeStampingByAccountAdminMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableRecipientMayProvidePhoneNumberMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSigningOrderSettingsForAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
externalDocumentSources__googleDriveMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerAttachCertificateToEnvelopePDFMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__calculatedFieldsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__savingCustomTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__sharedCustomTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableAdminMessageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableLegacySendflowLinkMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableLegacySendflowLinkMetadata__uiOrderstringReserved for Docusign.
accountUISettings__hasExternalLinkedAccountsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__hasExternalLinkedAccountsMetadata__uiHintstringReserved for Docusign.
accountUISettings__hasExternalLinkedAccountsMetadata__uiTypestringReserved for Docusign.
accountUISettings__hideSendAnEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hideUseATemplateInPrepareMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__hideUseATemplateInPrepareMetadata__uiHintstringReserved for Docusign.
accountUISettings__hideUseATemplateInPrepareMetadata__uiTypestringReserved for Docusign.
accountUISettings__removeEnvelopeForwardingMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__removeEnvelopeForwardingMetadata__uiOrderstringReserved for Docusign.
advancedSearchEnableTemplateNameFieldMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEditingEnvelopesOnBehalfOfOthersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationDomainUserManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendingEnvelopesOnBehalfOfOthersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIDFxAccountlessSMSAuthForPart11Metadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableInboxBrowseViewsPoweredByElasticSearchMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableInboxBrowseViewsPoweredByElasticSearchMetadata__uiHintstringReserved for Docusign.
enableInboxBrowseViewsPoweredByElasticSearchMetadata__uiTypestringReserved for Docusign.
enableWebFormsSeparateUserPermissionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
ignoreErrorIfAnchorTabNotFoundMetadataEnabled__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
recipientSigningAutoNavigationControlMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentUserOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
selfSignedRecipientEmailDocumentUserOverrideMetadata__uiHintstringReserved for Docusign.
selfSignedRecipientEmailDocumentUserOverrideMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__tabTextFormattingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEnvelopeCopyWithDataMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableEnvelopeCopyWithDataMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableEnvelopeCopyWithDataMetadata__uiTypestringReserved for Docusign.
accountUISettings__enableEnvelopeTypesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hasExternalLinkedAccountsMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__hasExternalLinkedAccountsMetadata__uiOrderstringReserved for Docusign.
accountUISettings__hideUseATemplateInPrepareMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__hideUseATemplateInPrepareMetadata__uiOrderstringReserved for Docusign.
allowManagingEnvelopesOnBehalfOfOthersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCommentsHistoryDownloadInSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableIdfxPhoneAuthSignatureAuthStatusMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableInboxBrowseViewsPoweredByElasticSearchMetadata__optionsstring[]An array of option strings supported by this setting.
enableInboxBrowseViewsPoweredByElasticSearchMetadata__uiOrderstringReserved for Docusign.
selfSignedRecipientEmailDocumentUserOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
selfSignedRecipientEmailDocumentUserOverrideMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__approveDeclineTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__enableTabAgreementDetailsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__enableTabAgreementDetailsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__enableTabAgreementDetailsMetadata__uiTypestringReserved for Docusign.
tabAccountSettings__firstLastEmailTabsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useNewEnvelopeSearchOnlyWithSearchTermMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEnvelopeCopyWithDataMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableEnvelopeCopyWithDataMetadata__uiOrderstringReserved for Docusign.
allowOrganizationToUseInPersonElectronicNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationToUseInPersonElectronicNotaryMetadata__uiHintstringReserved for Docusign.
allowOrganizationToUseInPersonElectronicNotaryMetadata__uiTypestringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enablePremiumDataVerificationExtensionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSMSDeliveryAdditionalNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
phoneAuthRecipientMayProvidePhoneNumberMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerInSessionUseEnvelopeCompleteEmailMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__enableTabAgreementDetailsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__enableTabAgreementDetailsMetadata__uiOrderstringReserved for Docusign.
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__uiHintstringReserved for Docusign.
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__uiTypestringReserved for Docusign.
accountUISettings__allowUsersToEditSharedAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__allowUsersToEditSharedAccessMetadata__uiHintstringReserved for Docusign.
accountUISettings__allowUsersToEditSharedAccessMetadata__uiTypestringReserved for Docusign.
accountUISettings__enableEasySignTemplateUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableEasySignTemplateUploadMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableEasySignTemplateUploadMetadata__uiTypestringReserved for Docusign.
allowAdvancedRecipientRoutingConditionalMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseInPersonElectronicNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationToUseInPersonElectronicNotaryMetadata__uiOrderstringReserved for Docusign.
enableAdditionalAdvancedWebFormsFeaturesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableCustomerSatisfactionMetricTrackingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__uiHintstringReserved for Docusign.
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__uiTypestringReserved for Docusign.
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__optionsstring[]An array of option strings supported by this setting.
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__uiOrderstringReserved for Docusign.
accountUISettings__allowUsersToEditSharedAccessMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__allowUsersToEditSharedAccessMetadata__uiOrderstringReserved for Docusign.
accountUISettings__clickwrapSchemaVersionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEasySignTemplateUploadMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableEasySignTemplateUploadMetadata__uiOrderstringReserved for Docusign.
accountUISettings__shouldRedactAccessCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__uploadNewImageToSignOrInitialMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__uploadNewImageToSignOrInitialMetadata__uiHintstringReserved for Docusign.
accountUISettings__uploadNewImageToSignOrInitialMetadata__uiTypestringReserved for Docusign.
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__uiHintstringReserved for Docusign.
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__uiTypestringReserved for Docusign.
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__optionsstring[]An array of option strings supported by this setting.
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__senderToChangeTabAssignmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
tabAccountSettings__senderToChangeTabAssignmentsMetadata__uiHintstringReserved for Docusign.
tabAccountSettings__senderToChangeTabAssignmentsMetadata__uiTypestringReserved for Docusign.
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__uiHintstringReserved for Docusign.
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__uiTypestringReserved for Docusign.
EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accessCodeFormat__specialCharacterRequiredMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__uploadNewImageToSignOrInitialMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__uploadNewImageToSignOrInitialMetadata__uiOrderstringReserved for Docusign.
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__optionsstring[]An array of option strings supported by this setting.
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__uiOrderstringReserved for Docusign.
tabAccountSettings__senderToChangeTabAssignmentsMetadata__optionsstring[]An array of option strings supported by this setting.
tabAccountSettings__senderToChangeTabAssignmentsMetadata__uiOrderstringReserved for Docusign.
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__optionsstring[]An array of option strings supported by this setting.
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableLegacySendflowLinkMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__orderBasedRecipientIdGenerationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__orderBasedRecipientIdGenerationMetadata__uiHintstringReserved for Docusign.
accountUISettings__orderBasedRecipientIdGenerationMetadata__uiTypestringReserved for Docusign.
accountUISettings__removeEnvelopeForwardingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hasExternalLinkedAccountsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__hideUseATemplateInPrepareMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__orderBasedRecipientIdGenerationMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__orderBasedRecipientIdGenerationMetadata__uiOrderstringReserved for Docusign.
enableInboxBrowseViewsPoweredByElasticSearchMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentUserOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEnvelopeCopyWithDataMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__enableTabAgreementDetailsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseInPersonElectronicNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__allowUsersToEditSharedAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEasySignTemplateUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__uploadNewImageToSignOrInitialMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowOrganizationToUseThirdPartyElectronicNotaryMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
tabAccountSettings__senderToChangeTabAssignmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__uiHintstringReserved for Docusign.
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__uiTypestringReserved for Docusign.
accountUISettings__orderBasedRecipientIdGenerationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__optionsstring[]An array of option strings supported by this setting.
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__uiOrderstringReserved for Docusign.
accountUISettings__enableEasySignCanUseMultiTemplateApplyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update account stamp by idDOCUSIGN_UPDATE_ACCOUNT_STAMP_BY_IDAcciónThis endpoint allows you to update an existing account stamp (signature) in docusign. it provides extensive customization options for the stamp's appearance, associated users, and properties. use this when you need to modify an existing stamp's details, such as its image, font, size, or user permissions. the endpoint is particularly useful for maintaining up-to-date and personalized stamps for document signing. note that this operation will overwrite the existing stamp properties, so ensure all desired properties are included in the request, even if they haven't changed.
DOCUSIGN_UPDATE_ACCOUNT_STAMP_BY_IDAcciónThis endpoint allows you to update an existing account stamp (signature) in docusign. it provides extensive customization options for the stamp's appearance, associated users, and properties. use this when you need to modify an existing stamp's details, such as its image, font, size, or user permissions. the endpoint is particularly useful for maintaining up-to-date and personalized stamps for document signing. note that this operation will overwrite the existing stamp properties, so ensure all desired properties are included in the request, even if they haven't changed.
Parámetros de entrada
nrdsIdstringThe National Association of Realtors (NAR) membership ID for a user who is a realtor.
accountIdstringThe 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".
imageTypestringSpecificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`
isDefaultstringBoolean that specifies whether the signature is the default signature for the user.
externalIDstringOptionally specify an external identifier for the user"s signature.
signatureIdstringObligatorioSpecifies 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.
stampFormatstringThe 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.
stampSizeMMstringThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
nrdsLastNamestringThe realtor"s last name.
phoneticNamestringThe phonetic spelling of the `signatureName`.
signatureFontstringThe 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"`
signatureNamestringSpecifies the user"s signature name.
signatureTypestringSpecifies the type of signature.
signatureUsersobject[]signatureGroupsobject[]signatureInitialsstringSpecifies the user"s signature in initials format.
disallowUserResizeStampstringWhen **true,** users may not resize the stamp.
close_existing_signaturestringAn 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.
dateStampProperties__dateAreaXstringThe X axis position of the top-left corner.
dateStampProperties__dateAreaYstringThe Y axis position of the top-left corner.
dateStampProperties__dateAreaWidthstringThe width of the rectangle.
dateStampProperties__dateAreaHeightstringThe height of the rectangle.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateaccountstampsDOCUSIGN_UPDATE_ACCOUNT_STAMPSAcciónThis endpoint allows you to add or update one or more account stamps (signatures) for a docusign account. it provides extensive flexibility in modifying various attributes of signatures, including images, fonts, rights, and stamp details. use this endpoint when you need to create new signatures or modify existing ones for an account, such as updating signature images, changing default settings, or adjusting stamp properties. the endpoint supports batch updates, allowing multiple signatures to be modified in a single request. note that this operation may include handling of image data in multi-part format.
DOCUSIGN_UPDATE_ACCOUNT_STAMPSAcciónThis endpoint allows you to add or update one or more account stamps (signatures) for a docusign account. it provides extensive flexibility in modifying various attributes of signatures, including images, fonts, rights, and stamp details. use this endpoint when you need to create new signatures or modify existing ones for an account, such as updating signature images, changing default settings, or adjusting stamp properties. the endpoint supports batch updates, allowing multiple signatures to be modified in a single request. note that this operation may include handling of image data in multi-part format.
Parámetros de entrada
accountIdstringThe 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.
accountSignaturesobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update account watermark informationDOCUSIGN_UPDATE_ACCOUNT_WATERMARK_INFORMATIONAcciónThis 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.
DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_INFORMATIONAcciónThis 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.
Parámetros de entrada
idstringThe ID of the watermark.
fontstringThe watermark"s font. Valid values: - `courier` - `helvetica` - `timesnewroman`
enabledstringWhen **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied.
fontSizestringThe watermark"s font size. Valid values: * `30` * `40` * `50` * `60` * `70` * `80` * `90`
accountIdstringThe 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.
fontColorstringThe watermark"s font color. Valid values: * `black` * `blue` * `red` * `gray` * `yellow`
imageBase64stringThe Base64 representation of the watermark image. This property is read-only.
displayAnglestringThe display angle of the watermark. Valid values: * 0 (horizontal) * 45 (diagonal) * 90 (vertical)
transparencystringThe transparency percentage of the watermark image. Valid values: * `5` * `10` * `15` * `20` * `25` * `30` * `35` * `40` * `45`
watermarkTextstringThe text for the watermark.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateaccountwatermarkpreviewDOCUSIGN_UPDATE_ACCOUNT_WATERMARK_PREVIEWAcciónUpdates and previews watermark settings for a docusign account. it customizes watermark appearance, including text, font, color, size, angle, and transparency. use when changing account-wide watermark configurations or previewing new settings. note: many fields require specific values; invalid inputs may default silently. this endpoint sets account watermark configuration, not document-specific application.
DOCUSIGN_UPDATE_ACCOUNT_WATERMARK_PREVIEWAcciónUpdates and previews watermark settings for a docusign account. it customizes watermark appearance, including text, font, color, size, angle, and transparency. use when changing account-wide watermark configurations or previewing new settings. note: many fields require specific values; invalid inputs may default silently. this endpoint sets account watermark configuration, not document-specific application.
Parámetros de entrada
idstringThe ID of the watermark.
fontstringThe watermark"s font. Valid values: - `courier` - `helvetica` - `timesnewroman`
enabledstringWhen **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied.
fontSizestringThe watermark"s font size. Valid values: * `30` * `40` * `50` * `60` * `70` * `80` * `90`
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which the watermark settings will be updated. This parameter is required and must be provided in the path of the API request.
fontColorstringThe watermark"s font color. Valid values: * `black` * `blue` * `red` * `gray` * `yellow`
imageBase64stringThe Base64 representation of the watermark image. This property is read-only.
displayAnglestringThe display angle of the watermark. Valid values: * 0 (horizontal) * 45 (diagonal) * 90 (vertical)
transparencystringThe transparency percentage of the watermark image. Valid values: * `5` * `10` * `15` * `20` * `25` * `30` * `35` * `40` * `45`
watermarkTextstringThe text for the watermark.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update billing plan for accountDOCUSIGN_UPDATE_BILLING_PLAN_FOR_ACCOUNTAcciónUpdates 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.
DOCUSIGN_UPDATE_BILLING_PLAN_FOR_ACCOUNTAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe 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.
taxExemptIdstringenablePreAuthstringenableSupportstringWhen **true,** customer support is provided as part of the account plan.
includedSeatsstringThe number of seats (users) included in the plan.
paymentMethodstringThe payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit`
renewalStatusstringThe 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`.
processPaymentstringdowngradeReasonstring(Optional) The user"s reason for downgrading their billing plan.
incrementalSeatsstringReserved for Docusign.
paymentProcessorstringsaleDiscountAmountstringReserved for Docusign.
billingAddress__faxstringThe fax number associated with the account.
saleDiscountPercentstringReserved for Docusign.
saleDiscountPeriodsstringReserved for Docusign.
billingAddress__citystringThe city associated with the address. Maximum length: 40 characters.
preview_billing_planstringAn 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.
billingAddress__emailstringThe email address associated with the account.
billingAddress__phonestringThe phone number associated with the account.
billingAddress__statestringThe state or province associated with the address. Maximum length: 40 characters.
billingAddress__countrystringThe country associated with the address. Maximum length: 50 characters.
planInformation__addOnsobject[]Reserved for Docusign.
planInformation__planIdstringDocusign"s ID for the account plan.
saleDiscountFixedAmountstringReserved for Docusign.
billingAddress__address1stringThe first line of the address. Maximum length: 100 characters.
billingAddress__address2stringThe second line of the address. Maximum length: 100 characters.
billingAddress__lastNamestringThe last name of the user associated with the account.
billingAddress__firstNamestringThe first name of the user associated with the account. Maximum Length: 50 characters.
appStoreReceipt__productIdstringThe Product ID from the AppStore.
billingAddress__postalCodestringThe postal code associated with the address. Maximum length: 20 characters.
referralInformation__idTypestringappStoreReceipt__receiptDatastringReserved for Docusign.
planInformation__currencyCodestringSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
referralInformation__industrystringThe name of the industry associated with the referral. Example: `Accounting`
saleDiscountSeatPriceOverridestringReserved for Docusign.
referralInformation__promoCodestringreferralInformation__shopperIdstringcreditCardInformation__cardTypestringThe type of credit card. Valid values are: - `visa` - `mastercard` - `amex`
creditCardInformation__cvNumberstringThe 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).
planInformation__planFeatureSetsobject[]Reserved for Docusign.
referralInformation__publisherIdstringcreditCardInformation__cardNumberstringThe credit card number.
creditCardInformation__nameOnCardstringThe exact name as it appears on the credit card.
planInformation__recipientDomainsobject[]referralInformation__referralCodestringreferralInformation__referrerNamestringThe name of the referrer.
billingAddress__supportedCountriesobject[]An array of supported countries associated with the account.
paymentProcessorInformation__emailstringThe email address associated with the payment processor.
referralInformation__enableSupportstringWhen **true,** customer support is provided as part of the account plan.
referralInformation__externalOrgIdstringAn optional external ID for the referral.
referralInformation__groupMemberIdstringreferralInformation__includedSeatsstringThe number of seats (users) included in the plan.
appStoreReceipt__downgradeProductIdstringcreditCardInformation__address__faxstringA fax number associated with the address, if one is available.
referralInformation__planStartMonthstringcreditCardInformation__address__citystringThe user"s city. Maximum length: 40 characters.
creditCardInformation__tokenizedCardstringreferralInformation__advertisementIdstringA 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.
creditCardInformation__address__phonestringA phone number associated with the address.
creditCardInformation__cardLastDigitsstringcreditCardInformation__expirationYearstringThe year in which the credit card expires, in 4-digit format.
directDebitProcessorInformation__iBANstringThe International Bank Account Number (IBAN). Example: `DE89370400440532013000` For more information, see [PeopleSoft"s guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm). **Note:** This number will be obfuscated.
creditCardInformation__expirationMonthstringThe month that the credit card expires, expressed as a number from 1 to 12.
directDebitProcessorInformation__emailstringThe 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.
planInformation__freeTrialDaysOverridestringReserved for Docusign.
creditCardInformation__address__countrystringThe user"s country. Maximum length: 50 characters.
referralInformation__saleDiscountAmountstringReserved for Docusign.
appStoreReceipt__isDowngradeCancellationstringcreditCardInformation__address__address1stringThe first line of the user"s address. Maximum length: 100 characters.
creditCardInformation__address__address2stringThe second line of the user"s address. Maximum length: 100 characters.
creditCardInformation__address__zipPlus4stringdirectDebitProcessorInformation__countrystringThe user"s country. The system populates this value automatically.
referralInformation__saleDiscountPercentstringReserved for Docusign.
referralInformation__saleDiscountPeriodsstringReserved for Docusign.
directDebitProcessorInformation__bankCodestringThe code or number that identifies the bank. This is also known as the sort code. Example: `200000` Maximum Length: 18 characters.
directDebitProcessorInformation__bankNamestringThe name of the direct debit bank. Maximum Length: 80 characters.
directDebitProcessorInformation__lastNamestringThe user"s last name. This field is required for POST and PUT requests. Maximum Length: 70 characters.
paymentProcessorInformation__address__faxstringA fax number associated with the address, if one is available.
creditCardInformation__address__postalCodestringThe user"s postal code. Maximum length: 20 characters.
directDebitProcessorInformation__firstNamestringThe user"s first name. This field is required for POST and PUT requests. Maximum Length: 30 characters.
paymentProcessorInformation__address__citystringThe user"s city. Maximum length: 40 characters.
paymentProcessorInformation__address__phonestringA phone number associated with the address.
referralInformation__saleDiscountFixedAmountstringReserved for Docusign.
paymentProcessorInformation__address__countrystringThe user"s country. Maximum length: 50 characters.
paymentProcessorInformation__address__address1stringThe first line of the user"s address. Maximum length: 100 characters.
paymentProcessorInformation__address__address2stringThe second line of the user"s address. Maximum length: 100 characters.
paymentProcessorInformation__address__zipPlus4stringcreditCardInformation__address__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
directDebitProcessorInformation__bankBranchCodestringThe branch code of the bank used for direct debit. Maximum Length: 10 characters.
directDebitProcessorInformation__bankCheckDigitstringThe 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.
paymentProcessorInformation__billingAgreementIdstringThe ID of the billing agreement.
paymentProcessorInformation__address__postalCodestringThe user"s postal code. Maximum length: 20 characters.
directDebitProcessorInformation__bankTransferTypestringSpecifies 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`
referralInformation__saleDiscountSeatPriceOverridestringReserved for Docusign.
paymentProcessorInformation__address__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
directDebitProcessorInformation__bankTransferAccountNamestringThe name on the direct debit bank account. This field is required for POST and PUT requests. Maximum Length: 60 characters.
directDebitProcessorInformation__bankTransferAccountNumberstringThe customer"s bank account number. This value will be obfuscated. This field is required for POST and PUT requests. Maximum Length: 30 characters.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatebulksendbatchnameDOCUSIGN_UPDATE_BULK_SEND_BATCH_NAMEAcciónUpdates the name of an existing bulk send batch in docusign. this endpoint allows users to rename a specific batch identified by its batch id within a given docusign account. it's useful for organizing and managing multiple bulk send batches, especially when dealing with large-scale document processing. the operation returns detailed information about the updated batch, including its current status, envelope information, and any potential errors. this endpoint should be used when you need to modify the name of a bulk send batch for better identification or organization purposes. it doesn't modify any other properties of the batch or its associated envelopes. note that while the operation itself is straightforward, it's important to ensure the provided batch id is valid and the new name adheres to the 500-character limit.
DOCUSIGN_UPDATE_BULK_SEND_BATCH_NAMEAcciónUpdates the name of an existing bulk send batch in docusign. this endpoint allows users to rename a specific batch identified by its batch id within a given docusign account. it's useful for organizing and managing multiple bulk send batches, especially when dealing with large-scale document processing. the operation returns detailed information about the updated batch, including its current status, envelope information, and any potential errors. this endpoint should be used when you need to modify the name of a bulk send batch for better identification or organization purposes. it doesn't modify any other properties of the batch or its associated envelopes. note that while the operation itself is straightforward, it's important to ensure the provided batch id is valid and the new name adheres to the 500-character limit.
Parámetros de entrada
accountIdstringThe 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.
batchNamestringThe new name of the bulk send batch. This property is required. The maximum length of the string is 500 characters.
bulkSendBatchIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update connect oauth configurationDOCUSIGN_UPDATE_CONNECT_OAUTH_CONFIGURATIONAcciónThis 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.
DOCUSIGN_UPDATE_CONNECT_OAUTH_CONFIGURATIONAcciónThis 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.
Parámetros de entrada
scopestringThe 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`
clientIdstringThe client ID assigned to your app by your authorization server or OAuth service. This property is required.
accountIdstringThe 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 required and must be provided in the path of the API request.
clientSecretstringThe secret value provided by your authorization server. This property is required.
customParametersstringauthorizationServerUrlstringThe token URL for your authorization server or OAuth service. This property is required.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update contacts informationDOCUSIGN_UPDATE_CONTACTS_INFORMATIONAcciónThis 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.
DOCUSIGN_UPDATE_CONTACTS_INFORMATIONAcciónThis 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account for which contacts are being updated. This parameter is required and must be provided in the path of the API request.
contactListobject[]A list of contacts.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update custom fields in envelope documentDOCUSIGN_UPDATE_CUSTOM_FIELDS_IN_ENVELOPE_DOCUMENTAcciónThis 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.
DOCUSIGN_UPDATE_CUSTOM_FIELDS_IN_ENVELOPE_DOCUMENTAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe 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.
envelopeIdstringObligatorioThe 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.
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update custom tab information for accountDOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNTAcciónThis 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.
DOCUSIGN_UPDATE_CUSTOM_TAB_INFORMATION_FOR_ACCOUNTAcciónThis 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.
Parámetros de entrada
boldstringWhen **true,** the information in the tab is bold.
fontstringThe 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
namestringtypestringThe 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`
itemsstring[]If the tab is a list, this represents the values that are possible for the tab.
widthstringThe width of the tab in pixels. Must be an integer.
anchorstringAn optional string that is used to auto-match tabs to strings located in the documents of an envelope.
heightstringThe height of the tab in pixels. Must be an integer.
italicstringWhen **true,** the information in the tab is italic.
lockedstringWhen **true,** the signer cannot change the data of the custom tab.
sharedstringWhen **true,** this custom tab is shared.
editablestringWhen **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.
fontSizestringThe 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
requiredstringWhen **true,** the signer is required to fill out this tab.
selectedstringWhen **true,** the radio button is selected.
tabLabelstringThe 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.
accountIdstringThe 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".
fontColorstringThe font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
stampTypestringThe type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null
underlinestringWhen **true,** the information in the tab is underlined.
requireAllstringWhen **true** and shared is true, information must be entered in this field to complete the envelope.
scaleValuestringSets 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.
anchorUnitsstringSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
customTabIdstringObligatorioThe 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.
initialValuestringThe original value of the tab.
lastModifiedstringThe UTC DateTime this object was last modified. This is in ISO 8601 format.
anchorXOffsetstringSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetstringSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
collaborativestringmaximumLengthstringThe maximum number of entry characters supported by the custom tab.
numericalValuestringvalidationTypestringSpecifies how numerical data is validated. Valid values: - `number` - `currency`
createdByUserIdstringThe userId of the Docusign user who created this object.
disableAutoSizestringWhen **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.
includedInEmailstringWhen **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
mergeField__rowstringSpecifies the row number in a Salesforce table that the merge field value corresponds to.
paymentItemCodestringIf 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.
paymentItemNamestringIf 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`
mergeField__pathstringSets the object associated with the custom tab. Currently this is the Salesforce Object.
maxNumericalValuestringminNumericalValuestringvalidationMessagestringThe message displayed if the custom tab fails input validation (either custom of embedded).
validationPatternstringA regular expression used to validate input for the tab.
anchorCaseSensitivestringThis 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/
signatureProviderIdstringReserved for Docusign.
anchorMatchWholeWordstringWhen **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/
createdByDisplayNamestringThe user name of the Docusign user who created this object.
lastModifiedByUserIdstringThe userId of the Docusign user who last modified this object.
mergeField__writeBackstringWhen **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
concealValueOnDocumentstringWhen **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.
localePolicy__timeZonestringSpecifies 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`
paymentItemDescriptionstringIf 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.
anchorIgnoreIfNotPresentstringWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
mergeField__pathExtendedobject[]Reserved for Docusign.
anchorHorizontalAlignmentstringThis 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/
lastModifiedByDisplayNamestringThe User Name of the Docusign user who last modified this object.
localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
stampTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/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`
stampTypeMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
requireInitialOnSharedChangestringOptional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
mergeField__allowSenderToEditstringWhen **true,** the sender can modify the value of the `mergeField` tab during the sending process.
mergeField__configurationTypestringIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
localePolicy__customDateFormatstringlocalePolicy__customTimeFormatstringmergeField__rowMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__pathMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__rowMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__pathMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__useLongCurrencyFormatstringWhen **true,** use the long currency format for the locale.
localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
mergeField__writeBackMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__writeBackMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__pathExtendedMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__pathExtendedMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__allowSenderToEditMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__configurationTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
mergeField__allowSenderToEditMetadata__optionsstring[]An array of option strings supported by this setting.
mergeField__configurationTypeMetadata__optionsstring[]An array of option strings supported by this setting.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatedocumentvisibilityrecipientsDOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTSAcciónThis endpoint updates document visibility settings for one or more recipients within a specific docusign envelope. it allows you to control which documents each recipient can see and whether they have read-only or edit rights. the method is particularly useful for managing complex envelopes with multiple documents and recipients, ensuring that sensitive information is only accessible to intended parties. note that certain recipient types (carbon copy, certified delivery, editor, and agent) always have visibility to all documents, and documents with assigned tabs cannot be hidden from their respective recipients.
DOCUSIGN_UPDATE_DOCUMENT_VISIBILITY_RECIPIENTSAcciónThis endpoint updates document visibility settings for one or more recipients within a specific docusign envelope. it allows you to control which documents each recipient can see and whether they have read-only or edit rights. the method is particularly useful for managing complex envelopes with multiple documents and recipients, ensuring that sensitive information is only accessible to intended parties. note that certain recipient types (carbon copy, certified delivery, editor, and agent) always have visibility to all documents, and documents with assigned tabs cannot be hidden from their respective recipients.
Parámetros de entrada
accountIdstringThe 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 envelope belongs to.
envelopeIdstringObligatorioThe unique identifier for the envelope whose document visibility settings are being updated. 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".
documentVisibilityobject[]An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update docusign connect configurationDOCUSIGN_UPDATE_DOCUSIGN_CONNECT_CONFIGURATIONAcciónThis 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.
DOCUSIGN_UPDATE_DOCUSIGN_CONNECT_CONFIGURATIONAcciónThis 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.
Parámetros de entrada
namestringThe name of the Connect configuration. This property is required.
eventsstring[]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](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property. The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) 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`
userIdsstring[]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.
allUsersstringWhen **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.
groupIdsstring[]passwordstringThe password for the Connect configuration. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.
userNamestringThe name of the user.
accountIdstringThe 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.
connectIdstringThe Docusign-generated ID for the Connect configuration. This property is read-only.
enableLogstringWhen **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.
sfObjectsobject[]An array of Salesforce objects.
disabledBystringincludeHMACstringdeliveryModestringThe delivery mode of the configuration. Valid values: * `SIM` * `Aggregate`
includeOAuthstringsoapNamespacestringThe namespace of the SOAP interface. **Note:** If `useSoapInterface` is set to **true,** you must set this value.
allUsersExceptstringThis 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.**
envelopeEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `Delivered` * `Completed` * `Declined` * `Voided` **Note:** These values are case-sensitive.
senderOverridestringurlToPublishTostringThe web address of the listener or retrieving service endpoint. It must be an HTTPS URL.
recipientEventsstring[]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](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `AutoResponded` * `Delivered` * `Completed` * `Declined` * `AuthenticationFailed` **Note:** These values are case-sensitive.
externalFolderIdstringThe ID of an external folder.
includeDocumentsstringReserved for Docusign.
requireMutualTlsstringWhen **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled.
useSoapInterfacestringWhen **true,** the notifications are sent to your endpoint as SOAP requests.
configurationTypestringThe type of the configuration. Valid values: * `custom`: Creates an account-level configuration * `customrecipient`: Creates a Recipient Connect configuration * `salesforce` * `eOriginal` This property is required.
eventData__formatstringReserved for Docusign.
integratorManagedstringeventData__versionstringSet 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.
salesforceAuthcodestringexternalFolderLabelstringThe label for an external folder.
allowEnvelopePublishstringSet this value to **true** to enable the webhook. The default property is **false.**
salesforceApiVersionstringThe version of the Salesforce API that you are using.
includeCertSoapHeaderstringincludeDocumentFieldsstringWhen **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.
salesforceCallBackUrlstringsenderSelectableItemsstring[]This property sets the items that are available for selection when adding or editing Connect objects.
allowSalesforcePublishstringWhen **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.**
eventData__includeDatastring[]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](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope. - `recipients`: Include the recipients associated with the envelope. - `tabs`: Include the tabs associated with the envelope.
requiresAcknowledgementstringWhen **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.
includeEnvelopeVoidReasonstringWhen **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
includeTimeZoneInformationstringWhen **true,** Connect will include the envelope time zone information.
includeCertificateOfCompletionstringWhen **true,** the Connect Service includes the Certificate of Completion with completed envelopes.
signMessageWithX509CertificatestringWhen **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.
includeSenderAccountasCustomFieldstringWhen **true,** Connect will include the sender account as Custom Field in the data.
salesforceDocumentsAsContentFilesstringWhen **true,** Docusign can use documents in your Salesforce account for sending and signing.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update electronic record disclosureDOCUSIGN_UPDATE_ELECTRONIC_RECORD_DISCLOSUREAcciónThis endpoint updates the electronic record and signature disclosure (ersd) for a docusign account. it allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. the endpoint is essential for compliance and tailoring the signer experience. only account administrators can use this method, and changes may require unsigned recipients to accept a new disclosure version.
DOCUSIGN_UPDATE_ELECTRONIC_RECORD_DISCLOSUREAcciónThis endpoint updates the electronic record and signature disclosure (ersd) for a docusign account. it allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. the endpoint is essential for compliance and tailoring the signer experience. only account administrators can use this method, and changes may require unsigned recipients to accept a new disclosure version.
Parámetros de entrada
pdfIdstring**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.
customstringWhen **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**
langCodestringObligatorioThe 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.
useBrandstringWhen **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.
accountIdstringThe 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.
esignTextstringThe 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.
changeEmailstringIf the customer needs to change their email address, this is the email address to which they should the change request. Maximum length: 100 characters.
companyNamestringSpecifies 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.**
enableEsignstringWhen **true** (default), indicates that eSign is enabled.
companyPhonestringThe phone number of the company associated with the consumer disclosure, as a free-formatted string.
languageCodestringThe 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`.
withdrawCitystringContains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters.
withdrawEmailstringContains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
withdrawOtherstringContains any other information needed to withdraw consent. Maximum length: 255 characters. Example: `We do not need any other information from you to withdraw consent.`
withdrawPhonestringContains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string. Maximum length: 20 characters.
withdrawStatestringContains the state of the postal address to which a customer can send a consent withdrawal notification. Example: `PA`
accountEsignIdstringThe GUID of the account associated with the consumer disclosure.
esignAgreementstringThe 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.
withdrawByMailstringWhen **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**
allowCDWithdrawstringWhen **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.
copyCostPerPagestringThe cost per page if the customer requests paper copies. Example: `0.0000`
withdrawByEmailstringWhen **true** (default), indicates that the customer can withdraw consent by email.
withdrawByPhonestringWhen **true,** indicates that the customer can withdraw consent by phone. The default is **false.**
changeEmailOtherstringOther 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.`
copyRequestEmailstringThe email address to which the customer should send a request for copies of a document. Maximum length: 100 characters.
include_metadatastringAn 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.
mustAgreeToEsignstringWhen **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.
withdrawPostalCodestringContains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters.
withdrawAddressLine1stringContains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
withdrawAddressLine2stringContains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.
withdrawConsequencesstringText indicating the consequences of withdrawing consent. Maximum length: 255 characters.
copyFeeCollectionMethodstringSpecifies 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.`
allowCDWithdrawMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowCDWithdrawMetadata__uiHintstringReserved for Docusign.
allowCDWithdrawMetadata__uiTypestringReserved for Docusign.
allowCDWithdrawMetadata__optionsstring[]An array of option strings supported by this setting.
allowCDWithdrawMetadata__uiOrderstringReserved for Docusign.
useConsumerDisclosureWithinAccountstringWhen **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
allowCDWithdrawMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
useConsumerDisclosureWithinAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
useConsumerDisclosureWithinAccountMetadata__uiHintstringReserved for Docusign.
useConsumerDisclosureWithinAccountMetadata__uiTypestringReserved for Docusign.
useConsumerDisclosureWithinAccountMetadata__optionsstring[]An array of option strings supported by this setting.
useConsumerDisclosureWithinAccountMetadata__uiOrderstringReserved for Docusign.
useConsumerDisclosureWithinAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateenoteintegrationconfigDOCUSIGN_UPDATE_ENOTE_INTEGRATION_CONFIGAcciónUpdates 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.
DOCUSIGN_UPDATE_ENOTE_INTEGRATION_CONFIGAcciónUpdates 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.
Parámetros de entrada
apiKeystringpasswordstringThe user"s encrypted password hash.
userNamestringThe user"s username.
accountIdstringThe 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.
organizationstringThe name of the organization.
eNoteConfiguredstringWhen **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.
connectConfiguredstringWhen **false,** the user must configure Connect and eOriginal for the integration to work.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope attachmentDOCUSIGN_UPDATE_ENVELOPE_ATTACHMENTAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_ATTACHMENTAcciónUpdates 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.
Parámetros de entrada
datastringA Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
namestringThe name of the attachment.
labelstringA label for the attachment. Potential values include: - `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
accountIdstringThe 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.
remoteUrlstringThe URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.
envelopeIdstringObligatorioThe 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".
attachmentIdstringObligatorioThe unique identifier for the attachment.
accessControlstringValid values are `sender` and `senderAndAllRecipients`.
attachmentTypestringSpecifies the type of the attachment for the recipient.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope custom fieldsDOCUSIGN_UPDATE_ENVELOPE_CUSTOM_FIELDSAcciónThis 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.
DOCUSIGN_UPDATE_ENVELOPE_CUSTOM_FIELDSAcciónThis 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID of 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 envelope custom fields are being updated.
envelopeIdstringObligatorioThe 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".
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateenvelopedelayedroutingrulesDOCUSIGN_UPDATE_ENVELOPE_DELAYED_ROUTING_RULESAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_DELAYED_ROUTING_RULESAcciónUpdates 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.
Parámetros de entrada
rulesobject[]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.
statusstringStatus 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.
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
resumeDatestringThe 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.
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Envelope DocGen Form FieldsDOCUSIGN_UPDATE_ENVELOPE_DOC_GEN_FORM_FIELDSAcciónThis 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.
DOCUSIGN_UPDATE_ENVELOPE_DOC_GEN_FORM_FIELDSAcciónThis 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.
Parámetros de entrada
account_idstringObligatorioThe external account number (int) or account ID GUID
envelope_idstringObligatorioThe envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
doc_gen_form_fieldsobject[]ObligatorioA list of document generation form fields organized by document
update_docgen_formfields_onlybooleanWhen false or omitted, the documents are updated. When true, only the form fields are updated. The documents are unchanged.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateenvelopeemailsettingsDOCUSIGN_UPDATE_ENVELOPE_EMAIL_SETTINGSAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_EMAIL_SETTINGSAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe external account number (integer) or account ID GUID of the DocuSign account. This parameter is required and must be provided in the path. It identifies the specific account for which the envelope email settings will be updated.
envelopeIdstringObligatorioThe 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".
bccEmailAddressesobject[]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.
replyEmailNameOverridestringThe name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.
replyEmailAddressOverridestringThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope notification settingsDOCUSIGN_UPDATE_ENVELOPE_NOTIFICATION_SETTINGSAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_NOTIFICATION_SETTINGSAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
useAccountDefaultsstringWhen **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.**
expirations__expireWarnstringAn 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.
expirations__expireAfterstringAn integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**
reminders__reminderDelaystringAn 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.
expirations__expireEnabledstringWhen **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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html).
reminders__reminderEnabledstringWhen **true,** reminders are enabled. The default value is **false.**
reminders__reminderFrequencystringAn integer specifying the interval in days between reminder emails. The default value is 0.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope scheduled sending rulesDOCUSIGN_UPDATE_ENVELOPE_SCHEDULED_SENDING_RULESAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_SCHEDULED_SENDING_RULESAcciónUpdates 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.
Parámetros de entrada
rulesobject[]User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
statusstringStatus 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.
accountIdstringThe 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.
bulkListIdstringThe ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
envelopeIdstringObligatorioThe 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"
resumeDatestringThe timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope workflow definitionDOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_DEFINITIONAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_DEFINITIONAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
resumeDatestringThe 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.
workflowStepsobject[]An array of workflow steps.
workflowStatusstringThe status of the workflow: - `paused` if the workflow is paused - `in_progress` if the workflow is in progress
currentWorkflowStepIdstringThe `workflowStepId` of the current step. This is not an index into the `workflowSteps` array in this object. See the `workflowStep` object.
scheduledSending__rulesobject[]User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
scheduledSending__statusstringStatus 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.
scheduledSending__bulkListIdstringThe ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
scheduledSending__resumeDatestringThe timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update envelope workflow stepDOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_STEPAcciónUpdates 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.
DOCUSIGN_UPDATE_ENVELOPE_WORKFLOW_STEPAcciónUpdates 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.
Parámetros de entrada
actionstringIndicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
itemIdstringThe unique ID of the item being triggered.
statusstringThe status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only.
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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.
completedDatestringThe timestamp of when the workflow step transitioned to `completed` status. This property is read-only.
triggerOnItemstringThe type of item that triggers this workflow step. Valid values: * `routing_order`
triggeredDatestringThe timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only.
workflowStepIdstringObligatorioA unique identifier for this workflow step. This property is read-only.
delayedRouting__rulesobject[]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.
delayedRouting__statusstringStatus 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.
delayedRouting__resumeDatestringThe 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.
recipientRouting__rules__conditionalRecipientsobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update group informationDOCUSIGN_UPDATE_GROUP_INFORMATIONAcciónUpdates group information and modifies or sets permission profiles for specified groups within a docusign account. this endpoint allows administrators to manage user groups, their names, and associated permissions efficiently. it should be used when there's a need to change group details or update permission settings for multiple users simultaneously. the endpoint provides a way to streamline user management and access control in docusign, particularly useful for large organizations with complex permission structures.
DOCUSIGN_UPDATE_GROUP_INFORMATIONAcciónUpdates group information and modifies or sets permission profiles for specified groups within a docusign account. this endpoint allows administrators to manage user groups, their names, and associated permissions efficiently. it should be used when there's a need to change group details or update permission settings for multiple users simultaneously. the endpoint provides a way to streamline user management and access control in docusign, particularly useful for large organizations with complex permission structures.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
nextUristringThe 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.
accountIdstringThe 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 groups are being updated.
endPositionstringThe last index position in the result set.
previousUristringThe 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.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
resultSetSizestringThe 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`.
startPositionstringThe starting index position of the current result set.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatelockforenvelopeDOCUSIGN_UPDATE_LOCK_FOR_ENVELOPEAcciónUpdates the lock information for a locked envelope in docusign. this endpoint allows you to modify the duration of the lock and the name of the application that locked the envelope. it's particularly useful when you need to extend the lock time or update the locking application's identifier. the endpoint requires the x-docusign-edit header for authentication and returns comprehensive information about the updated lock, including its new duration, expiration time, and a unique lock token for future operations. use this when managing long-running operations on envelopes to prevent conflicts from simultaneous edits.
DOCUSIGN_UPDATE_LOCK_FOR_ENVELOPEAcciónUpdates the lock information for a locked envelope in docusign. this endpoint allows you to modify the duration of the lock and the name of the application that locked the envelope. it's particularly useful when you need to extend the lock time or update the locking application's identifier. the endpoint requires the x-docusign-edit header for authentication and returns comprehensive information about the updated lock, including its new duration, expiration time, and a unique lock token for future operations. use this when managing long-running operations on envelopes to prevent conflicts from simultaneous edits.
Parámetros de entrada
lockTypestringThe type of lock. Currently `edit` is the only supported type.
accountIdstringThe 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. For example: "12345" or "8a9de7e5-xxxx-xxxx-xxxx-f7e816a180e1".
envelopeIdstringObligatorioThe unique identifier for the envelope you want to update the lock for. 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".
lockedByAppstringA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
useScratchPadstringWhen **true,** a scratchpad is used to edit information.
templatePasswordstringThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). 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.
lockDurationInSecondsstringThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update notary jurisdiction infoDOCUSIGN_UPDATE_NOTARY_JURISDICTION_INFOAcciónUpdates 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.
DOCUSIGN_UPDATE_NOTARY_JURISDICTION_INFOAcciónUpdates 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.
Parámetros de entrada
countystringThe county that the commission is valid in.
sealTypestringThe seal type used for this juridiction. - `not_available` - `system_created` - `user_uploaded`
commissionIdstringThe notary"s commission identification. This varies from jurisdiction to jurisdiction.
jurisdictionIdstringObligatorioThe 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.
registeredNamestringThe registered name of the notary.
jurisdiction__namestringThe name of the jurisdiction. Typically the state name.
commissionExpirationstringThe expiration date of the notary"s commission in format: `MM/DD/YYYY`.
jurisdiction__countystringThe county of the jurisdiction.
errorDetails__messagestringA brief message describing the error condition.
jurisdiction__enabledstringWhen **true,** this jurisdiction is enabled.
errorDetails__errorCodestringThe code associated with the error condition.
jurisdiction__countyInSealstringWhen **true,** the county name appears in the seal.
jurisdiction__jurisdictionIdstringThe 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`
jurisdiction__stateNameInSealstringWhen **true,** the name of the state appears in the seal.
jurisdiction__commissionIdInSealstringWhen **true,** the notary"s `comissionId` appears in the seal.
jurisdiction__notaryPublicInSealstringWhen **true,** the name of the notary appears in the seal.
jurisdiction__allowUserUploadedSealstringWhen **true,** the seal can be uploaded by the user.
jurisdiction__allowSystemCreatedSealstringWhen **true,** the seal can be generated by the platform.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatepermissionprofilesettingsDOCUSIGN_UPDATE_PERMISSION_PROFILE_SETTINGSAcciónThis 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.
DOCUSIGN_UPDATE_PERMISSION_PROFILE_SETTINGSAcciónThis 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.
Parámetros de entrada
usersobject[]A list of user objects containing information about the users who are associated with the account permission profile.
includestringAn 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.
accountIdstringThe 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.
userCountstringThe total number of users in the group associated with the account permission profile.
modifiedDateTimestringThe date and time when the permission profile was last modified.
modifiedByUsernamestringThe username of the user who last modified the permission profile.
settings__webFormsstringpermissionProfileIdstringObligatorioThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
permissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
settings__vaultingModestringReserved for Docusign.
settings__allowVaultingstringReserved for Docusign.
settings__powerFormRolestringThe PowerForms rights associated with the account permission profile. Valid values are: - `none` - `user` - `admin`
settings__allowApiAccessstringWhen **true,** users can manage documents by using the API.
settings__allowAutoTaggingstringWhen **true,** auto-tagging is enabled for the account.
settings__allowBulkSendingstringWhen **true,** bulk sending is enabled for users.
settings__allowTransactionsstringsettings__canCreateWorkspacesstringReserved for Docusign.
settings__disableOtherActionsstringWhen **true,** users can access the **Other Actions** menu.
settings__allowESealRecipientsstringWhen **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients.
settings__allowEnvelopeSendingstringWhen **true,** users can send envelopes.
settings__canCreateTransactionstringsettings__canDeleteTransactionstringsettings__allowedTemplateAccessstringSpecifies the level of access that users have to account templates. Valid values are: - `none` - `use` - `create` - `share`
settings__disableDocumentUploadstringWhen **true,** users cannot upload documents.
settings__allowAccountManagementstringWhen **true,** users have full administrative access to the account.
settings__allowSignerAttachmentsstringWhen **true,** users can add requests for attachments from signers.
settings__canSendEnvelopesViaSMSstringsettings__useNewSendingInterfacestringReserved for Docusign.
settings__allowApiAccessToAccountstringWhen **true,** users can access the account by using the eSignature API.
settings__allowWetSigningOverridestringWhen **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.
settings__allowedClickwrapsAccessstringsettings__enableApiRequestLoggingstringWhen **true,** API request logging is enabled. **Note:** Logging limits apply.
settings__allowedAddressBookAccessstringSpecifies the level of access that users have to the account"s address book. Valid values are: - `personal` - `useShared` - `usePersonalAndShared` - `personalAndShared`
settings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__webFormsMetadata__uiHintstringReserved for Docusign.
settings__webFormsMetadata__uiTypestringReserved for Docusign.
settings__allowApiSequentialSigningstringWhen **true,** users may specify sequential signing recipients when they send documents by using the API.
settings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__webFormsMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientstringWhen **true,** the Docusign Desktop Client is enabled for users.
settings__allowSupplementalDocumentsstringWhen **true,** senders can include supplemental documents.
settings__allowedOrchestrationAccessstringsettings__allowTaggingInSendAndCorrectstringWhen **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents.
settings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__vaultingModeMetadata__uiHintstringReserved for Docusign.
settings__vaultingModeMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowVaultingMetadata__uiHintstringReserved for Docusign.
settings__allowVaultingMetadata__uiTypestringReserved for Docusign.
settings__powerFormRoleMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__powerFormRoleMetadata__uiHintstringReserved for Docusign.
settings__powerFormRoleMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustReadstringWhen **true,** senders can require recipients to read supplemental documents.
settings__supplementalDocumentsMustViewstringWhen **true,** users can require recipients to view supplemental documents.
settings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
settings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiAccessMetadata__uiHintstringReserved for Docusign.
settings__allowApiAccessMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowVaultingMetadata__uiOrderstringReserved for Docusign.
settings__powerFormRoleMetadata__optionsstring[]An array of option strings supported by this setting.
settings__powerFormRoleMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiAccessMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersstringWhen **true,** users can send envelopes on behalf of others.
settings__canDeleteDocumentsInTransactionstringsettings__supplementalDocumentsMustAcceptstringWhen **true,** senders can require recipients to accept supplemental documents.
settings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowAutoTaggingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowAutoTaggingMetadata__uiHintstringReserved for Docusign.
settings__allowAutoTaggingMetadata__uiTypestringReserved for Docusign.
settings__allowBulkSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowBulkSendingMetadata__uiHintstringReserved for Docusign.
settings__allowBulkSendingMetadata__uiTypestringReserved for Docusign.
settings__enableSequentialSigningInterfacestringWhen **true,** the sequential signing user interface is enabled.
settings__signingUiVersionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__signingUiVersionMetadata__uiHintstringReserved for Docusign.
settings__signingUiVersionMetadata__uiTypestringReserved for Docusign.
settings__allowAutoTaggingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowAutoTaggingMetadata__uiOrderstringReserved for Docusign.
settings__allowBulkSendingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowBulkSendingMetadata__uiOrderstringReserved for Docusign.
settings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
settings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
settings__enableTransactionPointIntegrationstringReserved for Docusign.
settings__signingUiVersionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__signingUiVersionMetadata__uiOrderstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfacestringReserved for Docusign.
settings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
settings__canCreateWorkspacesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canCreateWorkspacesMetadata__uiHintstringReserved for Docusign.
settings__canCreateWorkspacesMetadata__uiTypestringReserved for Docusign.
settings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
settings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
settings__enableRecipientViewingNotificationsstringWhen **true,** senders are notified when recipients view the documents that they send.
settings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowESealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowESealRecipientsMetadata__uiHintstringReserved for Docusign.
settings__allowESealRecipientsMetadata__uiTypestringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowEnvelopeSendingMetadata__uiHintstringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__uiTypestringReserved for Docusign.
settings__allowVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientstringWhen **true,** users can be recipients of envelopes transferred to them by administrators of other accounts.
settings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
settings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
settings__canCreateWorkspacesMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canCreateWorkspacesMetadata__uiOrderstringReserved for Docusign.
settings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
settings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
settings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
settings__powerFormRoleMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowApiAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowESealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowESealRecipientsMetadata__uiOrderstringReserved for Docusign.
settings__allowEnvelopeSendingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowEnvelopeSendingMetadata__uiOrderstringReserved for Docusign.
settings__allowedTemplateAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedTemplateAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedTemplateAccessMetadata__uiTypestringReserved for Docusign.
settings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
settings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
settings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
settings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
settings__allowAccountManagementMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowAccountManagementMetadata__uiHintstringReserved for Docusign.
settings__allowAccountManagementMetadata__uiTypestringReserved for Docusign.
settings__allowSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
settings__allowSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
settings__allowedTemplateAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedTemplateAccessMetadata__uiOrderstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
settings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
settings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__useNewSendingInterfaceMetadata__uiHintstringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__uiTypestringReserved for Docusign.
settings__allowAccountManagementMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowAccountManagementMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiAccessToAccountMetadata__uiHintstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__uiTypestringReserved for Docusign.
settings__allowAutoTaggingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowBulkSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguagestringWhen **true,** senders can set the language of the email that is sent to recipients.
settings__allowSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
settings__allowWetSigningOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowWetSigningOverrideMetadata__uiHintstringReserved for Docusign.
settings__allowWetSigningOverrideMetadata__uiTypestringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedClickwrapsAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__uiTypestringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableApiRequestLoggingMetadata__uiHintstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__uiTypestringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypestringsettings__signingUiVersionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__useNewSendingInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__useNewSendingInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__allowApiAccessToAccountMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiAccessToAccountMetadata__uiOrderstringReserved for Docusign.
settings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowWetSigningOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowWetSigningOverrideMetadata__uiOrderstringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedAddressBookAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__uiTypestringReserved for Docusign.
settings__allowedClickwrapsAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedClickwrapsAccessMetadata__uiOrderstringReserved for Docusign.
settings__enableApiRequestLoggingMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableApiRequestLoggingMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiSequentialSigningMetadata__uiHintstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__uiTypestringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedAddressBookAccessMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiSequentialSigningMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowDocuSignDesktopClientMetadata__uiHintstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__uiTypestringReserved for Docusign.
settings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
settings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
settings__canCreateWorkspacesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowDocuSignDesktopClientMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowDocuSignDesktopClientMetadata__uiOrderstringReserved for Docusign.
settings__allowESealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowEnvelopeSendingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
settings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
settings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowTaggingInSendAndCorrectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowTaggingInSendAndCorrectMetadata__uiHintstringReserved for Docusign.
settings__allowTaggingInSendAndCorrectMetadata__uiTypestringReserved for Docusign.
settings__allowedTemplateAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowAccountManagementMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowTaggingInSendAndCorrectMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowTaggingInSendAndCorrectMetadata__uiOrderstringReserved for Docusign.
settings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
settings__useNewSendingInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowApiAccessToAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowWetSigningOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedClickwrapsAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableApiRequestLoggingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
settings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowApiSendingOnBehalfOfOthersMetadata__uiHintstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__uiTypestringReserved for Docusign.
settings__allowedAddressBookAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
settings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksstringWhen **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.
settings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
settings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowApiSendingOnBehalfOfOthersMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSequentialSigningMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
settings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableSequentialSigningInterfaceMetadata__uiHintstringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__uiTypestringReserved for Docusign.
settings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
settings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
settings__allowDocuSignDesktopClientMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesstringWhen **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account.
settings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableSequentialSigningInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableSequentialSigningInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableTransactionPointIntegrationMetadata__uiHintstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__uiTypestringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__useNewDocuSignExperienceInterfaceMetadata__uiHintstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__uiTypestringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableTransactionPointIntegrationMetadata__uiOrderstringReserved for Docusign.
settings__useNewDocuSignExperienceInterfaceMetadata__optionsstring[]An array of option strings supported by this setting.
settings__useNewDocuSignExperienceInterfaceMetadata__uiOrderstringReserved for Docusign.
settings__allowTaggingInSendAndCorrectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableRecipientViewingNotificationsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableRecipientViewingNotificationsMetadata__uiHintstringReserved for Docusign.
settings__enableRecipientViewingNotificationsMetadata__uiTypestringReserved for Docusign.
settings__allowedToBeEnvelopeTransferRecipientMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiHintstringReserved for Docusign.
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiTypestringReserved for Docusign.
settings__enableRecipientViewingNotificationsMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableRecipientViewingNotificationsMetadata__uiOrderstringReserved for Docusign.
settings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowedToBeEnvelopeTransferRecipientMetadata__uiOrderstringReserved for Docusign.
settings__allowApiSendingOnBehalfOfOthersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiHintstringReserved for Docusign.
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiTypestringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
settings__enableSequentialSigningInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowSendersToSetRecipientEmailLanguageMetadata__uiOrderstringReserved for Docusign.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
settings__enableTransactionPointIntegrationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__useNewDocuSignExperienceInterfaceMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableRecipientViewingNotificationsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowedToBeEnvelopeTransferRecipientMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowSendersToSetRecipientEmailLanguageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiHintstringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiTypestringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__optionsstring[]An array of option strings supported by this setting.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__uiOrderstringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiHintstringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiTypestringReserved for Docusign.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__uiOrderstringReserved for Docusign.
settings__receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
settings__allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdaterecipientdocumentvisibilityDOCUSIGN_UPDATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis 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.
DOCUSIGN_UPDATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
envelopeIdstringObligatorioThe 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".
recipientIdstringObligatorioA 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".
documentVisibilityobject[]An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update signing group detailsDOCUSIGN_UPDATE_SIGNING_GROUP_DETAILSAcciónUpdates 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.
DOCUSIGN_UPDATE_SIGNING_GROUP_DETAILSAcciónUpdates 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.
Parámetros de entrada
usersobject[]User management information.
createdstringThe UTC DateTime when the signing group was created. This property is read-only.
modifiedstringThe UTC DateTime when the signing group was last modified. This property is read-only.
accountIdstringThe 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.
createdBystringThe name of the user who created the signing group. This property is read-only.
groupNamestringThe name of the group.
groupTypestringThe type of the group. The only valid value for this request is `sharedSigningGroup`.
groupEmailstringThe email address for the signing group. You can use a group email address to email all of the group members at the same time.
modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
signingGroupIdstringObligatorioThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
errorDetails__messagestringA brief message describing the error condition.
errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatesigninggroupnamesDOCUSIGN_UPDATE_SIGNING_GROUP_NAMESAcciónUpdates the names of one or more existing signing groups in docusign. this endpoint allows you to modify the names of signing groups, which are collections of users grouped together for document signing purposes. it's useful when you need to rename signing groups to reflect organizational changes or improve clarity. the endpoint updates only the group names and doesn't modify other group properties or memberships. use this when you need to maintain accurate and up-to-date naming conventions for your signing groups.
DOCUSIGN_UPDATE_SIGNING_GROUP_NAMESAcciónUpdates the names of one or more existing signing groups in docusign. this endpoint allows you to modify the names of signing groups, which are collections of users grouped together for document signing purposes. it's useful when you need to rename signing groups to reflect organizational changes or improve clarity. the endpoint updates only the group names and doesn't modify other group properties or memberships. use this when you need to maintain accurate and up-to-date naming conventions for your signing groups.
Parámetros de entrada
groupsobject[]A collection group objects containing information about the groups.
accountIdstringThe 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 representation of either a numeric account number or a valid GUID (Globally Unique Identifier) associated with the DocuSign account for which you"re updating signing group names.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update template custom fieldsDOCUSIGN_UPDATE_TEMPLATE_CUSTOM_FIELDSAcciónUpdates 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.
DOCUSIGN_UPDATE_TEMPLATE_CUSTOM_FIELDSAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
listCustomFieldsobject[]An array of list custom fields.
textCustomFieldsobject[]An array of text custom fields.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatetemplatedelayedroutingrulesDOCUSIGN_UPDATE_TEMPLATE_DELAYED_ROUTING_RULESAcciónThis 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.
DOCUSIGN_UPDATE_TEMPLATE_DELAYED_ROUTING_RULESAcciónThis 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.
Parámetros de entrada
rulesobject[]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.
statusstringStatus 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.
accountIdstringThe 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.
resumeDatestringThe 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.
templateIdstringObligatorioThe 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.
workflowStepIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update template document custom fieldsDOCUSIGN_UPDATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSAcciónThis 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.
DOCUSIGN_UPDATE_TEMPLATE_DOCUMENT_CUSTOM_FIELDSAcciónThis 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.
Parámetros de entrada
accountIdstringThe 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.
documentIdstringObligatorioThe unique identifier of 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, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). This ID is used to specify which document"s custom fields should be updated within the template.
templateIdstringObligatorioThe 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.
documentFieldsobject[]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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Template Doc VisibilityDOCUSIGN_UPDATE_TEMPLATE_DOC_VISIBILITYAcciónThis 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.
DOCUSIGN_UPDATE_TEMPLATE_DOC_VISIBILITYAcciónThis 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.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the integer external account number or the account ID GUID. It is a required path parameter that specifies which account the template belongs to.
templateIdstringObligatorioThe 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.
documentVisibilityobject[]An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update template lock informationDOCUSIGN_UPDATE_TEMPLATE_LOCK_INFORMATIONAcciónThis 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.
DOCUSIGN_UPDATE_TEMPLATE_LOCK_INFORMATIONAcciónThis 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.
Parámetros de entrada
lockTypestringThe type of lock. Currently `edit` is the only supported type.
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
lockedByAppstringA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
useScratchPadstringWhen **true,** a scratchpad is used to edit information.
templatePasswordstringThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). 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.
lockDurationInSecondsstringThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update template notification settingsDOCUSIGN_UPDATE_TEMPLATE_NOTIFICATION_SETTINGSAcciónThis 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.
DOCUSIGN_UPDATE_TEMPLATE_NOTIFICATION_SETTINGSAcciónThis 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.
Parámetros de entrada
passwordstringThe user"s encrypted password hash.
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
useAccountDefaultsstringWhen **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.**
expirations__expireWarnstringAn 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.
expirations__expireAfterstringAn integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**
reminders__reminderDelaystringAn 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.
expirations__expireEnabledstringWhen **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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html).
reminders__reminderEnabledstringWhen **true,** reminders are enabled. The default value is **false.**
reminders__reminderFrequencystringAn integer specifying the interval in days between reminder emails. The default value is 0.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatetemplaterecipientdocumentvisibilityDOCUSIGN_UPDATE_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis endpoint updates the document visibility settings for a specific recipient in a docusign template. it allows you to control which documents are visible to particular recipients, enhancing document security and customizing the signing experience. use this when you need to modify document access for a recipient after a template has been created. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types (carbon copy, certified delivery, editor, and agent) will always have visibility to all documents.
DOCUSIGN_UPDATE_TEMPLATE_RECIPIENT_DOCUMENT_VISIBILITYAcciónThis endpoint updates the document visibility settings for a specific recipient in a docusign template. it allows you to control which documents are visible to particular recipients, enhancing document security and customizing the signing experience. use this when you need to modify document access for a recipient after a template has been created. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types (carbon copy, certified delivery, editor, and agent) will always have visibility to all documents.
Parámetros de entrada
accountIdstringThe unique identifier for the DocuSign account. This can be either the numeric external account number or the account ID GUID. Required parameter. Format: string.
templateIdstringObligatorioThe unique identifier for the template in which you want to update recipient document visibility. Required parameter. Format: string.
recipientIdstringObligatorioA unique identifier for the recipient within the template. 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. Format: string.
documentVisibilityobject[]An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatetemplatescheduledsendingrulesDOCUSIGN_UPDATE_TEMPLATE_SCHEDULED_SENDING_RULESAcciónUpdates the scheduled sending rules for a docusign template, allowing users to configure delayed sending for envelopes. this endpoint enables setting up either a relative delay or a specific future date for sending envelopes based on the template. it can be used to automate timed document delivery or coordinate with bulk send operations. the tool is particularly useful for managing complex document workflows that require precise timing or coordination with other business processes. note that the maximum delay allowed is 30 days from the time of the request.
DOCUSIGN_UPDATE_TEMPLATE_SCHEDULED_SENDING_RULESAcciónUpdates the scheduled sending rules for a docusign template, allowing users to configure delayed sending for envelopes. this endpoint enables setting up either a relative delay or a specific future date for sending envelopes based on the template. it can be used to automate timed document delivery or coordinate with bulk send operations. the tool is particularly useful for managing complex document workflows that require precise timing or coordination with other business processes. note that the maximum delay allowed is 30 days from the time of the request.
Parámetros de entrada
rulesobject[]User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
statusstringStatus 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.
accountIdstringThe 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 updated belongs to the correct account.
bulkListIdstringThe ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
resumeDatestringThe timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
templateIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdatetemplateworkflowdefinitionDOCUSIGN_UPDATE_TEMPLATE_WORKFLOW_DEFINITIONAcciónUpdates 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.
DOCUSIGN_UPDATE_TEMPLATE_WORKFLOW_DEFINITIONAcciónUpdates 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.
Parámetros de entrada
accountIdstringThe 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.
resumeDatestringThe 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.
templateIdstringObligatorioThe 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.
workflowStepsobject[]An array of workflow steps.
workflowStatusstringThe status of the workflow: - `paused` if the workflow is paused - `in_progress` if the workflow is in progress
currentWorkflowStepIdstringThe `workflowStepId` of the current step. This is not an index into the `workflowSteps` array in this object. See the `workflowStep` object.
scheduledSending__rulesobject[]User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
scheduledSending__statusstringStatus 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.
scheduledSending__bulkListIdstringThe ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
scheduledSending__resumeDatestringThe timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update user account settingsDOCUSIGN_UPDATE_USER_ACCOUNT_SETTINGSAcciónThis 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.
DOCUSIGN_UPDATE_USER_ACCOUNT_SETTINGSAcciónThis 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.
Parámetros de entrada
localestringThe user"s locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
userIdstringObligatorioThe ID of the user to access. This parameter is required and specifies which user"s settings are being updated. It"s important to note that users can only access their own information. Even a user with Admin rights cannot access another user"s settings using this endpoint. The userId must be a valid user identifier within the specified DocuSign account.
bulkSendstringWhen **true,** this user can use the bulk send feature for the account.
webFormsstringaccountIdstringThe 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.
adminOnlystringReserved for Docusign.
newSendUIstringReserved for Docusign.
modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
enableDSProstringReserved for Docusign.
timezoneDSTstringWhen true, daylight savings time is in effect for this user"s time zone.
modifiedDatestringThe date on which this user record was last modified.
modifiedPagestringNote referencing the page that modified this user record.
timezoneMaskstringThe custom DateTime format setting for this user.
vaultingModestringIndicates the specified Vaulting mode: - `none` - `estored` - `electronic_original`
powerFormModestringIndicates the Power Form mode setting for the user: - `none` - `admin` - `user`
apiCanExportACstringWhen **true,** this user can export authoritative copy for the account.
enableVaultingstringWhen **true,** Vaulting is enabled for the account.
timezoneOffsetstringThe 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`
canSendEnvelopestringWhen **true,** this user can send envelopes on the account.
canSignEnvelopestringWhen **true,** this user can sign envelopes.
expressSendOnlystringWhen **false,** this user can apply tabs to documents during the sending experience.
sealIdentifiersobject[]Information about the seals associated with this user.
allowAutoTaggingstringWhen **true,** the API returns suggested tabs for documents for this user.
canChargeAccountstringReserved for Docusign.
canLockEnvelopesstringReserved for Docusign.
canManageAccountstringWhen **true,** this user is an administrator for the account.
canUseScratchpadstringWhen **true,** this user can use a scratchpad to edit information.
allowTransactionsstringcanManageTemplatesstringWhen **true,** this user can manage templates for the account.
canSendAPIRequestsstringWhen **true,** this user can send API requests on the account.
allowSendOnBehalfOfstringWhen **true,** this user can send envelopes "on behalf of" other users through the API.
allow_all_languagesstringAn 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.
disableOtherActionsstringWhen **true,** this user can access the **Other Actions** menu.
templateApplyNotifystringWhen **true,** the system notifies this user before applying a matching template.
timezoneSendingPrefstringReserved for Docusign.
timezoneSigningPrefstringReserved for Docusign.
allowEsealRecipientsstringWhen **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
apiAccountWideAccessstringWhen **true,** indicates that this user can send envelope-specific API requests on the account.
canCreateTransactionstringcanDeleteTransactionstringcanManageDistributorstringReserved for Docusign.
canUseSmartContractsstringReserved for Docusign.
manageClickwrapsModestringWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
templateAutoMatchingstringWhen **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.
disableDocumentUploadstringWhen **true,** this user is prohibited from uploading documents during sending.
canSendEnvelopesViaSMSstringenableTransactionPointstringReserved for Docusign.
localeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localeMetadata__uiHintstringReserved for Docusign.
localeMetadata__uiTypestringReserved for Docusign.
localePolicy__timeZonestringSpecifies 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`
templateActiveCreationstringWhen **true,** a new template is created each time the user sends an envelope.
allowEnvelopeTransferTostringWhen **true,** this user can participate in envelope transfers on the account.
canBulkUploadAgreementsstringenableSignerAttachmentsstringWhen **true,** this user can use the signing attachments feature.
localeMetadata__optionsstring[]An array of option strings supported by this setting.
localeMetadata__uiOrderstringReserved for Docusign.
bulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
bulkSendMetadata__uiHintstringReserved for Docusign.
bulkSendMetadata__uiTypestringReserved for Docusign.
canEditSharedAddressbookstringWhen true, this user can edit the shared address book for the account.
localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
transactionPointUserNamestringReserved for Docusign.
webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
webFormsMetadata__uiHintstringReserved for Docusign.
webFormsMetadata__uiTypestringReserved for Docusign.
adminOnlyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
adminOnlyMetadata__uiHintstringReserved for Docusign.
adminOnlyMetadata__uiTypestringReserved for Docusign.
bulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
bulkSendMetadata__uiOrderstringReserved for Docusign.
canManageAgreementPartiesstringenableSequentialSigningUIstringWhen **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.
enableSignOnPaperOverridestringWhen **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.
localePolicy__allowRegionstringlocalePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
newSendUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
newSendUIMetadata__uiHintstringReserved for Docusign.
newSendUIMetadata__uiTypestringReserved for Docusign.
templatePageLevelMatchingstringWhen **true,** users see template matching functionality.
webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
webFormsMetadata__uiOrderstringReserved for Docusign.
adminOnlyMetadata__optionsstring[]An array of option strings supported by this setting.
adminOnlyMetadata__uiOrderstringReserved for Docusign.
allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
allowedOrchestrationAccessstringenableSequentialSigningAPIstringWhen **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.
localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
modifiedByMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
modifiedByMetadata__uiHintstringReserved for Docusign.
modifiedByMetadata__uiTypestringReserved for Docusign.
newSendUIMetadata__optionsstring[]An array of option strings supported by this setting.
newSendUIMetadata__uiOrderstringReserved for Docusign.
accountAgreementsAccessTypestringenableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableDSProMetadata__uiHintstringReserved for Docusign.
enableDSProMetadata__uiTypestringReserved for Docusign.
localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
modifiedByMetadata__optionsstring[]An array of option strings supported by this setting.
modifiedByMetadata__uiOrderstringReserved for Docusign.
recipientViewedNotificationstringWhen **true,** this user receives notifications when envelopes are viewed.
templateMatchingSensitivitystringPercentage used when matching templates.
timezoneDSTMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneDSTMetadata__uiHintstringReserved for Docusign.
timezoneDSTMetadata__uiTypestringReserved for Docusign.
transactionPointSiteNameURLstringReserved for Docusign.
enableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
enableDSProMetadata__uiOrderstringReserved for Docusign.
localePolicy__signDateFormatstringThe 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.
localePolicy__signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
modifiedDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
modifiedDateMetadata__uiHintstringReserved for Docusign.
modifiedDateMetadata__uiTypestringReserved for Docusign.
modifiedPageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
modifiedPageMetadata__uiHintstringReserved for Docusign.
modifiedPageMetadata__uiTypestringReserved for Docusign.
timezoneDSTMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneDSTMetadata__uiOrderstringReserved for Docusign.
timezoneMaskMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneMaskMetadata__uiHintstringReserved for Docusign.
timezoneMaskMetadata__uiTypestringReserved for Docusign.
vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
vaultingModeMetadata__uiHintstringReserved for Docusign.
vaultingModeMetadata__uiTypestringReserved for Docusign.
localeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
modifiedDateMetadata__optionsstring[]An array of option strings supported by this setting.
modifiedDateMetadata__uiOrderstringReserved for Docusign.
modifiedPageMetadata__optionsstring[]An array of option strings supported by this setting.
modifiedPageMetadata__uiOrderstringReserved for Docusign.
powerFormModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
powerFormModeMetadata__uiHintstringReserved for Docusign.
powerFormModeMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustReadstringWhen **true,** this user must both view and accept supplemental documents.
supplementalDocumentsMustViewstringWhen **true,** this user must view supplemental documents.
timezoneMaskMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneMaskMetadata__uiOrderstringReserved for Docusign.
vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
vaultingModeMetadata__uiOrderstringReserved for Docusign.
apiCanExportACMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
apiCanExportACMetadata__uiHintstringReserved for Docusign.
apiCanExportACMetadata__uiTypestringReserved for Docusign.
enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableVaultingMetadata__uiHintstringReserved for Docusign.
enableVaultingMetadata__uiTypestringReserved for Docusign.
localePolicy__customDateFormatstringlocalePolicy__customTimeFormatstringpowerFormModeMetadata__optionsstring[]An array of option strings supported by this setting.
powerFormModeMetadata__uiOrderstringReserved for Docusign.
timezoneOffsetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneOffsetMetadata__uiHintstringReserved for Docusign.
timezoneOffsetMetadata__uiTypestringReserved for Docusign.
allowRecipientLanguageSelectionstringWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
apiCanExportACMetadata__optionsstring[]An array of option strings supported by this setting.
apiCanExportACMetadata__uiOrderstringReserved for Docusign.
bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canDeleteDocumentsInTransactionstringcanSendEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSendEnvelopeMetadata__uiHintstringReserved for Docusign.
canSendEnvelopeMetadata__uiTypestringReserved for Docusign.
canSignEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSignEnvelopeMetadata__uiHintstringReserved for Docusign.
canSignEnvelopeMetadata__uiTypestringReserved for Docusign.
enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
enableVaultingMetadata__uiOrderstringReserved for Docusign.
localePolicy__effectiveTimeZonestringsupplementalDocumentsMustAcceptstringWhen **true,** this user must accept supplemental documents.
timezoneOffsetMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneOffsetMetadata__uiOrderstringReserved for Docusign.
webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
adminOnlyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canChargeAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canChargeAccountMetadata__uiHintstringReserved for Docusign.
canChargeAccountMetadata__uiTypestringReserved for Docusign.
canLockEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canLockEnvelopesMetadata__uiHintstringReserved for Docusign.
canLockEnvelopesMetadata__uiTypestringReserved for Docusign.
canManageAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canManageAccountMetadata__uiHintstringReserved for Docusign.
canManageAccountMetadata__uiTypestringReserved for Docusign.
canSendEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
canSendEnvelopeMetadata__uiOrderstringReserved for Docusign.
canSignEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
canSignEnvelopeMetadata__uiOrderstringReserved for Docusign.
canUseScratchpadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canUseScratchpadMetadata__uiHintstringReserved for Docusign.
canUseScratchpadMetadata__uiTypestringReserved for Docusign.
newSendUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentstringSets 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.
allowAccessToAllAccountAgreementsstringallowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowTransactionsMetadata__uiHintstringReserved for Docusign.
allowTransactionsMetadata__uiTypestringReserved for Docusign.
canChargeAccountMetadata__optionsstring[]An array of option strings supported by this setting.
canChargeAccountMetadata__uiOrderstringReserved for Docusign.
canLockEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
canLockEnvelopesMetadata__uiOrderstringReserved for Docusign.
canManageAccountMetadata__optionsstring[]An array of option strings supported by this setting.
canManageAccountMetadata__uiOrderstringReserved for Docusign.
canUseScratchpadMetadata__optionsstring[]An array of option strings supported by this setting.
canUseScratchpadMetadata__uiOrderstringReserved for Docusign.
localePolicy__effectiveDateFormatstringlocalePolicy__effectiveNameFormatstringlocalePolicy__effectiveTimeFormatstringmodifiedByMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
allowTransactionsMetadata__uiOrderstringReserved for Docusign.
anchorTagVersionedPlacementEnabledstringReserved for Docusign.
canManageTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canManageTemplatesMetadata__uiHintstringReserved for Docusign.
canManageTemplatesMetadata__uiTypestringReserved for Docusign.
canSendAPIRequestsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSendAPIRequestsMetadata__uiHintstringReserved for Docusign.
canSendAPIRequestsMetadata__uiTypestringReserved for Docusign.
enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__customSignDateFormatstringlocalePolicy__customSignTimeFormatstringtimezoneDSTMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSendOnBehalfOfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSendOnBehalfOfMetadata__uiHintstringReserved for Docusign.
allowSendOnBehalfOfMetadata__uiTypestringReserved for Docusign.
canManageTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
canManageTemplatesMetadata__uiOrderstringReserved for Docusign.
canSendAPIRequestsMetadata__optionsstring[]An array of option strings supported by this setting.
canSendAPIRequestsMetadata__uiOrderstringReserved for Docusign.
disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableOtherActionsMetadata__uiHintstringReserved for Docusign.
disableOtherActionsMetadata__uiTypestringReserved for Docusign.
localePolicy__effectiveCalendarTypestringlocalePolicy__effectiveCurrencyCodestringmodifiedDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
modifiedPageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
templateApplyNotifyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
templateApplyNotifyMetadata__uiHintstringReserved for Docusign.
templateApplyNotifyMetadata__uiTypestringReserved for Docusign.
timezoneMaskMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
timezoneSendingPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneSendingPrefMetadata__uiHintstringReserved for Docusign.
timezoneSendingPrefMetadata__uiTypestringReserved for Docusign.
timezoneSigningPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
timezoneSigningPrefMetadata__uiHintstringReserved for Docusign.
timezoneSigningPrefMetadata__uiTypestringReserved for Docusign.
vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEsealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEsealRecipientsMetadata__uiHintstringReserved for Docusign.
allowEsealRecipientsMetadata__uiTypestringReserved for Docusign.
allowSendOnBehalfOfMetadata__optionsstring[]An array of option strings supported by this setting.
allowSendOnBehalfOfMetadata__uiOrderstringReserved for Docusign.
apiAccountWideAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
apiAccountWideAccessMetadata__uiHintstringReserved for Docusign.
apiAccountWideAccessMetadata__uiTypestringReserved for Docusign.
canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canCreateTransactionMetadata__uiHintstringReserved for Docusign.
canCreateTransactionMetadata__uiTypestringReserved for Docusign.
canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
canManageDistributorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canManageDistributorMetadata__uiHintstringReserved for Docusign.
canManageDistributorMetadata__uiTypestringReserved for Docusign.
canUseSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canUseSmartContractsMetadata__uiHintstringReserved for Docusign.
canUseSmartContractsMetadata__uiTypestringReserved for Docusign.
disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
localePolicy__effectiveAddressFormatstringlocalePolicy__effectiveInitialFormatstringmanageClickwrapsModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
manageClickwrapsModeMetadata__uiHintstringReserved for Docusign.
manageClickwrapsModeMetadata__uiTypestringReserved for Docusign.
powerFormModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
templateApplyNotifyMetadata__optionsstring[]An array of option strings supported by this setting.
templateApplyNotifyMetadata__uiOrderstringReserved for Docusign.
templateAutoMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
templateAutoMatchingMetadata__uiHintstringReserved for Docusign.
templateAutoMatchingMetadata__uiTypestringReserved for Docusign.
timezoneSendingPrefMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneSendingPrefMetadata__uiOrderstringReserved for Docusign.
timezoneSigningPrefMetadata__optionsstring[]An array of option strings supported by this setting.
timezoneSigningPrefMetadata__uiOrderstringReserved for Docusign.
allowEsealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
allowEsealRecipientsMetadata__uiOrderstringReserved for Docusign.
apiAccountWideAccessMetadata__optionsstring[]An array of option strings supported by this setting.
apiAccountWideAccessMetadata__uiOrderstringReserved for Docusign.
apiCanExportACMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
canManageDistributorMetadata__optionsstring[]An array of option strings supported by this setting.
canManageDistributorMetadata__uiOrderstringReserved for Docusign.
canUseSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
canUseSmartContractsMetadata__uiOrderstringReserved for Docusign.
disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
manageClickwrapsModeMetadata__optionsstring[]An array of option strings supported by this setting.
manageClickwrapsModeMetadata__uiOrderstringReserved for Docusign.
signerEmailNotifications__faxReceivedstringReserved for Docusign.
supplementalDocumentIncludeInDownloadstringWhen **true,** this user gets supplemental documents when downloading documents.
templateAutoMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
templateAutoMatchingMetadata__uiOrderstringReserved for Docusign.
timezoneOffsetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canSendEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
canSignEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableTransactionPointMetadata__uiHintstringReserved for Docusign.
enableTransactionPointMetadata__uiTypestringReserved for Docusign.
localePolicy__timeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__timeZoneMetadata__uiHintstringReserved for Docusign.
localePolicy__timeZoneMetadata__uiTypestringReserved for Docusign.
templateActiveCreationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
templateActiveCreationMetadata__uiHintstringReserved for Docusign.
templateActiveCreationMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canViewUsersstringallowEnvelopeTransferToMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowEnvelopeTransferToMetadata__uiHintstringReserved for Docusign.
allowEnvelopeTransferToMetadata__uiTypestringReserved for Docusign.
canBulkUploadAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canBulkUploadAgreementsMetadata__uiHintstringReserved for Docusign.
canBulkUploadAgreementsMetadata__uiTypestringReserved for Docusign.
canChargeAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canLockEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canManageAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
canUseScratchpadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableKeyTermsSuggestionsByDocumentTypestringenableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
localePolicy__effectiveCustomDateFormatstringlocalePolicy__effectiveCustomTimeFormatstringlocalePolicy__timeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__timeZoneMetadata__uiOrderstringReserved for Docusign.
senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
templateActiveCreationMetadata__optionsstring[]An array of option strings supported by this setting.
templateActiveCreationMetadata__uiOrderstringReserved for Docusign.
allowEnvelopeTransferToMetadata__optionsstring[]An array of option strings supported by this setting.
allowEnvelopeTransferToMetadata__uiOrderstringReserved for Docusign.
allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canBulkUploadAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
canBulkUploadAgreementsMetadata__uiOrderstringReserved for Docusign.
canEditSharedAddressbookMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canEditSharedAddressbookMetadata__uiHintstringReserved for Docusign.
canEditSharedAddressbookMetadata__uiTypestringReserved for Docusign.
enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
localePolicy__dateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__dateFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__dateFormatMetadata__uiTypestringReserved for Docusign.
localePolicy__nameFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__nameFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__nameFormatMetadata__uiTypestringReserved for Docusign.
localePolicy__timeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__timeFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__timeFormatMetadata__uiTypestringReserved for Docusign.
senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
transactionPointUserNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
transactionPointUserNameMetadata__uiHintstringReserved for Docusign.
transactionPointUserNameMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageUsersstring**True** if the user can manage users.
canEditSharedAddressbookMetadata__optionsstring[]An array of option strings supported by this setting.
canEditSharedAddressbookMetadata__uiOrderstringReserved for Docusign.
canManageAgreementPartiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canManageAgreementPartiesMetadata__uiHintstringReserved for Docusign.
canManageAgreementPartiesMetadata__uiTypestringReserved for Docusign.
canManageTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canSendAPIRequestsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
localePolicy__cultureNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__cultureNameMetadata__uiHintstringReserved for Docusign.
localePolicy__cultureNameMetadata__uiTypestringReserved for Docusign.
localePolicy__dateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__dateFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__nameFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__nameFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__timeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__timeFormatMetadata__uiOrderstringReserved for Docusign.
senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
templatePageLevelMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
templatePageLevelMatchingMetadata__uiHintstringReserved for Docusign.
templatePageLevelMatchingMetadata__uiTypestringReserved for Docusign.
transactionPointUserNameMetadata__optionsstring[]An array of option strings supported by this setting.
transactionPointUserNameMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageAdminsstring**True** if the user can manage administrators.
accountManagementGranular__canManageStampsstringallowSendOnBehalfOfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
canManageAgreementPartiesMetadata__optionsstring[]An array of option strings supported by this setting.
canManageAgreementPartiesMetadata__uiOrderstringReserved for Docusign.
disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
localePolicy__calendarTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__calendarTypeMetadata__uiHintstringReserved for Docusign.
localePolicy__calendarTypeMetadata__uiTypestringReserved for Docusign.
localePolicy__cultureNameMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__cultureNameMetadata__uiOrderstringReserved for Docusign.
localePolicy__currencyCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__currencyCodeMetadata__uiHintstringReserved for Docusign.
localePolicy__currencyCodeMetadata__uiTypestringReserved for Docusign.
senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
templateApplyNotifyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
templatePageLevelMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
templatePageLevelMatchingMetadata__uiOrderstringReserved for Docusign.
timezoneSendingPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
timezoneSigningPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountAgreementsAccessTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountAgreementsAccessTypeMetadata__uiHintstringReserved for Docusign.
accountAgreementsAccessTypeMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageConnectstringaccountManagementGranular__canManageSharingstring**True** if the user can manage sharing.
allowEsealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
apiAccountWideAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canManageDistributorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canUseSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
localePolicy__addressFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__addressFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__addressFormatMetadata__uiTypestringReserved for Docusign.
localePolicy__calendarTypeMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__calendarTypeMetadata__uiOrderstringReserved for Docusign.
localePolicy__currencyCodeMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__currencyCodeMetadata__uiOrderstringReserved for Docusign.
localePolicy__initialFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__initialFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__initialFormatMetadata__uiTypestringReserved for Docusign.
manageClickwrapsModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
recipientViewedNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
recipientViewedNotificationMetadata__uiHintstringReserved for Docusign.
recipientViewedNotificationMetadata__uiTypestringReserved for Docusign.
signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
templateAutoMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
templateMatchingSensitivityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
templateMatchingSensitivityMetadata__uiHintstringReserved for Docusign.
templateMatchingSensitivityMetadata__uiTypestringReserved for Docusign.
transactionPointSiteNameURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
transactionPointSiteNameURLMetadata__uiHintstringReserved for Docusign.
transactionPointSiteNameURLMetadata__uiTypestringReserved for Docusign.
accountAgreementsAccessTypeMetadata__optionsstring[]An array of option strings supported by this setting.
accountAgreementsAccessTypeMetadata__uiOrderstringReserved for Docusign.
disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__addressFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__addressFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__initialFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__initialFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__signDateFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__signDateFormatMetadata__uiTypestringReserved for Docusign.
localePolicy__signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__signTimeFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__signTimeFormatMetadata__uiTypestringReserved for Docusign.
recipientViewedNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
recipientViewedNotificationMetadata__uiOrderstringReserved for Docusign.
senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
templateMatchingSensitivityMetadata__optionsstring[]An array of option strings supported by this setting.
templateMatchingSensitivityMetadata__uiOrderstringReserved for Docusign.
transactionPointSiteNameURLMetadata__optionsstring[]An array of option strings supported by this setting.
transactionPointSiteNameURLMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageReportingstring**True** if the user can manage reporting.
canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__effectiveCurrencyNegativeFormatstringlocalePolicy__effectiveCurrencyPositiveFormatstringlocalePolicy__signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__signDateFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__signTimeFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__timeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
templateActiveCreationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowEnvelopeTransferToMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canBulkUploadAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
allowRecipientLanguageSelectionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowRecipientLanguageSelectionMetadata__uiHintstringReserved for Docusign.
allowRecipientLanguageSelectionMetadata__uiTypestringReserved for Docusign.
canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
canEditSharedAddressbookMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__dateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__nameFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__timeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
transactionPointUserNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPowerFormsAdminToAccessAllPowerFormEnvelopestringWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
allowRecipientLanguageSelectionMetadata__optionsstring[]An array of option strings supported by this setting.
allowRecipientLanguageSelectionMetadata__uiOrderstringReserved for Docusign.
canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
canManageAgreementPartiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__cultureNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
templatePageLevelMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageSigningGroupsstring**True** if the user can manage signing groups.
allowAccessToAllAccountAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowAccessToAllAccountAgreementsMetadata__uiHintstringReserved for Docusign.
allowAccessToAllAccountAgreementsMetadata__uiTypestringReserved for Docusign.
allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__calendarTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__currencyCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
accountAgreementsAccessTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowAccessToAllAccountAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
allowAccessToAllAccountAgreementsMetadata__uiOrderstringReserved for Docusign.
localePolicy__addressFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__initialFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
recipientViewedNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
templateMatchingSensitivityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
transactionPointSiteNameURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageAccountSettingsstring**True** if the user can manage account settings.
accountManagementGranular__canManageJointAgreementsstringlocalePolicy__signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageEnvelopeTransferstringlocalePolicy__currencyNegativeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__currencyNegativeFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__currencyNegativeFormatMetadata__uiTypestringReserved for Docusign.
localePolicy__currencyPositiveFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
localePolicy__currencyPositiveFormatMetadata__uiHintstringReserved for Docusign.
localePolicy__currencyPositiveFormatMetadata__uiTypestringReserved for Docusign.
supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageDocumentRetentionstringaccountManagementGranular__canManageGroupsButNotUsersstringlocalePolicy__currencyNegativeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__currencyNegativeFormatMetadata__uiOrderstringReserved for Docusign.
localePolicy__currencyPositiveFormatMetadata__optionsstring[]An array of option strings supported by this setting.
localePolicy__currencyPositiveFormatMetadata__uiOrderstringReserved for Docusign.
allowRecipientLanguageSelectionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
allowAccessToAllAccountAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageUsersMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageUsersMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageAdminsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageAdminsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageAdminsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageStampsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageStampsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageUsersMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageUsersMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageAccountSecuritySettingsstring**True** if the user can manage account security settings.
accountManagementGranular__canManageAdminsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageAdminsMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageConnectMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageConnectMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageSharingMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageSharingMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageStampsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageStampsMetadata__uiOrderstringReserved for Docusign.
localePolicy__currencyNegativeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
localePolicy__currencyPositiveFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageConnectMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageConnectMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageSharingMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageSharingMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageReportingMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageReportingMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageReportingMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageReportingMetadata__uiOrderstringReserved for Docusign.
enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiHintstringReserved for Docusign.
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageAdminsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageSigningGroupsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageSigningGroupsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageSigningGroupsMetadata__uiOrderstringReserved for Docusign.
senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringsenderEmailNotifications__powerformResponsesLimitNotificationEmailstringaccountManagementGranular__canManageAccountSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageAccountSettingsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageAccountSettingsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageJointAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageJointAgreementsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageJointAgreementsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageAccountSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageAccountSettingsMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageEnvelopeTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageEnvelopeTransferMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageEnvelopeTransferMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageJointAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageJointAgreementsMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageDocumentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageDocumentRetentionMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageDocumentRetentionMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageEnvelopeTransferMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageEnvelopeTransferMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageGroupsButNotUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageGroupsButNotUsersMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageGroupsButNotUsersMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageDocumentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageDocumentRetentionMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageGroupsButNotUsersMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageGroupsButNotUsersMetadata__uiOrderstringReserved for Docusign.
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageAccountSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageJointAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageAccountSecuritySettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiHintstringReserved for Docusign.
accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiTypestringReserved for Docusign.
accountManagementGranular__canManageEnvelopeTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageAccountSecuritySettingsMetadata__optionsstring[]An array of option strings supported by this setting.
accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiOrderstringReserved for Docusign.
accountManagementGranular__canManageDocumentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageGroupsButNotUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
accountManagementGranular__canManageAccountSecuritySettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateuserauthorizationdatesDOCUSIGN_UPDATE_USER_AUTHORIZATION_DATESAcciónUpdates 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.
DOCUSIGN_UPDATE_USER_AUTHORIZATION_DATESAcciónUpdates 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.
Parámetros de entrada
userIdstringObligatorioThe 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.
endDatestringThe end date for the user authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`.
accountIdstringThe 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.
startDatestringThe start date for the user authorization. The default value is the current date and time.
authorizationIdstringObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update user information for specified userDOCUSIGN_UPDATE_USER_INFORMATION_FOR_SPECIFIED_USERAcciónThe 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.
DOCUSIGN_UPDATE_USER_INFORMATION_FOR_SPECIFIED_USERAcciónThe 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.
Parámetros de entrada
uristringA URI containing the user ID.
emailstringThe user"s email address.
titlestringThe title of the user.
userIdstringObligatorioThe 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.
companystringThe name of the user"s company.
isAdminstringWhen **true,** the user is an administrator.
jobTitlestringThe user"s job title.
lastNamestringThe user"s last name. Maximum Length: 50 characters.
passwordstringThe user"s encrypted password hash.
userNamestringThe name of the user.
userTypestringThe type of user, for example `CompanyUser`.
accountIdstringThe 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.
firstNamestringThe user"s first name. Maximum Length: 50 characters.
groupListobject[]A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user"s group, only the `groupId` is required.
lastLoginstringThis property has been deprecated.
subscribestringmiddleNamestringThe user"s middle name. Limit: 50 characters.
suffixNamestringThe suffix for the user"s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
countryCodestringThe two-letter code for the user"s country.
loginStatusstringBoolean value that indicates whether the user is currently logged in or not.
isNAREnabledstringWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
customSettingsobject[]The name/value pair information for the user custom setting.
createdDateTimestringThe UTC DateTime when the item was created.
hasRemoteNotarybooleanprofileImageUristringThe URL for retrieving the user"s profile image.
defaultAccountIdstringThe default account ID associated with the user.
homeAddress__faxstringA fax number associated with the address, if one is available.
initialsImageUristringThe URI for retrieving the image of the user"s initials.
isAlternateAdminstringWhen **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.
workAddress__faxstringA fax number associated with the address, if one is available.
homeAddress__citystringThe user"s city. Maximum length: 40 characters.
signatureImageUristringAn endpoint URI that you can use to retrieve the user"s signature image.
workAddress__citystringThe user"s city. Maximum length: 40 characters.
homeAddress__phonestringA phone number associated with the address.
passwordExpirationstringIf password expiration is enabled, the date-time when the user"s password expires.
workAddress__phonestringA phone number associated with the address.
allow_all_languagesstringAn 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.
permissionProfileIdstringThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
activationAccessCodestringAccess code provided to the user to activate the account.
enableConnectForUserstringBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
homeAddress__countrystringThe user"s country. Maximum length: 50 characters.
userSettings__localestringThe user"s locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
workAddress__countrystringThe user"s country. Maximum length: 50 characters.
connectConfigurationsobject[]Object representing the user"s custom Connect configuration.
errorDetails__messagestringA brief message describing the error condition.
homeAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
homeAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
homeAddress__zipPlus4stringpermissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
workAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
workAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
workAddress__zipPlus4stringuserSettings__bulkSendstringWhen **true,** this user can use the bulk send feature for the account.
userSettings__webFormsstringerrorDetails__errorCodestringThe code associated with the error condition.
homeAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userSettings__adminOnlystringReserved for Docusign.
userSettings__newSendUIstringReserved for Docusign.
workAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userSettings__modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
userSettings__enableDSProstringReserved for Docusign.
userSettings__timezoneDSTstringWhen true, daylight savings time is in effect for this user"s time zone.
userAddedToAccountDateTimestringThe date and time that the user was added to the account.
userSettings__modifiedDatestringThe date on which this user record was last modified.
userSettings__modifiedPagestringNote referencing the page that modified this user record.
userSettings__timezoneMaskstringThe custom DateTime format setting for this user.
userSettings__vaultingModestringIndicates the specified Vaulting mode: - `none` - `estored` - `electronic_original`
userProfileLastModifiedDatestringThe date and time that the user"s profile was last modified.
userSettings__powerFormModestringIndicates the Power Form mode setting for the user: - `none` - `admin` - `user`
homeAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
sendActivationOnInvalidLoginstringWhen **true,** specifies that an additional activation email be sent if user"s log on fails before the account is activated.
userSettings__apiCanExportACstringWhen **true,** this user can export authoritative copy for the account.
userSettings__enableVaultingstringWhen **true,** Vaulting is enabled for the account.
userSettings__timezoneOffsetstringThe 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`
workAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userSettings__canSendEnvelopestringWhen **true,** this user can send envelopes on the account.
userSettings__canSignEnvelopestringWhen **true,** this user can sign envelopes.
userSettings__expressSendOnlystringWhen **false,** this user can apply tabs to documents during the sending experience.
userSettings__sealIdentifiersobject[]Information about the seals associated with this user.
userSettings__allowAutoTaggingstringWhen **true,** the API returns suggested tabs for documents for this user.
userSettings__canChargeAccountstringReserved for Docusign.
userSettings__canLockEnvelopesstringReserved for Docusign.
userSettings__canManageAccountstringWhen **true,** this user is an administrator for the account.
userSettings__canUseScratchpadstringWhen **true,** this user can use a scratchpad to edit information.
userSettings__allowTransactionsstringuserSettings__canManageTemplatesstringWhen **true,** this user can manage templates for the account.
userSettings__canSendAPIRequestsstringWhen **true,** this user can send API requests on the account.
userSettings__allowSendOnBehalfOfstringWhen **true,** this user can send envelopes "on behalf of" other users through the API.
userSettings__disableOtherActionsstringWhen **true,** this user can access the **Other Actions** menu.
userSettings__templateApplyNotifystringWhen **true,** the system notifies this user before applying a matching template.
userSettings__timezoneSendingPrefstringReserved for Docusign.
userSettings__timezoneSigningPrefstringReserved for Docusign.
userSettings__allowEsealRecipientsstringWhen **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
userSettings__apiAccountWideAccessstringWhen **true,** indicates that this user can send envelope-specific API requests on the account.
userSettings__canCreateTransactionstringuserSettings__canDeleteTransactionstringuserSettings__canManageDistributorstringReserved for Docusign.
userSettings__canUseSmartContractsstringReserved for Docusign.
userSettings__manageClickwrapsModestringWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
userSettings__templateAutoMatchingstringWhen **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.
userSettings__disableDocumentUploadstringWhen **true,** this user is prohibited from uploading documents during sending.
userSettings__canSendEnvelopesViaSMSstringuserSettings__enableTransactionPointstringReserved for Docusign.
userSettings__localeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localeMetadata__uiHintstringReserved for Docusign.
userSettings__localeMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__timeZonestringSpecifies 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`
userSettings__templateActiveCreationstringWhen **true,** a new template is created each time the user sends an envelope.
userSettings__allowEnvelopeTransferTostringWhen **true,** this user can participate in envelope transfers on the account.
userSettings__canBulkUploadAgreementsstringuserSettings__enableSignerAttachmentsstringWhen **true,** this user can use the signing attachments feature.
userSettings__localeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localeMetadata__uiOrderstringReserved for Docusign.
userSettings__bulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__bulkSendMetadata__uiHintstringReserved for Docusign.
userSettings__bulkSendMetadata__uiTypestringReserved for Docusign.
userSettings__canEditSharedAddressbookstringWhen true, this user can edit the shared address book for the account.
userSettings__localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
userSettings__localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
userSettings__localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
userSettings__transactionPointUserNamestringReserved for Docusign.
userSettings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__webFormsMetadata__uiHintstringReserved for Docusign.
userSettings__webFormsMetadata__uiTypestringReserved for Docusign.
userSettings__adminOnlyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__adminOnlyMetadata__uiHintstringReserved for Docusign.
userSettings__adminOnlyMetadata__uiTypestringReserved for Docusign.
userSettings__bulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__bulkSendMetadata__uiOrderstringReserved for Docusign.
userSettings__canManageAgreementPartiesstringuserSettings__enableSequentialSigningUIstringWhen **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.
userSettings__enableSignOnPaperOverridestringWhen **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.
userSettings__localePolicy__allowRegionstringuserSettings__localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
userSettings__newSendUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__newSendUIMetadata__uiHintstringReserved for Docusign.
userSettings__newSendUIMetadata__uiTypestringReserved for Docusign.
userSettings__templatePageLevelMatchingstringWhen **true,** users see template matching functionality.
userSettings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__webFormsMetadata__uiOrderstringReserved for Docusign.
userSettings__adminOnlyMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__adminOnlyMetadata__uiOrderstringReserved for Docusign.
userSettings__allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
userSettings__allowedOrchestrationAccessstringuserSettings__enableSequentialSigningAPIstringWhen **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.
userSettings__localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
userSettings__localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
userSettings__modifiedByMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__modifiedByMetadata__uiHintstringReserved for Docusign.
userSettings__modifiedByMetadata__uiTypestringReserved for Docusign.
userSettings__newSendUIMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__newSendUIMetadata__uiOrderstringReserved for Docusign.
userSettings__accountAgreementsAccessTypestringuserSettings__enableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableDSProMetadata__uiHintstringReserved for Docusign.
userSettings__enableDSProMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
userSettings__localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
userSettings__modifiedByMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__modifiedByMetadata__uiOrderstringReserved for Docusign.
userSettings__recipientViewedNotificationstringWhen **true,** this user receives notifications when envelopes are viewed.
userSettings__templateMatchingSensitivitystringPercentage used when matching templates.
userSettings__timezoneDSTMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__timezoneDSTMetadata__uiHintstringReserved for Docusign.
userSettings__timezoneDSTMetadata__uiTypestringReserved for Docusign.
userSettings__transactionPointSiteNameURLstringReserved for Docusign.
userSettings__enableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableDSProMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__signDateFormatstringThe 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.
userSettings__localePolicy__signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
userSettings__modifiedDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__modifiedDateMetadata__uiHintstringReserved for Docusign.
userSettings__modifiedDateMetadata__uiTypestringReserved for Docusign.
userSettings__modifiedPageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__modifiedPageMetadata__uiHintstringReserved for Docusign.
userSettings__modifiedPageMetadata__uiTypestringReserved for Docusign.
userSettings__timezoneDSTMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__timezoneDSTMetadata__uiOrderstringReserved for Docusign.
userSettings__timezoneMaskMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__timezoneMaskMetadata__uiHintstringReserved for Docusign.
userSettings__timezoneMaskMetadata__uiTypestringReserved for Docusign.
userSettings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__vaultingModeMetadata__uiHintstringReserved for Docusign.
userSettings__vaultingModeMetadata__uiTypestringReserved for Docusign.
userSettings__localeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__modifiedDateMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__modifiedDateMetadata__uiOrderstringReserved for Docusign.
userSettings__modifiedPageMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__modifiedPageMetadata__uiOrderstringReserved for Docusign.
userSettings__powerFormModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__powerFormModeMetadata__uiHintstringReserved for Docusign.
userSettings__powerFormModeMetadata__uiTypestringReserved for Docusign.
userSettings__supplementalDocumentsMustReadstringWhen **true,** this user must both view and accept supplemental documents.
userSettings__supplementalDocumentsMustViewstringWhen **true,** this user must view supplemental documents.
userSettings__timezoneMaskMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__timezoneMaskMetadata__uiOrderstringReserved for Docusign.
userSettings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
userSettings__apiCanExportACMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__apiCanExportACMetadata__uiHintstringReserved for Docusign.
userSettings__apiCanExportACMetadata__uiTypestringReserved for Docusign.
userSettings__enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableVaultingMetadata__uiHintstringReserved for Docusign.
userSettings__enableVaultingMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__customDateFormatstringuserSettings__localePolicy__customTimeFormatstringuserSettings__powerFormModeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__powerFormModeMetadata__uiOrderstringReserved for Docusign.
userSettings__timezoneOffsetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__timezoneOffsetMetadata__uiHintstringReserved for Docusign.
userSettings__timezoneOffsetMetadata__uiTypestringReserved for Docusign.
userSettings__allowRecipientLanguageSelectionstringWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
userSettings__apiCanExportACMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__apiCanExportACMetadata__uiOrderstringReserved for Docusign.
userSettings__bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canDeleteDocumentsInTransactionstringuserSettings__canSendEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canSendEnvelopeMetadata__uiHintstringReserved for Docusign.
userSettings__canSendEnvelopeMetadata__uiTypestringReserved for Docusign.
userSettings__canSignEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canSignEnvelopeMetadata__uiHintstringReserved for Docusign.
userSettings__canSignEnvelopeMetadata__uiTypestringReserved for Docusign.
userSettings__enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableVaultingMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__effectiveTimeZonestringuserSettings__supplementalDocumentsMustAcceptstringWhen **true,** this user must accept supplemental documents.
userSettings__timezoneOffsetMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__timezoneOffsetMetadata__uiOrderstringReserved for Docusign.
userSettings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__adminOnlyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canChargeAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canChargeAccountMetadata__uiHintstringReserved for Docusign.
userSettings__canChargeAccountMetadata__uiTypestringReserved for Docusign.
userSettings__canLockEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canLockEnvelopesMetadata__uiHintstringReserved for Docusign.
userSettings__canLockEnvelopesMetadata__uiTypestringReserved for Docusign.
userSettings__canManageAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canManageAccountMetadata__uiHintstringReserved for Docusign.
userSettings__canManageAccountMetadata__uiTypestringReserved for Docusign.
userSettings__canSendEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canSendEnvelopeMetadata__uiOrderstringReserved for Docusign.
userSettings__canSignEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canSignEnvelopeMetadata__uiOrderstringReserved for Docusign.
userSettings__canUseScratchpadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canUseScratchpadMetadata__uiHintstringReserved for Docusign.
userSettings__canUseScratchpadMetadata__uiTypestringReserved for Docusign.
userSettings__newSendUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__selfSignedRecipientEmailDocumentstringSets 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.
forgottenPasswordInfo__forgottenPasswordAnswer1stringThe answer to the first forgotten password challenge question.
forgottenPasswordInfo__forgottenPasswordAnswer2stringThe answer to the second forgotten password challenge question.
forgottenPasswordInfo__forgottenPasswordAnswer3stringThe answer to the third forgotten password challenge question.
forgottenPasswordInfo__forgottenPasswordAnswer4stringThe answer to the fourth forgotten password challenge question.
userSettings__allowAccessToAllAccountAgreementsstringuserSettings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
userSettings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
userSettings__canChargeAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canChargeAccountMetadata__uiOrderstringReserved for Docusign.
userSettings__canLockEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canLockEnvelopesMetadata__uiOrderstringReserved for Docusign.
userSettings__canManageAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canManageAccountMetadata__uiOrderstringReserved for Docusign.
userSettings__canUseScratchpadMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canUseScratchpadMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__effectiveDateFormatstringuserSettings__localePolicy__effectiveNameFormatstringuserSettings__localePolicy__effectiveTimeFormatstringuserSettings__modifiedByMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
userSettings__anchorTagVersionedPlacementEnabledstringReserved for Docusign.
userSettings__canManageTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canManageTemplatesMetadata__uiHintstringReserved for Docusign.
userSettings__canManageTemplatesMetadata__uiTypestringReserved for Docusign.
userSettings__canSendAPIRequestsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canSendAPIRequestsMetadata__uiHintstringReserved for Docusign.
userSettings__canSendAPIRequestsMetadata__uiTypestringReserved for Docusign.
userSettings__enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__customSignDateFormatstringuserSettings__localePolicy__customSignTimeFormatstringuserSettings__timezoneDSTMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
forgottenPasswordInfo__forgottenPasswordQuestion1stringThe first challenge question presented to a user who has forgotten their password.
forgottenPasswordInfo__forgottenPasswordQuestion2stringThe second challenge question presented to a user who has forgotten their password.
forgottenPasswordInfo__forgottenPasswordQuestion3stringThe third challenge question presented to a user who has forgotten their password.
forgottenPasswordInfo__forgottenPasswordQuestion4stringThe fourth challenge question presented to a user who has forgotten their password.
userSettings__allowSendOnBehalfOfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowSendOnBehalfOfMetadata__uiHintstringReserved for Docusign.
userSettings__allowSendOnBehalfOfMetadata__uiTypestringReserved for Docusign.
userSettings__canManageTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canManageTemplatesMetadata__uiOrderstringReserved for Docusign.
userSettings__canSendAPIRequestsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canSendAPIRequestsMetadata__uiOrderstringReserved for Docusign.
userSettings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
userSettings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__effectiveCalendarTypestringuserSettings__localePolicy__effectiveCurrencyCodestringuserSettings__modifiedDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__modifiedPageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__templateApplyNotifyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__templateApplyNotifyMetadata__uiHintstringReserved for Docusign.
userSettings__templateApplyNotifyMetadata__uiTypestringReserved for Docusign.
userSettings__timezoneMaskMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__timezoneSendingPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__timezoneSendingPrefMetadata__uiHintstringReserved for Docusign.
userSettings__timezoneSendingPrefMetadata__uiTypestringReserved for Docusign.
userSettings__timezoneSigningPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__timezoneSigningPrefMetadata__uiHintstringReserved for Docusign.
userSettings__timezoneSigningPrefMetadata__uiTypestringReserved for Docusign.
userSettings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowEsealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowEsealRecipientsMetadata__uiHintstringReserved for Docusign.
userSettings__allowEsealRecipientsMetadata__uiTypestringReserved for Docusign.
userSettings__allowSendOnBehalfOfMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowSendOnBehalfOfMetadata__uiOrderstringReserved for Docusign.
userSettings__apiAccountWideAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__apiAccountWideAccessMetadata__uiHintstringReserved for Docusign.
userSettings__apiAccountWideAccessMetadata__uiTypestringReserved for Docusign.
userSettings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
userSettings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
userSettings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
userSettings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
userSettings__canManageDistributorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canManageDistributorMetadata__uiHintstringReserved for Docusign.
userSettings__canManageDistributorMetadata__uiTypestringReserved for Docusign.
userSettings__canUseSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canUseSmartContractsMetadata__uiHintstringReserved for Docusign.
userSettings__canUseSmartContractsMetadata__uiTypestringReserved for Docusign.
userSettings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
userSettings__localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
userSettings__localePolicy__effectiveAddressFormatstringuserSettings__localePolicy__effectiveInitialFormatstringuserSettings__manageClickwrapsModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__manageClickwrapsModeMetadata__uiHintstringReserved for Docusign.
userSettings__manageClickwrapsModeMetadata__uiTypestringReserved for Docusign.
userSettings__powerFormModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__templateApplyNotifyMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__templateApplyNotifyMetadata__uiOrderstringReserved for Docusign.
userSettings__templateAutoMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__templateAutoMatchingMetadata__uiHintstringReserved for Docusign.
userSettings__templateAutoMatchingMetadata__uiTypestringReserved for Docusign.
userSettings__timezoneSendingPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__timezoneSendingPrefMetadata__uiOrderstringReserved for Docusign.
userSettings__timezoneSigningPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__timezoneSigningPrefMetadata__uiOrderstringReserved for Docusign.
userSettings__allowEsealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowEsealRecipientsMetadata__uiOrderstringReserved for Docusign.
userSettings__apiAccountWideAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__apiAccountWideAccessMetadata__uiOrderstringReserved for Docusign.
userSettings__apiCanExportACMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
userSettings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
userSettings__canManageDistributorMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canManageDistributorMetadata__uiOrderstringReserved for Docusign.
userSettings__canUseSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canUseSmartContractsMetadata__uiOrderstringReserved for Docusign.
userSettings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
userSettings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
userSettings__enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__manageClickwrapsModeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__manageClickwrapsModeMetadata__uiOrderstringReserved for Docusign.
userSettings__signerEmailNotifications__faxReceivedstringReserved for Docusign.
userSettings__supplementalDocumentIncludeInDownloadstringWhen **true,** this user gets supplemental documents when downloading documents.
userSettings__templateAutoMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__templateAutoMatchingMetadata__uiOrderstringReserved for Docusign.
userSettings__timezoneOffsetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canSendEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
userSettings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
userSettings__canSignEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
userSettings__enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableTransactionPointMetadata__uiHintstringReserved for Docusign.
userSettings__enableTransactionPointMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__timeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__timeZoneMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__timeZoneMetadata__uiTypestringReserved for Docusign.
userSettings__templateActiveCreationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__templateActiveCreationMetadata__uiHintstringReserved for Docusign.
userSettings__templateActiveCreationMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canViewUsersstringuserSettings__allowEnvelopeTransferToMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowEnvelopeTransferToMetadata__uiHintstringReserved for Docusign.
userSettings__allowEnvelopeTransferToMetadata__uiTypestringReserved for Docusign.
userSettings__canBulkUploadAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canBulkUploadAgreementsMetadata__uiHintstringReserved for Docusign.
userSettings__canBulkUploadAgreementsMetadata__uiTypestringReserved for Docusign.
userSettings__canChargeAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canLockEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canManageAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
userSettings__canUseScratchpadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableKeyTermsSuggestionsByDocumentTypestringuserSettings__enableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
userSettings__enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
userSettings__enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__effectiveCustomDateFormatstringuserSettings__localePolicy__effectiveCustomTimeFormatstringuserSettings__localePolicy__timeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__timeZoneMetadata__uiOrderstringReserved for Docusign.
userSettings__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
userSettings__templateActiveCreationMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__templateActiveCreationMetadata__uiOrderstringReserved for Docusign.
userSettings__allowEnvelopeTransferToMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowEnvelopeTransferToMetadata__uiOrderstringReserved for Docusign.
userSettings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canBulkUploadAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canBulkUploadAgreementsMetadata__uiOrderstringReserved for Docusign.
userSettings__canEditSharedAddressbookMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canEditSharedAddressbookMetadata__uiHintstringReserved for Docusign.
userSettings__canEditSharedAddressbookMetadata__uiTypestringReserved for Docusign.
userSettings__enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__dateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__dateFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__dateFormatMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__nameFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__nameFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__nameFormatMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__timeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__timeFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__timeFormatMetadata__uiTypestringReserved for Docusign.
userSettings__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
userSettings__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userSettings__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
userSettings__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userSettings__transactionPointUserNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__transactionPointUserNameMetadata__uiHintstringReserved for Docusign.
userSettings__transactionPointUserNameMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageUsersstring**True** if the user can manage users.
userSettings__canEditSharedAddressbookMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canEditSharedAddressbookMetadata__uiOrderstringReserved for Docusign.
userSettings__canManageAgreementPartiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canManageAgreementPartiesMetadata__uiHintstringReserved for Docusign.
userSettings__canManageAgreementPartiesMetadata__uiTypestringReserved for Docusign.
userSettings__canManageTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canSendAPIRequestsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
userSettings__enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
userSettings__enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
userSettings__enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__cultureNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__cultureNameMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__cultureNameMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__dateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__dateFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__nameFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__nameFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__timeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__timeFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
userSettings__templatePageLevelMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__templatePageLevelMatchingMetadata__uiHintstringReserved for Docusign.
userSettings__templatePageLevelMatchingMetadata__uiTypestringReserved for Docusign.
userSettings__transactionPointUserNameMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__transactionPointUserNameMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageAdminsstring**True** if the user can manage administrators.
userSettings__accountManagementGranular__canManageStampsstringuserSettings__allowSendOnBehalfOfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
userSettings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
userSettings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
userSettings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
userSettings__canManageAgreementPartiesMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canManageAgreementPartiesMetadata__uiOrderstringReserved for Docusign.
userSettings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
userSettings__enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
userSettings__enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
userSettings__enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__calendarTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__calendarTypeMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__calendarTypeMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__cultureNameMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__cultureNameMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__currencyCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__currencyCodeMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__currencyCodeMetadata__uiTypestringReserved for Docusign.
userSettings__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userSettings__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
userSettings__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userSettings__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
userSettings__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
userSettings__templateApplyNotifyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__templatePageLevelMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__templatePageLevelMatchingMetadata__uiOrderstringReserved for Docusign.
userSettings__timezoneSendingPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__timezoneSigningPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountAgreementsAccessTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountAgreementsAccessTypeMetadata__uiHintstringReserved for Docusign.
userSettings__accountAgreementsAccessTypeMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageConnectstringuserSettings__accountManagementGranular__canManageSharingstring**True** if the user can manage sharing.
userSettings__allowEsealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
userSettings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
userSettings__apiAccountWideAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canManageDistributorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canUseSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__addressFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__addressFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__addressFormatMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__calendarTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__calendarTypeMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__currencyCodeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__currencyCodeMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__initialFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__initialFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__initialFormatMetadata__uiTypestringReserved for Docusign.
userSettings__manageClickwrapsModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__recipientViewedNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__recipientViewedNotificationMetadata__uiHintstringReserved for Docusign.
userSettings__recipientViewedNotificationMetadata__uiTypestringReserved for Docusign.
userSettings__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
userSettings__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
userSettings__templateAutoMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__templateMatchingSensitivityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__templateMatchingSensitivityMetadata__uiHintstringReserved for Docusign.
userSettings__templateMatchingSensitivityMetadata__uiTypestringReserved for Docusign.
userSettings__transactionPointSiteNameURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__transactionPointSiteNameURLMetadata__uiHintstringReserved for Docusign.
userSettings__transactionPointSiteNameURLMetadata__uiTypestringReserved for Docusign.
userSettings__accountAgreementsAccessTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountAgreementsAccessTypeMetadata__uiOrderstringReserved for Docusign.
userSettings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__addressFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__addressFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__initialFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__initialFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__signDateFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__signDateFormatMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__signTimeFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__signTimeFormatMetadata__uiTypestringReserved for Docusign.
userSettings__recipientViewedNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__recipientViewedNotificationMetadata__uiOrderstringReserved for Docusign.
userSettings__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userSettings__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userSettings__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
userSettings__templateMatchingSensitivityMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__templateMatchingSensitivityMetadata__uiOrderstringReserved for Docusign.
userSettings__transactionPointSiteNameURLMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__transactionPointSiteNameURLMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageReportingstring**True** if the user can manage reporting.
userSettings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__effectiveCurrencyNegativeFormatstringuserSettings__localePolicy__effectiveCurrencyPositiveFormatstringuserSettings__localePolicy__signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__signDateFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__signTimeFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__timeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
userSettings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
userSettings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
userSettings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
userSettings__templateActiveCreationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowEnvelopeTransferToMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canBulkUploadAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userSettings__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userSettings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
userSettings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
userSettings__allowRecipientLanguageSelectionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowRecipientLanguageSelectionMetadata__uiHintstringReserved for Docusign.
userSettings__allowRecipientLanguageSelectionMetadata__uiTypestringReserved for Docusign.
userSettings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
userSettings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
userSettings__canEditSharedAddressbookMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__dateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__nameFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__timeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
userSettings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
userSettings__transactionPointUserNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopestringWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
userSettings__allowRecipientLanguageSelectionMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowRecipientLanguageSelectionMetadata__uiOrderstringReserved for Docusign.
userSettings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
userSettings__canManageAgreementPartiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__cultureNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
userSettings__selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
userSettings__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
userSettings__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
userSettings__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
userSettings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
userSettings__templatePageLevelMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageSigningGroupsstring**True** if the user can manage signing groups.
userSettings__allowAccessToAllAccountAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowAccessToAllAccountAgreementsMetadata__uiHintstringReserved for Docusign.
userSettings__allowAccessToAllAccountAgreementsMetadata__uiTypestringReserved for Docusign.
userSettings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__calendarTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__currencyCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
userSettings__accountAgreementsAccessTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowAccessToAllAccountAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowAccessToAllAccountAgreementsMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__addressFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__initialFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__recipientViewedNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
userSettings__templateMatchingSensitivityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__transactionPointSiteNameURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageAccountSettingsstring**True** if the user can manage account settings.
userSettings__accountManagementGranular__canManageJointAgreementsstringuserSettings__localePolicy__signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageEnvelopeTransferstringuserSettings__localePolicy__currencyNegativeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__currencyNegativeFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__currencyNegativeFormatMetadata__uiTypestringReserved for Docusign.
userSettings__localePolicy__currencyPositiveFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__localePolicy__currencyPositiveFormatMetadata__uiHintstringReserved for Docusign.
userSettings__localePolicy__currencyPositiveFormatMetadata__uiTypestringReserved for Docusign.
userSettings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageDocumentRetentionstringuserSettings__accountManagementGranular__canManageGroupsButNotUsersstringuserSettings__localePolicy__currencyNegativeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__currencyNegativeFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__currencyPositiveFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__localePolicy__currencyPositiveFormatMetadata__uiOrderstringReserved for Docusign.
userSettings__allowRecipientLanguageSelectionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
userSettings__selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userSettings__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
userSettings__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userSettings__allowAccessToAllAccountAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageUsersMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageUsersMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageAdminsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageAdminsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageAdminsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageStampsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageStampsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageUsersMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageAccountSecuritySettingsstring**True** if the user can manage account security settings.
userSettings__accountManagementGranular__canManageAdminsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageAdminsMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageConnectMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageConnectMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageSharingMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageSharingMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageStampsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageStampsMetadata__uiOrderstringReserved for Docusign.
userSettings__localePolicy__currencyNegativeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__localePolicy__currencyPositiveFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageConnectMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageConnectMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageSharingMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageSharingMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageReportingMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageReportingMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageReportingMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageReportingMetadata__uiOrderstringReserved for Docusign.
userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiHintstringReserved for Docusign.
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageAdminsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiOrderstringReserved for Docusign.
userSettings__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringuserSettings__senderEmailNotifications__powerformResponsesLimitNotificationEmailstringuserSettings__accountManagementGranular__canManageAccountSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageAccountSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiOrderstringReserved for Docusign.
userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageAccountSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageJointAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiHintstringReserved for Docusign.
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiTypestringReserved for Docusign.
userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiOrderstringReserved for Docusign.
userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateusernotaryinformationDOCUSIGN_UPDATE_USER_NOTARY_INFORMATIONAcciónThe updateusernotaryinformation endpoint modifies a notary's profile and settings in docusign. it manages account details, preferences, and operational parameters. use this to update a notary's visibility, capabilities, or personal settings. it's crucial for maintaining accurate records and ensuring compliance with regulations. note that all required fields must be provided, even for partial updates.
DOCUSIGN_UPDATE_USER_NOTARY_INFORMATIONAcciónThe updateusernotaryinformation endpoint modifies a notary's profile and settings in docusign. it manages account details, preferences, and operational parameters. use this to update a notary's visibility, capabilities, or personal settings. it's crucial for maintaining accurate records and ensuring compliance with regulations. note that all required fields must be provided, even for partial updates.
Parámetros de entrada
enabledstringThe date the this object was created.
searchablestringWhen **true,** this notary is searchable.
createdDatestringThe creation date of the account in UTC timedate format.
userInfo__uristringA URI containing the user ID.
userInfo__emailstringThe user"s email address.
userInfo__titlestringThe title of the user.
userInfo__userIdstringThe 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.
userInfo__companystringThe name of the user"s company.
userInfo__isAdminstringWhen **true,** the user is an administrator.
userInfo__jobTitlestringThe user"s job title.
userInfo__lastNamestringThe user"s last name. Maximum Length: 50 characters.
userInfo__passwordstringThe user"s encrypted password hash.
userInfo__userNamestringThe name of the user.
userInfo__userTypestringThe type of user, for example `CompanyUser`.
userInfo__firstNamestringThe user"s first name. Maximum Length: 50 characters.
userInfo__groupListobject[]A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user"s group, only the `groupId` is required.
userInfo__lastLoginstringThis property has been deprecated.
userInfo__subscribestringuserInfo__middleNamestringThe user"s middle name. Limit: 50 characters.
userInfo__suffixNamestringThe suffix for the user"s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
userInfo__userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
userInfo__countryCodestringThe two-letter code for the user"s country.
userInfo__loginStatusstringBoolean value that indicates whether the user is currently logged in or not.
userInfo__isNAREnabledstringWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
userInfo__customSettingsobject[]The name/value pair information for the user custom setting.
userInfo__createdDateTimestringThe UTC DateTime when the item was created.
userInfo__hasRemoteNotarybooleanuserInfo__profileImageUristringThe URL for retrieving the user"s profile image.
userInfo__defaultAccountIdstringThe default account ID associated with the user.
userInfo__homeAddress__faxstringA fax number associated with the address, if one is available.
userInfo__initialsImageUristringThe URI for retrieving the image of the user"s initials.
userInfo__isAlternateAdminstringWhen **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.
userInfo__workAddress__faxstringA fax number associated with the address, if one is available.
userInfo__homeAddress__citystringThe user"s city. Maximum length: 40 characters.
userInfo__signatureImageUristringAn endpoint URI that you can use to retrieve the user"s signature image.
userInfo__workAddress__citystringThe user"s city. Maximum length: 40 characters.
userInfo__homeAddress__phonestringA phone number associated with the address.
userInfo__passwordExpirationstringIf password expiration is enabled, the date-time when the user"s password expires.
userInfo__workAddress__phonestringA phone number associated with the address.
userInfo__permissionProfileIdstringThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
userInfo__sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
userInfo__activationAccessCodestringAccess code provided to the user to activate the account.
userInfo__enableConnectForUserstringBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
userInfo__homeAddress__countrystringThe user"s country. Maximum length: 50 characters.
userInfo__userSettings__localestringThe user"s locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
userInfo__workAddress__countrystringThe user"s country. Maximum length: 50 characters.
userInfo__connectConfigurationsobject[]Object representing the user"s custom Connect configuration.
userInfo__errorDetails__messagestringA brief message describing the error condition.
userInfo__homeAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userInfo__homeAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userInfo__homeAddress__zipPlus4stringuserInfo__permissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
userInfo__workAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userInfo__workAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userInfo__workAddress__zipPlus4stringuserInfo__userSettings__bulkSendstringWhen **true,** this user can use the bulk send feature for the account.
userInfo__userSettings__webFormsstringuserInfo__errorDetails__errorCodestringThe code associated with the error condition.
userInfo__homeAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userInfo__userSettings__adminOnlystringReserved for Docusign.
userInfo__userSettings__newSendUIstringReserved for Docusign.
userInfo__workAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userInfo__userSettings__modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
userInfo__userSettings__enableDSProstringReserved for Docusign.
userInfo__userSettings__timezoneDSTstringWhen true, daylight savings time is in effect for this user"s time zone.
userInfo__userAddedToAccountDateTimestringThe date and time that the user was added to the account.
userInfo__userSettings__modifiedDatestringThe date on which this user record was last modified.
userInfo__userSettings__modifiedPagestringNote referencing the page that modified this user record.
userInfo__userSettings__timezoneMaskstringThe custom DateTime format setting for this user.
userInfo__userSettings__vaultingModestringIndicates the specified Vaulting mode: - `none` - `estored` - `electronic_original`
userInfo__userProfileLastModifiedDatestringThe date and time that the user"s profile was last modified.
userInfo__userSettings__powerFormModestringIndicates the Power Form mode setting for the user: - `none` - `admin` - `user`
userInfo__homeAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userInfo__sendActivationOnInvalidLoginstringWhen **true,** specifies that an additional activation email be sent if user"s log on fails before the account is activated.
userInfo__userSettings__apiCanExportACstringWhen **true,** this user can export authoritative copy for the account.
userInfo__userSettings__enableVaultingstringWhen **true,** Vaulting is enabled for the account.
userInfo__userSettings__timezoneOffsetstringThe 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`
userInfo__workAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userInfo__userSettings__canSendEnvelopestringWhen **true,** this user can send envelopes on the account.
userInfo__userSettings__canSignEnvelopestringWhen **true,** this user can sign envelopes.
userInfo__userSettings__expressSendOnlystringWhen **false,** this user can apply tabs to documents during the sending experience.
userInfo__userSettings__sealIdentifiersobject[]Information about the seals associated with this user.
userInfo__userSettings__allowAutoTaggingstringWhen **true,** the API returns suggested tabs for documents for this user.
userInfo__userSettings__canChargeAccountstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesstringReserved for Docusign.
userInfo__userSettings__canManageAccountstringWhen **true,** this user is an administrator for the account.
userInfo__userSettings__canUseScratchpadstringWhen **true,** this user can use a scratchpad to edit information.
userInfo__userSettings__allowTransactionsstringuserInfo__userSettings__canManageTemplatesstringWhen **true,** this user can manage templates for the account.
userInfo__userSettings__canSendAPIRequestsstringWhen **true,** this user can send API requests on the account.
userInfo__userSettings__allowSendOnBehalfOfstringWhen **true,** this user can send envelopes "on behalf of" other users through the API.
userInfo__userSettings__disableOtherActionsstringWhen **true,** this user can access the **Other Actions** menu.
userInfo__userSettings__templateApplyNotifystringWhen **true,** the system notifies this user before applying a matching template.
userInfo__userSettings__timezoneSendingPrefstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsstringWhen **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
userInfo__userSettings__apiAccountWideAccessstringWhen **true,** indicates that this user can send envelope-specific API requests on the account.
userInfo__userSettings__canCreateTransactionstringuserInfo__userSettings__canDeleteTransactionstringuserInfo__userSettings__canManageDistributorstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsstringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModestringWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
userInfo__userSettings__templateAutoMatchingstringWhen **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.
userInfo__userSettings__disableDocumentUploadstringWhen **true,** this user is prohibited from uploading documents during sending.
userInfo__userSettings__canSendEnvelopesViaSMSstringuserInfo__userSettings__enableTransactionPointstringReserved for Docusign.
userInfo__userSettings__localeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZonestringSpecifies 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`
userInfo__userSettings__templateActiveCreationstringWhen **true,** a new template is created each time the user sends an envelope.
userInfo__userSettings__allowEnvelopeTransferTostringWhen **true,** this user can participate in envelope transfers on the account.
userInfo__userSettings__canBulkUploadAgreementsstringuserInfo__userSettings__enableSignerAttachmentsstringWhen **true,** this user can use the signing attachments feature.
userInfo__userSettings__localeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__bulkSendMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookstringWhen true, this user can edit the shared address book for the account.
userInfo__userSettings__localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
userInfo__userSettings__localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
userInfo__userSettings__localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
userInfo__userSettings__transactionPointUserNamestringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__webFormsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__adminOnlyMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__bulkSendMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesstringuserInfo__userSettings__enableSequentialSigningUIstringWhen **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.
userInfo__userSettings__enableSignOnPaperOverridestringWhen **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.
userInfo__userSettings__localePolicy__allowRegionstringuserInfo__userSettings__localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
userInfo__userSettings__newSendUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__newSendUIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingstringWhen **true,** users see template matching functionality.
userInfo__userSettings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__webFormsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__adminOnlyMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__adminOnlyMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
userInfo__userSettings__allowedOrchestrationAccessstringuserInfo__userSettings__enableSequentialSigningAPIstringWhen **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.
userInfo__userSettings__localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
userInfo__userSettings__localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
userInfo__userSettings__modifiedByMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedByMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedByMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__newSendUIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypestringuserInfo__userSettings__enableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableDSProMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
userInfo__userSettings__localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
userInfo__userSettings__modifiedByMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedByMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationstringWhen **true,** this user receives notifications when envelopes are viewed.
userInfo__userSettings__templateMatchingSensitivitystringPercentage used when matching templates.
userInfo__userSettings__timezoneDSTMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneDSTMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneDSTMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLstringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableDSProMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatstringThe 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.
userInfo__userSettings__localePolicy__signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
userInfo__userSettings__modifiedDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedDateMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedDateMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__modifiedPageMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneDSTMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneDSTMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneMaskMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__vaultingModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__modifiedDateMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedDateMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__modifiedPageMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__modifiedPageMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__powerFormModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadstringWhen **true,** this user must both view and accept supplemental documents.
userInfo__userSettings__supplementalDocumentsMustViewstringWhen **true,** this user must view supplemental documents.
userInfo__userSettings__timezoneMaskMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneMaskMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__apiCanExportACMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableVaultingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__customDateFormatstringuserInfo__userSettings__localePolicy__customTimeFormatstringuserInfo__userSettings__powerFormModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__powerFormModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneOffsetMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionstringWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
userInfo__userSettings__apiCanExportACMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__apiCanExportACMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteDocumentsInTransactionstringuserInfo__userSettings__canSendEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSignEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableVaultingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveTimeZonestringuserInfo__userSettings__supplementalDocumentsMustAcceptstringWhen **true,** this user must accept supplemental documents.
userInfo__userSettings__timezoneOffsetMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneOffsetMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__adminOnlyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canChargeAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canChargeAccountMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canLockEnvelopesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageAccountMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSendEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSignEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canUseScratchpadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__newSendUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentstringSets 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.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer1stringThe answer to the first forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer2stringThe answer to the second forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer3stringThe answer to the third forgotten password challenge question.
userInfo__forgottenPasswordInfo__forgottenPasswordAnswer4stringThe answer to the fourth forgotten password challenge question.
userInfo__userSettings__allowAccessToAllAccountAgreementsstringuserInfo__userSettings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canChargeAccountMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canLockEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canLockEnvelopesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageAccountMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canUseScratchpadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveDateFormatstringuserInfo__userSettings__localePolicy__effectiveNameFormatstringuserInfo__userSettings__localePolicy__effectiveTimeFormatstringuserInfo__userSettings__modifiedByMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__anchorTagVersionedPlacementEnabledstringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageTemplatesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendAPIRequestsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__customSignDateFormatstringuserInfo__userSettings__localePolicy__customSignTimeFormatstringuserInfo__userSettings__timezoneDSTMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion1stringThe first challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion2stringThe second challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion3stringThe third challenge question presented to a user who has forgotten their password.
userInfo__forgottenPasswordInfo__forgottenPasswordQuestion4stringThe fourth challenge question presented to a user who has forgotten their password.
userInfo__userSettings__allowSendOnBehalfOfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageTemplatesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canSendAPIRequestsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendAPIRequestsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveCalendarTypestringuserInfo__userSettings__localePolicy__effectiveCurrencyCodestringuserInfo__userSettings__modifiedDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__modifiedPageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateApplyNotifyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateApplyNotifyMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateApplyNotifyMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneMaskMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__timezoneSendingPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneSendingPrefMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__timezoneSigningPrefMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowEsealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowEsealRecipientsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowSendOnBehalfOfMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowSendOnBehalfOfMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__apiAccountWideAccessMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageDistributorMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canUseSmartContractsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
userInfo__userSettings__localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
userInfo__userSettings__localePolicy__effectiveAddressFormatstringuserInfo__userSettings__localePolicy__effectiveInitialFormatstringuserInfo__userSettings__manageClickwrapsModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__manageClickwrapsModeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__powerFormModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateApplyNotifyMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateApplyNotifyMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__templateAutoMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateAutoMatchingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateAutoMatchingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneSendingPrefMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneSigningPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__timezoneSigningPrefMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowEsealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowEsealRecipientsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__apiAccountWideAccessMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiCanExportACMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageDistributorMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageDistributorMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canUseSmartContractsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__manageClickwrapsModeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__manageClickwrapsModeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__signerEmailNotifications__faxReceivedstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentIncludeInDownloadstringWhen **true,** this user gets supplemental documents when downloading documents.
userInfo__userSettings__templateAutoMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateAutoMatchingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneOffsetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canSignEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableTransactionPointMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__timeZoneMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateActiveCreationMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canViewUsersstringuserInfo__userSettings__allowEnvelopeTransferToMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canBulkUploadAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canChargeAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canLockEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canManageAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canUseScratchpadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypestringuserInfo__userSettings__enableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__effectiveCustomDateFormatstringuserInfo__userSettings__localePolicy__effectiveCustomTimeFormatstringuserInfo__userSettings__localePolicy__timeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__timeZoneMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
userInfo__userSettings__templateActiveCreationMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateActiveCreationMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowEnvelopeTransferToMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowEnvelopeTransferToMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canBulkUploadAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canBulkUploadAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canEditSharedAddressbookMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__dateFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__nameFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__timeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
userInfo__userSettings__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userInfo__userSettings__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
userInfo__userSettings__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userInfo__userSettings__transactionPointUserNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__transactionPointUserNameMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersstring**True** if the user can manage users.
userInfo__userSettings__canEditSharedAddressbookMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canEditSharedAddressbookMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canManageAgreementPartiesMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canSendAPIRequestsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__cultureNameMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__dateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__dateFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__nameFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__nameFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__timeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
userInfo__userSettings__templatePageLevelMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templatePageLevelMatchingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__transactionPointUserNameMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsstring**True** if the user can manage administrators.
userInfo__userSettings__accountManagementGranular__canManageStampsstringuserInfo__userSettings__allowSendOnBehalfOfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canManageAgreementPartiesMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__cultureNameMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__cultureNameMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userInfo__userSettings__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
userInfo__userSettings__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userInfo__userSettings__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
userInfo__userSettings__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
userInfo__userSettings__templateApplyNotifyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templatePageLevelMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templatePageLevelMatchingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__timezoneSendingPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__timezoneSigningPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountAgreementsAccessTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectstringuserInfo__userSettings__accountManagementGranular__canManageSharingstring**True** if the user can manage sharing.
userInfo__userSettings__allowEsealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__apiAccountWideAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canManageDistributorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canUseSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__addressFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__calendarTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__calendarTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyCodeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyCodeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__initialFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__manageClickwrapsModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__recipientViewedNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__recipientViewedNotificationMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
userInfo__userSettings__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
userInfo__userSettings__templateAutoMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__templateMatchingSensitivityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__templateMatchingSensitivityMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__templateMatchingSensitivityMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__addressFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__addressFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__initialFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__initialFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__recipientViewedNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__recipientViewedNotificationMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userInfo__userSettings__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userInfo__userSettings__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
userInfo__userSettings__templateMatchingSensitivityMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__templateMatchingSensitivityMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__transactionPointSiteNameURLMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__transactionPointSiteNameURLMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingstring**True** if the user can manage reporting.
userInfo__userSettings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__effectiveCurrencyNegativeFormatstringuserInfo__userSettings__localePolicy__effectiveCurrencyPositiveFormatstringuserInfo__userSettings__localePolicy__signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__signDateFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__signTimeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__timeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__templateActiveCreationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowEnvelopeTransferToMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canBulkUploadAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userInfo__userSettings__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__canEditSharedAddressbookMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__dateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__nameFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__timeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__transactionPointUserNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopestringWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__canManageAgreementPartiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__cultureNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
userInfo__userSettings__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
userInfo__userSettings__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__templatePageLevelMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsstring**True** if the user can manage signing groups.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__calendarTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__currencyCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountAgreementsAccessTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__addressFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__initialFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__recipientViewedNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
userInfo__userSettings__templateMatchingSensitivityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__transactionPointSiteNameURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsstring**True** if the user can manage account settings.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsstringuserInfo__userSettings__localePolicy__signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferstringuserInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionstringuserInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersstringuserInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowRecipientLanguageSelectionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userInfo__userSettings__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
userInfo__userSettings__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userInfo__userSettings__allowAccessToAllAccountAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsstring**True** if the user can manage account security settings.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__localePolicy__currencyNegativeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__localePolicy__currencyPositiveFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAdminsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringuserInfo__userSettings__senderEmailNotifications__powerformResponsesLimitNotificationEmailstringuserInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiHintstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiTypestringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiOrderstringReserved for Docusign.
userInfo__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userInfo__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update user profile imageDOCUSIGN_UPDATE_USER_PROFILE_IMAGEAcciónUpdates a user's profile image in docusign by uploading a new image file. this endpoint allows users to personalize their docusign account by changing their profile picture. the tool supports various image formats (gif, png, jpeg, and bmp) and has specific size and dimension recommendations for optimal display. it's important to note that users can only update their own profile image, and the actual method of sending the image file is not specified in the schema.
DOCUSIGN_UPDATE_USER_PROFILE_IMAGEAcciónUpdates a user's profile image in docusign by uploading a new image file. this endpoint allows users to personalize their docusign account by changing their profile picture. the tool supports various image formats (gif, png, jpeg, and bmp) and has specific size and dimension recommendations for optimal display. it's important to note that users can only update their own profile image, and the actual method of sending the image file is not specified in the schema.
Parámetros de entrada
userIdstringObligatorioThe unique identifier of the user whose profile image is being updated. 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 update their own information, even those with Admin rights cannot access or modify another user"s settings.
accountIdstringThe 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 in identifying the specific account for which the user profile image is being updated.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateuserprofileinformationDOCUSIGN_UPDATE_USER_PROFILE_INFORMATIONAcciónUpdates a user's profile in docusign, including personal details, privacy settings, and user id card information. it allows modifications to name, address, locale preferences, and various account settings. users can only update their own information. some settings may require admin rights to modify. use for keeping user profiles current and adjusting preferences.
DOCUSIGN_UPDATE_USER_PROFILE_INFORMATIONAcciónUpdates a user's profile in docusign, including personal details, privacy settings, and user id card information. it allows modifications to name, address, locale preferences, and various account settings. users can only update their own information. some settings may require admin rights to modify. use for keeping user profiles current and adjusting preferences.
Parámetros de entrada
titlestringThe title of the user.
userIdstringObligatorioThe 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.
accountIdstringThe 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.
companyNamestringThe name of the user"s company.
address__faxstringA fax number associated with the address, if one is available.
address__citystringThe user"s city. Maximum length: 40 characters.
address__phonestringA phone number associated with the address.
displayProfilestringWhen **true,** the user"s ID card can be viewed from signed documents and envelope history.
profileImageUristringThe URL for retrieving the user"s profile image.
address__countrystringThe user"s country. Maximum length: 50 characters.
userDetails__uristringA URI containing the user ID.
address__address1stringThe first line of the user"s address. Maximum length: 100 characters.
address__address2stringThe second line of the user"s address. Maximum length: 100 characters.
address__zipPlus4stringuserDetails__emailstringThe user"s email address.
userDetails__titlestringThe title of the user.
address__postalCodestringThe user"s postal code. Maximum length: 20 characters.
displayPersonalInfostringWhen **true,** the user"s address and phone number display on the ID card.
displayUsageHistorystringWhen **true,** the user"s usage information displays on the ID card.
userDetails__userIdstringThe 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.
userDetails__companystringThe name of the user"s company.
userDetails__isAdminstringWhen **true,** the user is an administrator.
authenticationMethodsobject[]Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
userDetails__jobTitlestringThe user"s job title.
userDetails__lastNamestringThe user"s last name. Maximum Length: 50 characters.
userDetails__passwordstringThe user"s encrypted password hash.
userDetails__userNamestringThe name of the user.
userDetails__userTypestringThe type of user, for example `CompanyUser`.
userDetails__firstNamestringThe user"s first name. Maximum Length: 50 characters.
userDetails__groupListobject[]A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user"s group, only the `groupId` is required.
userDetails__lastLoginstringThis property has been deprecated.
userDetails__subscribestringdisplayOrganizationInfostringWhen **true,** the user"s company and title information display on the ID card.
usageHistory__sentCountstringThe number of envelopes the user has sent.
userDetails__middleNamestringThe user"s middle name. Limit: 50 characters.
userDetails__suffixNamestringThe suffix for the user"s name, such as Jr, IV, PhD, etc. Limit: 50 characters.
userDetails__userStatusstringStatus of the user"s account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled`
address__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userDetails__countryCodestringThe two-letter code for the user"s country.
userDetails__loginStatusstringBoolean value that indicates whether the user is currently logged in or not.
usageHistory__signedCountstringThe number of envelopes the user has signed.
userDetails__isNAREnabledstringWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
userDetails__customSettingsobject[]The name/value pair information for the user custom setting.
userProfileLastModifiedDatestringThe date and time that the user"s profile was last modified.
userDetails__createdDateTimestringThe UTC DateTime when the item was created.
userDetails__hasRemoteNotarybooleanuserDetails__profileImageUristringThe URL for retrieving the user"s profile image.
userDetails__defaultAccountIdstringThe default account ID associated with the user.
userDetails__homeAddress__faxstringA fax number associated with the address, if one is available.
userDetails__initialsImageUristringThe URI for retrieving the image of the user"s initials.
userDetails__isAlternateAdminstringWhen **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.
userDetails__workAddress__faxstringA fax number associated with the address, if one is available.
usageHistory__lastSentDateTimestringThe date and time the user last sent an envelope.
userDetails__homeAddress__citystringThe user"s city. Maximum length: 40 characters.
userDetails__signatureImageUristringAn endpoint URI that you can use to retrieve the user"s signature image.
userDetails__workAddress__citystringThe user"s city. Maximum length: 40 characters.
userDetails__homeAddress__phonestringA phone number associated with the address.
userDetails__passwordExpirationstringIf password expiration is enabled, the date-time when the user"s password expires.
userDetails__workAddress__phonestringA phone number associated with the address.
usageHistory__lastSignedDateTimestringThe date and time the user last signed an envelope.
userDetails__permissionProfileIdstringThe ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
userDetails__sendActivationEmailstringThis 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](/docs/admin-api/how-to/create-active-user/).
userDetails__activationAccessCodestringAccess code provided to the user to activate the account.
userDetails__enableConnectForUserstringBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
userDetails__homeAddress__countrystringThe user"s country. Maximum length: 50 characters.
userDetails__userSettings__localestringThe user"s locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
userDetails__workAddress__countrystringThe user"s country. Maximum length: 50 characters.
userDetails__connectConfigurationsobject[]Object representing the user"s custom Connect configuration.
userDetails__errorDetails__messagestringA brief message describing the error condition.
userDetails__homeAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userDetails__homeAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userDetails__homeAddress__zipPlus4stringuserDetails__permissionProfileNamestringThe name of the account permission profile. Example: `Account Administrator`
userDetails__workAddress__address1stringThe first line of the user"s address. Maximum length: 100 characters.
userDetails__workAddress__address2stringThe second line of the user"s address. Maximum length: 100 characters.
userDetails__workAddress__zipPlus4stringuserDetails__userSettings__bulkSendstringWhen **true,** this user can use the bulk send feature for the account.
userDetails__userSettings__webFormsstringuserDetails__errorDetails__errorCodestringThe code associated with the error condition.
userDetails__homeAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userDetails__userSettings__adminOnlystringReserved for Docusign.
userDetails__userSettings__newSendUIstringReserved for Docusign.
userDetails__workAddress__postalCodestringThe user"s postal code. Maximum length: 20 characters.
userDetails__userSettings__modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
userDetails__userSettings__enableDSProstringReserved for Docusign.
userDetails__userSettings__timezoneDSTstringWhen true, daylight savings time is in effect for this user"s time zone.
userDetails__userAddedToAccountDateTimestringThe date and time that the user was added to the account.
userDetails__userSettings__modifiedDatestringThe date on which this user record was last modified.
userDetails__userSettings__modifiedPagestringNote referencing the page that modified this user record.
userDetails__userSettings__timezoneMaskstringThe custom DateTime format setting for this user.
userDetails__userSettings__vaultingModestringIndicates the specified Vaulting mode: - `none` - `estored` - `electronic_original`
userDetails__userProfileLastModifiedDatestringThe date and time that the user"s profile was last modified.
userDetails__userSettings__powerFormModestringIndicates the Power Form mode setting for the user: - `none` - `admin` - `user`
userDetails__homeAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userDetails__sendActivationOnInvalidLoginstringWhen **true,** specifies that an additional activation email be sent if user"s log on fails before the account is activated.
userDetails__userSettings__apiCanExportACstringWhen **true,** this user can export authoritative copy for the account.
userDetails__userSettings__enableVaultingstringWhen **true,** Vaulting is enabled for the account.
userDetails__userSettings__timezoneOffsetstringThe 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`
userDetails__workAddress__stateOrProvincestringThe user"s state or province. Maximum length: 40 characters.
userDetails__userSettings__canSendEnvelopestringWhen **true,** this user can send envelopes on the account.
userDetails__userSettings__canSignEnvelopestringWhen **true,** this user can sign envelopes.
userDetails__userSettings__expressSendOnlystringWhen **false,** this user can apply tabs to documents during the sending experience.
userDetails__userSettings__sealIdentifiersobject[]Information about the seals associated with this user.
userDetails__userSettings__allowAutoTaggingstringWhen **true,** the API returns suggested tabs for documents for this user.
userDetails__userSettings__canChargeAccountstringReserved for Docusign.
userDetails__userSettings__canLockEnvelopesstringReserved for Docusign.
userDetails__userSettings__canManageAccountstringWhen **true,** this user is an administrator for the account.
userDetails__userSettings__canUseScratchpadstringWhen **true,** this user can use a scratchpad to edit information.
userDetails__userSettings__allowTransactionsstringuserDetails__userSettings__canManageTemplatesstringWhen **true,** this user can manage templates for the account.
userDetails__userSettings__canSendAPIRequestsstringWhen **true,** this user can send API requests on the account.
userDetails__userSettings__allowSendOnBehalfOfstringWhen **true,** this user can send envelopes "on behalf of" other users through the API.
userDetails__userSettings__disableOtherActionsstringWhen **true,** this user can access the **Other Actions** menu.
userDetails__userSettings__templateApplyNotifystringWhen **true,** the system notifies this user before applying a matching template.
userDetails__userSettings__timezoneSendingPrefstringReserved for Docusign.
userDetails__userSettings__timezoneSigningPrefstringReserved for Docusign.
userDetails__userSettings__allowEsealRecipientsstringWhen **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
userDetails__userSettings__apiAccountWideAccessstringWhen **true,** indicates that this user can send envelope-specific API requests on the account.
userDetails__userSettings__canCreateTransactionstringuserDetails__userSettings__canDeleteTransactionstringuserDetails__userSettings__canManageDistributorstringReserved for Docusign.
userDetails__userSettings__canUseSmartContractsstringReserved for Docusign.
userDetails__userSettings__manageClickwrapsModestringWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
userDetails__userSettings__templateAutoMatchingstringWhen **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.
userDetails__userSettings__disableDocumentUploadstringWhen **true,** this user is prohibited from uploading documents during sending.
userDetails__userSettings__canSendEnvelopesViaSMSstringuserDetails__userSettings__enableTransactionPointstringReserved for Docusign.
userDetails__userSettings__localeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__timeZonestringSpecifies 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`
userDetails__userSettings__templateActiveCreationstringWhen **true,** a new template is created each time the user sends an envelope.
userDetails__userSettings__allowEnvelopeTransferTostringWhen **true,** this user can participate in envelope transfers on the account.
userDetails__userSettings__canBulkUploadAgreementsstringuserDetails__userSettings__enableSignerAttachmentsstringWhen **true,** this user can use the signing attachments feature.
userDetails__userSettings__localeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__bulkSendMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__bulkSendMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__bulkSendMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canEditSharedAddressbookstringWhen true, this user can edit the shared address book for the account.
userDetails__userSettings__localePolicy__dateFormatstringSpecifies the date format. Valid values: - `default` <br> used the UI"s - `longformat` <br> use the UI"s long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
userDetails__userSettings__localePolicy__nameFormatstringDescribes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
userDetails__userSettings__localePolicy__timeFormatstringSpecifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
userDetails__userSettings__transactionPointUserNamestringReserved for Docusign.
userDetails__userSettings__webFormsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__webFormsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__webFormsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__adminOnlyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__adminOnlyMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__adminOnlyMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__bulkSendMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__bulkSendMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canManageAgreementPartiesstringuserDetails__userSettings__enableSequentialSigningUIstringWhen **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.
userDetails__userSettings__enableSignOnPaperOverridestringWhen **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.
userDetails__userSettings__localePolicy__allowRegionstringuserDetails__userSettings__localePolicy__cultureNamestringThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
userDetails__userSettings__newSendUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__newSendUIMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__newSendUIMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__templatePageLevelMatchingstringWhen **true,** users see template matching functionality.
userDetails__userSettings__webFormsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__webFormsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__adminOnlyMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__adminOnlyMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowSupplementalDocumentsstringWhen **true,** this user can include supplemental documents.
userDetails__userSettings__allowedOrchestrationAccessstringuserDetails__userSettings__enableSequentialSigningAPIstringWhen **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.
userDetails__userSettings__localePolicy__calendarTypestringSpecifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
userDetails__userSettings__localePolicy__currencyCodestringThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
userDetails__userSettings__modifiedByMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__modifiedByMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__modifiedByMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__newSendUIMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__newSendUIMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountAgreementsAccessTypestringuserDetails__userSettings__enableDSProMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableDSProMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableDSProMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__addressFormatstringSpecifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
userDetails__userSettings__localePolicy__initialFormatstringWhen 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`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
userDetails__userSettings__modifiedByMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__modifiedByMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__recipientViewedNotificationstringWhen **true,** this user receives notifications when envelopes are viewed.
userDetails__userSettings__templateMatchingSensitivitystringPercentage used when matching templates.
userDetails__userSettings__timezoneDSTMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__timezoneDSTMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__timezoneDSTMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__transactionPointSiteNameURLstringReserved for Docusign.
userDetails__userSettings__enableDSProMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableDSProMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__signDateFormatstringThe 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.
userDetails__userSettings__localePolicy__signTimeFormatstringThe format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss`
userDetails__userSettings__modifiedDateMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__modifiedDateMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__modifiedDateMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__modifiedPageMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__modifiedPageMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__modifiedPageMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__timezoneDSTMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__timezoneDSTMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__timezoneMaskMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__timezoneMaskMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__timezoneMaskMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__vaultingModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__vaultingModeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__vaultingModeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__modifiedDateMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__modifiedDateMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__modifiedPageMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__modifiedPageMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__powerFormModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__powerFormModeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__powerFormModeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustReadstringWhen **true,** this user must both view and accept supplemental documents.
userDetails__userSettings__supplementalDocumentsMustViewstringWhen **true,** this user must view supplemental documents.
userDetails__userSettings__timezoneMaskMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__timezoneMaskMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__vaultingModeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__vaultingModeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__apiCanExportACMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__apiCanExportACMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__apiCanExportACMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableVaultingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableVaultingMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableVaultingMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__customDateFormatstringuserDetails__userSettings__localePolicy__customTimeFormatstringuserDetails__userSettings__powerFormModeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__powerFormModeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__timezoneOffsetMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__timezoneOffsetMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__timezoneOffsetMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__allowRecipientLanguageSelectionstringWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
userDetails__userSettings__apiCanExportACMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__apiCanExportACMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__bulkSendMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canDeleteDocumentsInTransactionstringuserDetails__userSettings__canSendEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canSendEnvelopeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canSendEnvelopeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canSignEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canSignEnvelopeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canSignEnvelopeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableVaultingMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableVaultingMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__effectiveTimeZonestringuserDetails__userSettings__supplementalDocumentsMustAcceptstringWhen **true,** this user must accept supplemental documents.
userDetails__userSettings__timezoneOffsetMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__timezoneOffsetMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__webFormsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__adminOnlyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canChargeAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canChargeAccountMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canChargeAccountMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canLockEnvelopesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canLockEnvelopesMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canLockEnvelopesMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canManageAccountMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canManageAccountMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canManageAccountMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canSendEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canSendEnvelopeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canSignEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canSignEnvelopeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canUseScratchpadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canUseScratchpadMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canUseScratchpadMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__newSendUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__selfSignedRecipientEmailDocumentstringSets 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.
userDetails__forgottenPasswordInfo__forgottenPasswordAnswer1stringThe answer to the first forgotten password challenge question.
userDetails__forgottenPasswordInfo__forgottenPasswordAnswer2stringThe answer to the second forgotten password challenge question.
userDetails__forgottenPasswordInfo__forgottenPasswordAnswer3stringThe answer to the third forgotten password challenge question.
userDetails__forgottenPasswordInfo__forgottenPasswordAnswer4stringThe answer to the fourth forgotten password challenge question.
userDetails__userSettings__allowAccessToAllAccountAgreementsstringuserDetails__userSettings__allowTransactionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowTransactionsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowTransactionsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canChargeAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canChargeAccountMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canLockEnvelopesMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canLockEnvelopesMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canManageAccountMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canManageAccountMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canUseScratchpadMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canUseScratchpadMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__effectiveDateFormatstringuserDetails__userSettings__localePolicy__effectiveNameFormatstringuserDetails__userSettings__localePolicy__effectiveTimeFormatstringuserDetails__userSettings__modifiedByMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowTransactionsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowTransactionsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__anchorTagVersionedPlacementEnabledstringReserved for Docusign.
userDetails__userSettings__canManageTemplatesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canManageTemplatesMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canManageTemplatesMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canSendAPIRequestsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canSendAPIRequestsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canSendAPIRequestsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableDSProMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__customSignDateFormatstringuserDetails__userSettings__localePolicy__customSignTimeFormatstringuserDetails__userSettings__timezoneDSTMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__forgottenPasswordInfo__forgottenPasswordQuestion1stringThe first challenge question presented to a user who has forgotten their password.
userDetails__forgottenPasswordInfo__forgottenPasswordQuestion2stringThe second challenge question presented to a user who has forgotten their password.
userDetails__forgottenPasswordInfo__forgottenPasswordQuestion3stringThe third challenge question presented to a user who has forgotten their password.
userDetails__forgottenPasswordInfo__forgottenPasswordQuestion4stringThe fourth challenge question presented to a user who has forgotten their password.
userDetails__userSettings__allowSendOnBehalfOfMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowSendOnBehalfOfMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowSendOnBehalfOfMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canManageTemplatesMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canManageTemplatesMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canSendAPIRequestsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canSendAPIRequestsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__disableOtherActionsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__disableOtherActionsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__disableOtherActionsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__effectiveCalendarTypestringuserDetails__userSettings__localePolicy__effectiveCurrencyCodestringuserDetails__userSettings__modifiedDateMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__modifiedPageMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__templateApplyNotifyMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__templateApplyNotifyMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__templateApplyNotifyMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__timezoneMaskMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__timezoneSendingPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__timezoneSendingPrefMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__timezoneSendingPrefMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__timezoneSigningPrefMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__timezoneSigningPrefMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__timezoneSigningPrefMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__vaultingModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowEsealRecipientsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowEsealRecipientsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowEsealRecipientsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__allowSendOnBehalfOfMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowSendOnBehalfOfMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__apiAccountWideAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__apiAccountWideAccessMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__apiAccountWideAccessMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canCreateTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canCreateTransactionMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canCreateTransactionMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canDeleteTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canDeleteTransactionMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canDeleteTransactionMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canManageDistributorMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canManageDistributorMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canManageDistributorMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canUseSmartContractsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canUseSmartContractsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canUseSmartContractsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__disableOtherActionsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__disableOtherActionsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyNegativeFormatstringDetermines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1"234"567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1"234"567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1"234"567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1"234"567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123"456"789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
userDetails__userSettings__localePolicy__currencyPositiveFormatstringDetermines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1"234"567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123"456"789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
userDetails__userSettings__localePolicy__effectiveAddressFormatstringuserDetails__userSettings__localePolicy__effectiveInitialFormatstringuserDetails__userSettings__manageClickwrapsModeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__manageClickwrapsModeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__manageClickwrapsModeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__powerFormModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__templateApplyNotifyMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__templateApplyNotifyMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__templateAutoMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__templateAutoMatchingMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__templateAutoMatchingMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__timezoneSendingPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__timezoneSendingPrefMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__timezoneSigningPrefMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__timezoneSigningPrefMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowEsealRecipientsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowEsealRecipientsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__apiAccountWideAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__apiAccountWideAccessMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__apiCanExportACMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canCreateTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canCreateTransactionMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canDeleteTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canDeleteTransactionMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canManageDistributorMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canManageDistributorMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canUseSmartContractsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canUseSmartContractsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__disableDocumentUploadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__disableDocumentUploadMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__disableDocumentUploadMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableVaultingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__manageClickwrapsModeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__manageClickwrapsModeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__signerEmailNotifications__faxReceivedstringReserved for Docusign.
userDetails__userSettings__supplementalDocumentIncludeInDownloadstringWhen **true,** this user gets supplemental documents when downloading documents.
userDetails__userSettings__templateAutoMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__templateAutoMatchingMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__timezoneOffsetMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canSendEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canSignEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__disableDocumentUploadMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__disableDocumentUploadMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__enableTransactionPointMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableTransactionPointMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableTransactionPointMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__timeZoneMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__timeZoneMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__timeZoneMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__templateActiveCreationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__templateActiveCreationMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__templateActiveCreationMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canViewUsersstringuserDetails__userSettings__allowEnvelopeTransferToMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowEnvelopeTransferToMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowEnvelopeTransferToMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canBulkUploadAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canBulkUploadAgreementsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canBulkUploadAgreementsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canChargeAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canLockEnvelopesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canManageAccountMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canUseScratchpadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypestringuserDetails__userSettings__enableSignerAttachmentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableSignerAttachmentsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableSignerAttachmentsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableTransactionPointMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableTransactionPointMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__effectiveCustomDateFormatstringuserDetails__userSettings__localePolicy__effectiveCustomTimeFormatstringuserDetails__userSettings__localePolicy__timeZoneMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__timeZoneMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__changedSignerstringWhen **true,** the sender receives an email notification if the signer changes.
userDetails__userSettings__templateActiveCreationMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__templateActiveCreationMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowEnvelopeTransferToMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowEnvelopeTransferToMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowTransactionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canBulkUploadAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canBulkUploadAgreementsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canEditSharedAddressbookMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canEditSharedAddressbookMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canEditSharedAddressbookMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableSignerAttachmentsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableSignerAttachmentsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__dateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__dateFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__dateFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__nameFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__nameFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__nameFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__timeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__timeFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__timeFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__deliveryFailedstringWhen **true,** the sender receives an email notification if envelope delivery fails.
userDetails__userSettings__senderEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userDetails__userSettings__signerEmailNotifications__envelopeVoidedstringWhen **true,** the user receives notification that the envelope has been voided.
userDetails__userSettings__signerEmailNotifications__purgeDocumentsstringWhen **true,** the user receives an email notification when a document purge occurs.
userDetails__userSettings__transactionPointUserNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__transactionPointUserNameMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__transactionPointUserNameMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageUsersstring**True** if the user can manage users.
userDetails__userSettings__canEditSharedAddressbookMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canEditSharedAddressbookMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canManageAgreementPartiesMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canManageAgreementPartiesMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canManageAgreementPartiesMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canManageTemplatesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canSendAPIRequestsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSequentialSigningUIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableSequentialSigningUIMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableSequentialSigningUIMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableSignOnPaperOverrideMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableSignOnPaperOverrideMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableSignOnPaperOverrideMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__cultureNameMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__cultureNameMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__cultureNameMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__dateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__dateFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__nameFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__nameFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__timeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__timeFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__recipientViewedstringWhen **true,** the sender receives notification that a recipient viewed the envelope.
userDetails__userSettings__templatePageLevelMatchingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__templatePageLevelMatchingMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__templatePageLevelMatchingMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__transactionPointUserNameMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__transactionPointUserNameMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAdminsstring**True** if the user can manage administrators.
userDetails__userSettings__accountManagementGranular__canManageStampsstringuserDetails__userSettings__allowSendOnBehalfOfMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowSupplementalDocumentsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowSupplementalDocumentsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowSupplementalDocumentsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__allowedOrchestrationAccessMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowedOrchestrationAccessMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowedOrchestrationAccessMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canManageAgreementPartiesMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canManageAgreementPartiesMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__disableOtherActionsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSequentialSigningAPIMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableSequentialSigningAPIMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableSequentialSigningAPIMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__enableSequentialSigningUIMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableSequentialSigningUIMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__enableSignOnPaperOverrideMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableSignOnPaperOverrideMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__calendarTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__calendarTypeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__calendarTypeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__cultureNameMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__cultureNameMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyCodeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__currencyCodeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyCodeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userDetails__userSettings__senderEmailNotifications__withdrawnConsentstringWhen **true,** the user receives an email notification if consent is withdrawn.
userDetails__userSettings__signerEmailNotifications__envelopeCompletestringWhen **true,** the user receives an email notification when the envelope has been completed.
userDetails__userSettings__signerEmailNotifications__envelopeDeclinedstringWhen **true,** the user receives notification that the envelope has been declined.
userDetails__userSettings__signerEmailNotifications__reassignedSignerstringWhen **true,** the user receives notification that the envelope has been reassigned.
userDetails__userSettings__templateApplyNotifyMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__templatePageLevelMatchingMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__templatePageLevelMatchingMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__timezoneSendingPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__timezoneSigningPrefMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountAgreementsAccessTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountAgreementsAccessTypeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountAgreementsAccessTypeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageConnectstringuserDetails__userSettings__accountManagementGranular__canManageSharingstring**True** if the user can manage sharing.
userDetails__userSettings__allowEsealRecipientsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowSupplementalDocumentsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowSupplementalDocumentsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowedOrchestrationAccessMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowedOrchestrationAccessMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__apiAccountWideAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canCreateTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canDeleteTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canManageDistributorMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canUseSmartContractsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSequentialSigningAPIMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableSequentialSigningAPIMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__addressFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__addressFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__addressFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__calendarTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__calendarTypeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyCodeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__currencyCodeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__initialFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__initialFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__initialFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__manageClickwrapsModeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__recipientViewedNotificationMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__recipientViewedNotificationMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__recipientViewedNotificationMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__signerEmailNotifications__agentNotificationstringWhen **true,** the user receives agent notification emails.
userDetails__userSettings__signerEmailNotifications__envelopeCorrectedstringWhen **true,** the user receives notification that the envelope has been corrected.
userDetails__userSettings__templateAutoMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__templateMatchingSensitivityMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__templateMatchingSensitivityMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__templateMatchingSensitivityMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__transactionPointSiteNameURLMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__transactionPointSiteNameURLMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__transactionPointSiteNameURLMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountAgreementsAccessTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountAgreementsAccessTypeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__disableDocumentUploadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__addressFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__addressFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__initialFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__initialFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__signDateFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__signDateFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__signDateFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__signTimeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__signTimeFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__signTimeFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__recipientViewedNotificationMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__recipientViewedNotificationMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userDetails__userSettings__signerEmailNotifications__commentsReceiveAllstringWhen **true,** the user receives all comments.
userDetails__userSettings__signerEmailNotifications__envelopeActivationstringWhen **true,** the user receives notification that the envelope has been activated.
userDetails__userSettings__templateMatchingSensitivityMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__templateMatchingSensitivityMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__transactionPointSiteNameURLMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__transactionPointSiteNameURLMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageReportingstring**True** if the user can manage reporting.
userDetails__userSettings__canSendEnvelopesViaSMSMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableTransactionPointMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__effectiveCurrencyNegativeFormatstringuserDetails__userSettings__localePolicy__effectiveCurrencyPositiveFormatstringuserDetails__userSettings__localePolicy__signDateFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__signDateFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__signTimeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__signTimeFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__timeZoneMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__supplementalDocumentsMustReadMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__supplementalDocumentsMustReadMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustReadMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustViewMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__supplementalDocumentsMustViewMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustViewMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__templateActiveCreationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowEnvelopeTransferToMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canBulkUploadAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSignerAttachmentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__senderEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userDetails__userSettings__signerEmailNotifications__offlineSigningFailedstringWhen **true,** the user receives an email notification if offline signing failed.
userDetails__userSettings__supplementalDocumentsMustReadMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__supplementalDocumentsMustReadMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustViewMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__supplementalDocumentsMustViewMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__canEditSharedAddressbookMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__dateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__nameFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__timeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__transactionPointUserNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopestringWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__canManageAgreementPartiesMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSequentialSigningUIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSignOnPaperOverrideMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__cultureNameMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__senderEnvelopeDeclinedstringWhen **true,** the sender receives notification that the envelope was declined.
userDetails__userSettings__signerEmailNotifications__carbonCopyNotificationstringWhen **true,** the user receives notifications of carbon copy deliveries.
userDetails__userSettings__signerEmailNotifications__whenSigningGroupMemberstringWhen **true,** the user receives notification that he or she is a member of the signing group.
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__templatePageLevelMatchingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsstring**True** if the user can manage signing groups.
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__allowSupplementalDocumentsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowedOrchestrationAccessMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableSequentialSigningAPIMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__calendarTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__currencyCodeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountAgreementsAccessTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__addressFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__initialFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__recipientViewedNotificationMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__signerEmailNotifications__documentMarkupActivationstringWhen **true,** the user receives notification that document markup has been activated.
userDetails__userSettings__templateMatchingSensitivityMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__transactionPointSiteNameURLMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsstring**True** if the user can manage account settings.
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsstringuserDetails__userSettings__localePolicy__signDateFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__signTimeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferstringuserDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__supplementalDocumentsMustReadMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__supplementalDocumentsMustViewMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionstringuserDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersstringuserDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowRecipientLanguageSelectionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__canDeleteDocumentsInTransactionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__supplementalDocumentsMustAcceptMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__selfSignedRecipientEmailDocumentMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__senderEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userDetails__userSettings__signerEmailNotifications__certifiedDeliveryNotificationstringWhen **true,** the user receives notifications of certified deliveries.
userDetails__userSettings__signerEmailNotifications__commentsOnlyPrivateAndMentionstringWhen **true,** the user receives only comments that mention their own user name.
userDetails__userSettings__allowAccessToAllAccountAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsstring**True** if the user can manage account security settings.
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__localePolicy__currencyNegativeFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__localePolicy__currencyPositiveFormatMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__enableKeyTermsSuggestionsByDocumentTypeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAdminsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageStampsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageConnectMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageSharingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__senderEmailNotifications__clickwrapResponsesLimitNotificationEmailstringuserDetails__userSettings__senderEmailNotifications__powerformResponsesLimitNotificationEmailstringuserDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageReportingMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageSigningGroupsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageAccountSettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageJointAgreementsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__rightsstringIndicates whether the property is editable. Valid values are: - `editable` - `read_only`
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiHintstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiTypestringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageEnvelopeTransferMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__optionsstring[]An array of option strings supported by this setting.
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__uiOrderstringReserved for Docusign.
userDetails__userSettings__accountManagementGranular__canManageDocumentRetentionMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageGroupsButNotUsersMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
userDetails__userSettings__accountManagementGranular__canManageAccountSecuritySettingsMetadata__is21CFRPart11stringWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update user signature by idDOCUSIGN_UPDATE_USER_SIGNATURE_BY_IDAcciónUpdates or creates a user's signature and initials for a specified docusign account. this endpoint allows for customization of signature appearance, including font, stamp format, and date stamp properties. it can be used to modify an existing signature or create a default signature if one doesn't exist. the endpoint requires the user to be authenticated and a member of the specified account, with the userid matching the authenticated user's id. it's particularly useful for personalizing signature appearance or creating new signatures for users within an organization's docusign account.
DOCUSIGN_UPDATE_USER_SIGNATURE_BY_IDAcciónUpdates or creates a user's signature and initials for a specified docusign account. this endpoint allows for customization of signature appearance, including font, stamp format, and date stamp properties. it can be used to modify an existing signature or create a default signature if one doesn't exist. the endpoint requires the user to be authenticated and a member of the specified account, with the userid matching the authenticated user's id. it's particularly useful for personalizing signature appearance or creating new signatures for users within an organization's docusign account.
Parámetros de entrada
nrdsIdstringThe National Association of Realtors (NAR) membership ID for a user who is a realtor.
userIdstringObligatorioThe 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.
accountIdstringThe 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.
imageTypestringSpecificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`
isDefaultstringBoolean that specifies whether the signature is the default signature for the user.
externalIDstringOptionally specify an external identifier for the user"s signature.
signatureIdstringObligatorioSpecifies 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.
stampFormatstringThe 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.
stampSizeMMstringThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
nrdsLastNamestringThe realtor"s last name.
phoneticNamestringThe phonetic spelling of the `signatureName`.
signatureFontstringThe 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"`
signatureNamestringSpecifies the user"s signature name.
signatureTypestringSpecifies the type of signature.
signatureInitialsstringSpecifies the user"s signature in initials format.
disallowUserResizeStampstringWhen **true,** users may not resize the stamp.
close_existing_signaturestringAn 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.
dateStampProperties__dateAreaXstringThe X axis position of the top-left corner.
dateStampProperties__dateAreaYstringThe Y axis position of the top-left corner.
dateStampProperties__dateAreaWidthstringThe width of the rectangle.
dateStampProperties__dateAreaHeightstringThe height of the rectangle.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update workflow step for templateDOCUSIGN_UPDATE_WORKFLOW_STEP_FOR_TEMPLATEAcciónThis 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.
DOCUSIGN_UPDATE_WORKFLOW_STEP_FOR_TEMPLATEAcciónThis 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.
Parámetros de entrada
actionstringIndicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
itemIdstringThe unique ID of the item being triggered.
statusstringThe status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only.
accountIdstringThe 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.
templateIdstringObligatorioThe 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.
completedDatestringThe timestamp of when the workflow step transitioned to `completed` status. This property is read-only.
triggerOnItemstringThe type of item that triggers this workflow step. Valid values: * `routing_order`
triggeredDatestringThe timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only.
workflowStepIdstringObligatorioA unique identifier for this workflow step. This property is read-only.
delayedRouting__rulesobject[]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.
delayedRouting__statusstringStatus 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.
delayedRouting__resumeDatestringThe 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.
recipientRouting__rules__conditionalRecipientsobject[]
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateworkspaceinformationDOCUSIGN_UPDATE_WORKSPACE_INFORMATIONAcciónUpdates 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.
DOCUSIGN_UPDATE_WORKSPACE_INFORMATIONAcciónUpdates 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.
Parámetros de entrada
statusstringIndicates 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.
createdstringThe UTC DateTime when the workspace user authorization was created.
accountIdstringThe 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.
workspaceIdstringObligatorioThe ID of the workspace, always populated.
lastModifiedstringUtc date and time the comment was last updated (can only be done by creator.)
workspaceUristringThe relative URI for accessing the workspace.
workspaceNamestringThe name of the workspace.
workspaceBaseUrlstringThe relative URL for accessing the workspace.
billableAccountIdstringThe ID of the account to bill.
workspaceDescriptionstringText describing the purpose of the workspace.
callerInformation__typestringType of the user. Valid values: type_owner, type_participant.
callerInformation__emailstringThe workspace user"s email address.
callerInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
callerInformation__userIdstringThe ID of the workspace user.
settings__commentsAllowedstringWhen **true,** commenting on the documents in the workspace is allowed.
callerInformation__createdstringThe UTC DateTime when the workspace user was created.
createdByInformation__typestringType of the user. Valid values: type_owner, type_participant.
callerInformation__userNamestringThe name of workspace user.
createdByInformation__emailstringThe workspace user"s email address.
callerInformation__accountIdstringThe account ID associated with the workspace user.
createdByInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
createdByInformation__userIdstringThe ID of the workspace user.
createdByInformation__createdstringThe UTC DateTime when the workspace user was created.
callerInformation__accountNamestringThe name of the account that the workspace user belongs to.
callerInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
callerInformation__createdByIdstringThe ID of the user who created this workspace user.
callerInformation__workspaceIdstringThe ID of the workspace.
createdByInformation__userNamestringThe name of workspace user.
callerInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
createdByInformation__accountIdstringThe account ID associated with the workspace user.
lastModifiedByInformation__typestringType of the user. Valid values: type_owner, type_participant.
lastModifiedByInformation__emailstringThe workspace user"s email address.
createdByInformation__accountNamestringThe name of the account that the workspace user belongs to.
createdByInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
createdByInformation__createdByIdstringThe ID of the user who created this workspace user.
createdByInformation__workspaceIdstringThe ID of the workspace.
lastModifiedByInformation__statusstringFilters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
lastModifiedByInformation__userIdstringThe ID of the workspace user.
callerInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
lastModifiedByInformation__createdstringThe UTC DateTime when the workspace user was created.
callerInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
callerInformation__workspaceUserUristringThe URI for accessing the workspace user.
lastModifiedByInformation__userNamestringThe name of workspace user.
lastModifiedByInformation__accountIdstringThe account ID associated with the workspace user.
createdByInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
createdByInformation__workspaceUserUristringThe URI for accessing the workspace user.
lastModifiedByInformation__accountNamestringThe name of the account that the workspace user belongs to.
lastModifiedByInformation__activeSincestringThe UTC DateTime when the user joined the workspace.
lastModifiedByInformation__createdByIdstringThe ID of the user who created this workspace user.
lastModifiedByInformation__workspaceIdstringThe ID of the workspace.
callerInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
callerInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__lastModifiedstringThe UTC DateTime that the workspace user was last modified.
callerInformation__errorDetails__messagestringA brief message describing the error condition.
callerInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
callerInformation__errorDetails__errorCodestringThe code associated with the error condition.
createdByInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
createdByInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__workspaceUserIdstringThe ID of the workspace user.
createdByInformation__errorDetails__messagestringA brief message describing the error condition.
lastModifiedByInformation__lastModifiedByIdstringThe ID of the user who last modified the workspace user.
lastModifiedByInformation__workspaceUserUristringThe URI for accessing the workspace user.
createdByInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
createdByInformation__errorDetails__errorCodestringThe code associated with the error condition.
lastModifiedByInformation__invitationEmailBlurbstringThe text of the workspace invitation email message sent to the user.
lastModifiedByInformation__workspaceUserBaseUrlstringThe URL for accessing the workspace user.
lastModifiedByInformation__errorDetails__messagestringA brief message describing the error condition.
lastModifiedByInformation__invitationEmailSubjectstringThe subject line of the workspace invitation email message sent to the user.
lastModifiedByInformation__errorDetails__errorCodestringThe code associated with the error condition.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
UpdateworkspaceitemmetadataDOCUSIGN_UPDATE_WORKSPACE_ITEM_METADATAAcciónThis endpoint updates the metadata for one or more specific files or folders in a docusign workspace. it allows users to modify information associated with workspace items without changing the actual content of the files. this method is useful for updating properties such as names, permissions, or other metadata attributes of workspace items. it should be used when changes to item details are needed, but not for modifying the file contents themselves. the endpoint requires specific identification of the account, workspace, and item (file or folder) being updated.
DOCUSIGN_UPDATE_WORKSPACE_ITEM_METADATAAcciónThis endpoint updates the metadata for one or more specific files or folders in a docusign workspace. it allows users to modify information associated with workspace items without changing the actual content of the files. this method is useful for updating properties such as names, permissions, or other metadata attributes of workspace items. it should be used when changes to item details are needed, but not for modifying the file contents themselves. the endpoint requires specific identification of the account, workspace, and item (file or folder) being updated.
Parámetros de entrada
fileIdstringObligatorioThe unique identifier for the file within the workspace. This parameter is required and must be a valid file ID string. It specifies which file"s metadata is being updated. If updating a folder, this should still be provided but may not be used in the operation.
folderIdstringObligatorioThe unique identifier for the folder within the workspace. This parameter is required and must be a valid folder ID string. It specifies which folder"s metadata is being updated or which folder contains the file being updated. If updating a file directly in the workspace root, this may refer to the root folder.
accountIdstringThe 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"s workspace is being accessed. The accountId must be valid and associated with an active DocuSign account.
workspaceIdstringObligatorioThe unique identifier for the workspace containing the item to be updated. This parameter is required and must be a valid workspace ID string. It determines the specific workspace context for the operation, ensuring that the correct workspace"s items are being modified.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Triggers (20)
Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).
Envelope CompletedDOCUSIGN_ENVELOPE_COMPLETEDTriggerTriggers when every recipient has finished and the agreement is executed.
Watch Recipient Completed instead to react as each individual signer
finishes.
DOCUSIGN_ENVELOPE_COMPLETEDTriggerTriggers when every recipient has finished and the agreement is executed. Watch Recipient Completed instead to react as each individual signer finishes.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope CreatedDOCUSIGN_ENVELOPE_CREATEDTriggerTriggers 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.
DOCUSIGN_ENVELOPE_CREATEDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope DeclinedDOCUSIGN_ENVELOPE_DECLINEDTriggerTriggers when a recipient declines to sign, which declines the whole
envelope.
DOCUSIGN_ENVELOPE_DECLINEDTriggerTriggers when a recipient declines to sign, which declines the whole envelope.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope DeletedDOCUSIGN_ENVELOPE_DELETEDTriggerTriggers when an already-sent envelope is deleted. An envelope still in the
created state fires Envelope Discarded instead.
DOCUSIGN_ENVELOPE_DELETEDTriggerTriggers when an already-sent envelope is deleted. An envelope still in the created state fires Envelope Discarded instead.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope DeliveredDOCUSIGN_ENVELOPE_DELIVEREDTriggerTriggers 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.
DOCUSIGN_ENVELOPE_DELIVEREDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope DiscardedDOCUSIGN_ENVELOPE_DISCARDEDTriggerTriggers when a draft envelope is deleted or discarded in the tagging UI.
An envelope that was already sent fires Envelope Deleted instead.
DOCUSIGN_ENVELOPE_DISCARDEDTriggerTriggers when a draft envelope is deleted or discarded in the tagging UI. An envelope that was already sent fires Envelope Deleted instead.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope Purge QueuedDOCUSIGN_ENVELOPE_PURGE_QUEUEDTriggerTriggers 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.
DOCUSIGN_ENVELOPE_PURGE_QUEUEDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope ResentDOCUSIGN_ENVELOPE_RESENTTriggerTriggers when the envelope is resent to its recipients from the UI or the
API. Watch Recipient Resent for a resend aimed at one recipient.
DOCUSIGN_ENVELOPE_RESENTTriggerTriggers when the envelope is resent to its recipients from the UI or the API. Watch Recipient Resent for a resend aimed at one recipient.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope SentDOCUSIGN_ENVELOPE_SENTTriggerTriggers 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.
DOCUSIGN_ENVELOPE_SENTTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Envelope VoidedDOCUSIGN_ENVELOPE_VOIDEDTriggerTriggers when the sender voids the envelope or it expires.
envelopeSummary.voidedReason tells the two apart.
DOCUSIGN_ENVELOPE_VOIDEDTriggerTriggers when the sender voids the envelope or it expires. envelopeSummary.voidedReason tells the two apart.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient AutorespondedDOCUSIGN_RECIPIENT_AUTORESPONDEDTriggerTriggers 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.
DOCUSIGN_RECIPIENT_AUTORESPONDEDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient CompletedDOCUSIGN_RECIPIENT_COMPLETEDTriggerTriggers 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.
DOCUSIGN_RECIPIENT_COMPLETEDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient DeclinedDOCUSIGN_RECIPIENT_DECLINEDTriggerTriggers when a specific recipient declines to sign.
DOCUSIGN_RECIPIENT_DECLINEDTriggerTriggers when a specific recipient declines to sign.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient DeliveredDOCUSIGN_RECIPIENT_DELIVEREDTriggerTriggers when a specific recipient opens the documents in the DocuSign
signing site. This is not email delivery.
DOCUSIGN_RECIPIENT_DELIVEREDTriggerTriggers when a specific recipient opens the documents in the DocuSign signing site. This is not email delivery.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient Finished LaterDOCUSIGN_RECIPIENT_FINISHED_LATERTriggerTriggers when a recipient chooses Other Actions then Finish Later, leaving
the session without completing. This is the stalled-signature event.
DOCUSIGN_RECIPIENT_FINISHED_LATERTriggerTriggers when a recipient chooses Other Actions then Finish Later, leaving the session without completing. This is the stalled-signature event.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient ResentDOCUSIGN_RECIPIENT_RESENTTriggerTriggers when the envelope is resent to one specific recipient. Watch
Envelope Resent for a resend to everyone.
DOCUSIGN_RECIPIENT_RESENTTriggerTriggers when the envelope is resent to one specific recipient. Watch Envelope Resent for a resend to everyone.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Recipient SentDOCUSIGN_RECIPIENT_SENTTriggerTriggers 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.
DOCUSIGN_RECIPIENT_SENTTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
envelopeIdstringObligatorioId of the envelope the event is about.
envelopeSummaryobjectA DocuSign envelope — the agreement the event is about.
recipientIdstringObligatorioId of the recipient the event is about.
userIdstringThe DocuSign user whose action produced the event — the sender or initiator.
Template CreatedDOCUSIGN_TEMPLATE_CREATEDTriggerTriggers when a template is created, in the UI or through the API.
DOCUSIGN_TEMPLATE_CREATEDTriggerTriggers when a template is created, in the UI or through the API.
Configuración
account_idstringThe 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 del evento
createdstringUTC timestamp the template was created.
namestringThe template's name.
templateIdstringObligatorioId of the template.
userIdstringThe DocuSign user whose action produced the event.
Template DeletedDOCUSIGN_TEMPLATE_DELETEDTriggerTriggers 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.
DOCUSIGN_TEMPLATE_DELETEDTriggerTriggers 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.
Configuración
account_idstringThe 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 del evento
createdstringUTC timestamp the template was created.
namestringThe template's name.
templateIdstringObligatorioId of the template.
userIdstringThe DocuSign user whose action produced the event.
Template ModifiedDOCUSIGN_TEMPLATE_MODIFIEDTriggerTriggers when a template is modified. The payload names the template but
not what changed, so re-fetch the template if you need the detail.
DOCUSIGN_TEMPLATE_MODIFIEDTriggerTriggers when a template is modified. The payload names the template but not what changed, so re-fetch the template if you need the detail.
Configuración
account_idstringThe 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 del evento
createdstringUTC timestamp the template was created. This is its creation time, not the time of this edit — the event carries no modification timestamp.
namestringThe template's name.
templateIdstringObligatorioId of the template.
userIdstringThe DocuSign user whose action produced the event.