Overview

Configuration is provided for establishing connections with the Docusign eSignature service. The configuration is used in the REST Connection Manager.
Setup
Press
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Quick Start
In this section, we will showcase how to create a connection to the Docusign Service REST API using COZYROC's REST Connection Manager.
Step 2. Edit the Server replacing the placeholder with your Account ID and select the Authentication you would like to use from the dropdown menu, more information on the Docusign authentication mechanisms can be found here.
Optionally if you plan on using a demo account, change the server host to demo.docusign.net.
Congratulations! You have now established a connection to your Docusign instance.
In this guide, we will show how to read data from the Docusign service resource using the COZYROC REST Source component.
Bravo! You have now learned how to read data from Docusign service.
In this guide, we will show how to write data to the Docusign service resource using the COZYROC REST Destination component.
Done. You have now learned how to write data into a Docusign resource.
Click here for the official Docusign chunked upload documentation.
Step 3. Verify the pipeline succeeded.
Note: Alternatively you can use the COZYROC File Transfer Task with a Docusign CM.
Configuration
Base URL address: https://docusign.net/restapi/v2.1/accounts/[AccountId].
- Authorization Code Grant
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- IntegrationKey: Required. Specify integration key.
- ClientSecret: Required. Specify client_secret for OAuth integration.
- Scope: https://developers.docusign.com/platform/auth/reference/scopes/
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.docusign.com/platform/auth/confidential-authcode-get-token/.
- Public Authorization Code
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- IntegrationKey: Required. Specify integration key.
- Scope: https://developers.docusign.com/platform/auth/reference/scopes/
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.docusign.com/platform/auth/public-authcode-get-token/.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/brands.
The result is extracted from:{{=response.brands}}.The action has the following user-defined parameters:
- exclude_distributor_brand: When true, excludes distributor brand information from the response set.
- include_logos: When true, returns the logos associated with the brand.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/list/.
- [Read Single] action
-
Endpoint URL address:
/brands/{{=parameters.id}}.The action has the following user-defined parameters:
- include_external_references: When true, the landing pages and links associated with the brand are included in the response. Optional.
- include_logos: When true, the URIs for the logos associated with the brand are included in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/get/.
- [Create] action
-
Endpoint URL address:
/brands.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/create/.
- [Update] action
-
Endpoint URL address:
/brands/{{=item.brandId}}.The action has the following user-defined parameters:
- replace_brand: When true, replaces the brand instead of updating it. The only unchanged value is the brand ID. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/update/.
- [Delete] action
-
Endpoint URL address:
/brands/{{=item.brandId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/delete/.
The resource includes the fields from the brand template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/brands/{{=parameters.brandId}}/logos/{{=parameters.logoType}}.
The result is extracted from:{{=[{ content: response['@@@raw@@@'] }]}}.The action has the following user-defined parameters:
- brandId: Required. The ID of the brand.
- logoType: Required. The type of logo.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/getlogo/.
- [Update] action
-
Endpoint URL address:
/brands/{{=item.brandId}}/logos/{{=item.logoType}}.The following request parameters will be automatically processed:
-
file:
{{=item.content}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/.
-
file:
- [Delete] action
-
Endpoint URL address:
/brands/{{=item.brandId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/delete/.
- brandId
A key field. Template: ShortText.
- logoType
A key field. Template: ShortText.
- content
Data type: DT_IMAGE
- filename
Template: ShortText.
- name
Template: ShortText.
- mimeType
Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/consumer_disclosure/{{=parameters.get('langCode', '')}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- langCode: The code for the signer language version of the disclosure that you want to retrieve. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountconsumerdisclosures/get/.
- [Update] action
-
Endpoint URL address:
/consumer_disclosure/{{=item.langCode}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountconsumerdisclosures/update/.
The resource includes the fields from the consumerDisclosure template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/custom_fields.
The result is extracted from:{{=_.union(response.textCustomFields, response.listCustomFields)}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/list/.
- [Create] action
-
Endpoint URL address:
/custom_fields.The action has the following user-defined parameters:
- apply_to_templates: When true, the new custom field is applied to all of the templates on the account. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/create/.
- [Update] action
-
Endpoint URL address:
/custom_fields/{{=item.customFieldId}}.The action has the following user-defined parameters:
- apply_to_templates: When true, the new custom field is applied to all of the templates on the account. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/update/.
- [Delete] action
-
Endpoint URL address:
/custom_fields/{{=item.customFieldId}}.The action has the following user-defined parameters:
- apply_to_templates: When true, the new custom field is applied to all of the templates on the account. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountcustomfields/delete/.
The resource includes the fields from the listCustomField template.
- customFieldType
Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/settings/password_rules.
The result is extracted from:{{=[response]}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpasswordrules/get/.
- [Update] action
-
Endpoint URL address:
/settings/password_rules.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpasswordrules/update/.
The resource includes the fields from the accountPasswordRules template.
Based on resource template AccountBase.
- [Read Single] action
-
Endpoint URL address:
/permission_profiles/{{=parameters.id}}.The action has the following user-defined parameters:
- include: A comma-separated list of additional properties to return in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/get/.
- [Read] action
-
Endpoint URL address:
/permission_profiles.
The result is extracted from:{{=response.permissionProfiles}}.The action has the following user-defined parameters:
- include: A comma-separated list of additional properties to return in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/.
- [Create] action
-
Endpoint URL address:
/permission_profiles.The action has the following user-defined parameters:
- include: A comma-separated list of additional properties to return in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/create/.
- [Update] action
-
Endpoint URL address:
/permission_profiles/{{=item.permissionProfileId}}.The action has the following user-defined parameters:
- include: A comma-separated list of additional properties to return in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/update/.
- [Delete] action
-
Endpoint URL address:
/permission_profiles/{{=item.permissionProfileId}}.The action has the following user-defined parameters:
- move_users_to: Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/delete/.
The resource includes the fields from the permissionProfile template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- include_account_settings: When true, includes account settings in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounts/get/.
- [Create] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/restapi/v2.1/accounts.The following request parameters will be automatically processed:
-
application/json:
{{={ newAccountRequests: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounts/create/#/definitions/newAccountRequest.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounts/delete/.
The resource includes the fields from the newAccountDefinition template.
- unsupportedFileTypes
A read-only field. The value is gathered from
/unsupported_file_typesaddress. The gathered value is processed with{{=response.fileTypes}}expression. Field components:- An array.
-
Uses template:
fileType.
- supportedLanguages
A read-only field. The value is gathered from
/supported_languagesaddress. The gathered value is processed with{{=response.languages}}expression. Field components:- An array.
-
Uses template:
nameValue.
- provisioningInformation
A read-only field. The value is gathered from
{{=new Uri(connection.serverHost).authority()}}/restapi/v2.1/accounts/provisioningaddress. Field components:-
Uses template:
ShortText. - Contains the following components: defaultConnectionId, defaultPlanId, distributorCode, distributorPassword, passwordRuleText, planPromotionText, purchaseOrderOrPromAllowed.
-
Uses template:
- envelopesBillingCharges
The value is gathered from
/billing_chargesaddress. The gathered value is processed with{{=response.billingChargeItems}}expression. Field components:- An array.
-
Uses template:
billingCharge.
- seatsBillingCharges
The value is gathered from
/billing_chargesaddress. The gathered value is processed with{{=response.billingChargeItems}}expression. Field components:- An array.
-
Uses template:
billingCharge.
- envelopePurgeConfiguration
Template: envelopePurgeConfiguration. The value is gathered from
/settings/envelope_purge_configurationaddress. The value is sent to/settings/envelope_purge_configurationaddress.- settings
Template: accountSettingsInformation. The value is gathered from
/settingsaddress. The value is sent to/settingsaddress.- seals
The value is gathered from
/sealsaddress. The gathered value is processed with{{=response.seals}}expression. Field components:- An array.
-
Uses template:
sealIdentifier.
- signatureProviders
The value is gathered from
/signatureProvidersaddress. The gathered value is processed with{{=response.signatureProviders}}expression. Field components:- An array.
-
Uses template:
accountSignatureProvider.
- tabSettings
Template: tabAccountSettings. The value is gathered from
/settings/tabsaddress. The value is sent to/settings/tabsaddress.- watermark
Template: watermark. The value is gathered from
/watermarkaddress. The value is sent to/watermarkaddress.- eNoteConfiguration
Template: eNoteConfiguration. The value is gathered from
/settings/enote_configurationaddress. The value is sent to/settings/enote_configurationaddress.- action
Field components:
- Contains the following components: deleteCaptiveRecipient, deleteENoteConfiguration.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/signatures.
The result is extracted from:{{=response.accountSignatures}}.The action has the following user-defined parameters:
- stamp_format: The format of the stamp to return. Optional.
- stamp_name: The name associated with the stamps to return. Optional.
- stamp_type: The type of the stamps to return. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/getaccountsignatures/.
- [Read Single] action
-
Endpoint URL address:
/signatures/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/getaccountsignature/.
- [Create] action
-
Endpoint URL address:
/signatures.The action has the following user-defined parameters:
- decode_only:
The following request parameters will be automatically processed:
-
application/json:
{{={ accountSignatures: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/createaccountsignatures/.
- [Update] action
-
Endpoint URL address:
/signatures.The following request parameters will be automatically processed:
-
application/json:
{{={ accountSignatures: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/updateaccountsignature/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/signatures/{{=item.signatureId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/deleteaccountsignature/.
The resource includes the fields from the accountSignature template.
- image
The value is gathered from
/signatures/{{=item.signatureId}}/{{=item.imageType}}address. The gathered value is processed with{{={ content: response } }}expression. The value is sent to/signatures/{{=item.signatureId}}/{{=item.imageType}}address. Field components:-
Uses template:
ShortText. - Contains the following components: name, content, filename, mimeType.
-
Uses template:
- action
Field components:
- Contains the following components: deleteImage.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/authorizations.
The result is extracted from:{{=response.authorizations}}.The action has the following user-defined parameters:
- userId: Required. The ID of the principal user.
- active_only: When true, return only active authorizations. Optional.
- email_substring: Filters returned user records by full email address or a substring of email address. Optional.
- include_closed_users: When true, returns active and scheduled authorizations of closed users. Optional.
- permissions: Filters results by authorization permission. Optional.
- user_name_substring: Filters results based on a full or partial user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/getprincipaluserauthorizations/.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/authorization/{{=parameters.id}}.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/getuserauthorization/.
- [Read Agent] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/authorizations/agent.
The result is extracted from:{{=response.authorizations}}.The action has the following user-defined parameters:
- userId: Required. The ID of the principal user.
- active_only: When true, return only active authorizations. Optional.
- email_substring: Filters returned user records by full email address or a substring of email address. Optional.
- include_closed_users: When true, returns active and scheduled authorizations of closed users. Optional.
- permissions: Filters results by authorization permission. Optional.
- user_name_substring: Filters results based on a full or partial user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/getagentuserauthorizations/.
- [Create] action
-
Endpoint URL address:
/users/{{=item.userId}}/authorizations.The following request parameters will be automatically processed:
-
application/json:
{{={ authorizations: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/createuserauthorizations/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/users/{{=item.userId}}/authorization/{{=item.authorizationId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/updateuserauthorization/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/authorization/{{=item.authorizationId}}.The following request parameters will be automatically processed:
-
application/json:
{{={ authorizations: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/deleteuserauthorizations/.
-
application/json:
The resource includes the fields from the userAuthorization template.
- userId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/favorite_templates.
The result is extracted from:{{=response.favoriteTemplates}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/favoritetemplates/getfavoritetemplates/.
- [Update] action
-
Endpoint URL address:
/favorite_templates.The following request parameters will be automatically processed:
-
application/json:
{{={ favoriteTemplates: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/favoritetemplates/updatefavoritetemplate/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/favorite_templates.The following request parameters will be automatically processed:
-
application/json:
{{={ favoriteTemplates: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/favoritetemplates/unfavoritetemplate/.
-
application/json:
The resource includes the fields from the favoriteTemplatesContentItem template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/identity_verification.
The result is extracted from:{{=response.identityVerification}}.The action has the following user-defined parameters:
- identity_verification_workflow_status: Filters the workflows returned according to status. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/list/.
The resource includes the fields from the accountIdentityVerificationWorkflow template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/restapi/v2.1/billing_plans.
The result is extracted from:{{=response.billingPlans}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/list/.
- [Read Single] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/restapi/v2.1/billing_plans/{{=parameters.id}}.
The result is extracted from:{{=_.union( [response.billingPlan], response.successorPlans ) }}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/get/.
- [Update] action
-
Endpoint URL address:
/billing_plan.The action has the following user-defined parameters:
- preview_billing_plan: When true, updates the account using a preview billing plan. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/update/.
The resource includes the fields from the billingPlan template.
- action
Field components:
-
Uses template:
downgradeBillingPlanInformation. - Contains the following components: purchaseEnvelopes, updateDowngradeAccountBillingPlan.
-
Uses template:
Based on resource template AccountBase.
- [Read Credit card] action
-
Endpoint URL address:
/billing_plan/credit_card.
The result is extracted from:{{=[response]}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/getcreditcard/.
- [Read Downgrade] action
-
Endpoint URL address:
/billing_plan/downgrade.
The result is extracted from:{{=[response.downgradePlanInformation]}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/getdowngraderequestbillinginfo/.
The resource includes the fields from the extensionForCreditCardInformation template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/billing_plan.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- include_credit_card_information: When true, payment information including credit card information will show in the return. Optional.
- include_downgrade_information: Optional.
- include_metadata: When true, the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information. Optional.
- include_successor_plans: When true, excludes successor information from the response. Optional.
- include_tax_exempt_id: Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/getaccountplan/.
The resource includes the fields from the accountBillingPlanResponse template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/billing_invoices.
The result is extracted from:{{=response.billingInvoices}}.
The result is paginated.The action has the following user-defined parameters:
- from_date: Specifies the date/time of the earliest invoice in the account to retrieve. Optional.
- to_date: Specifies the date/time of the latest invoice in the account to retrieve. Optional.
The following request parameters will be automatically processed:
-
$top:
{{=parameters.batchSize}} -
$skiptoken:
{{=parameters.iterator}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/invoices/list/.
- [Read Single] action
-
Endpoint URL address:
/billing_invoices/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/invoices/get/.
- [Read List past due] action
-
Endpoint URL address:
/billing_invoices_past_due.
The result is extracted from:{{=response.billingInvoices}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/invoices/listpastdue/.
The resource includes the fields from the billingInvoice template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/billing_payments.
The result is extracted from:{{=response.billingPayments}}.
The result is paginated.The action has the following user-defined parameters:
- from_date: Specifies the date/time of the earliest payment in the account to retrieve. Optional.
- to_date: Specifies the date/time of the latest payment in the account to retrieve. Optional.
The following request parameters will be automatically processed:
-
$top:
{{=parameters.batchSize}} -
$skiptoken:
{{=parameters.iterator}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/payments/list/.
- [Read Single] action
-
Endpoint URL address:
/billing_payments/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/payments/get/.
- [Create] action
-
Endpoint URL address:
/billing_payments.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/billing/payments/create/.
The resource includes the fields from the billingPaymentItem template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/bulk_send_lists.
The result is extracted from:{{=response.bulkListSummaries}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendlists/.
- [Read Single] action
-
Endpoint URL address:
/bulk_send_lists/{{=parameters.id}}.
The result is extracted from:{{=response.bulkCopies}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendlist/.
- [Create] action
-
Endpoint URL address:
/bulk_send_lists.
The result is extracted from:{{=utils.ensureArray(response)}}.The action has the following user-defined parameters:
- listId: The list ID to which the copies should be added.
- name: The list name to which the copies should be added.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ bulkCopies: batch }, parameters)}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/.
- [Update] action
-
Endpoint URL address:
/bulk_send_lists/{{=parameters.listId}}.
The result is extracted from:{{=utils.ensureArray(response)}}.The action has the following user-defined parameters:
- listId: The list ID to which the copies should be added.
- name: The list name to which the copies should be added.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ bulkCopies: batch }, parameters)}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/updatebulksendlist/.
- [Delete] action
-
Endpoint URL address:
/bulk_send_lists/{{=item.bulkSendListId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/deletebulksendlist/.
The resource includes the fields from the bulkSendingCopy template.
- action
Field components:
- Contains the following components: createBulkSendRequest, createBulkSendTestRequest.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/bulk_send_batch.
The result is extracted from:{{=response.bulkBatchSummaries}}.The action has the following user-defined parameters:
- batch_ids: A comma-separated list of batch IDs to query. Optional.
- count: The maximum number of results to return. Optional.
- from_date: The start date for a date range in UTC DateTime format. Optional.
- search_text: Use this parameter to search for specific text. Optional.
- status: The kind of results to collect. Optional.
- to_date: The end of a search date range in UTC DateTime format. Optional.
- user_id:
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatches/.
- [Update] action
-
Endpoint URL address:
/bulk_send_batch/{{=item.batchId}}/{{=item.action}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/updatebulksendbatchaction/.
The resource includes the fields from the bulkBatchSummaries template.
- status
Template: bulkSendBatchStatus. The value is gathered from
/bulk_send_batch/{{=item.batchId}}address. The value is sent to/bulk_send_batch/{{=item.batchId}}address.
Based on resource template AccountBasePagination.
- [Read Envelope] action
-
Endpoint URL address:
/bulk_send_batch/{{=parameters.bulkSendBatchId}}/envelopes.
The result is extracted from:{{=response.envelopes}}.The action has the following user-defined parameters:
- bulkSendBatchId: Required. The batch ID.
- include: When recipients, only envelopes with recipient nodes will be included in the response. Optional.
- order: The order in which to sort the results. Optional.
- order_by: The envelope attribute used to sort the results. Optional.
- search_text: Use this parameter to search for specific text. Optional.
- status: Comma-separated list of envelope statuses. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchenvelopes/.
The resource includes the fields from the envelope template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/cloud_storage/{{=parameters.serviceId}}/folders/{{=parameters.folderId}}.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- serviceId: Required. The ID of the service to access.
- folderId: Required. The ID of the folder.
- cloud_storage_folder_path: The file path to a cloud storage folder. Optional.
- cloud_storage_folderid_plain: A plain-text folder ID that you can use as an alternative to the existing folder id. Optional.
- order: The order in which to sort the results. Optional.
- order_by: The file attribute to use to sort the results. Optional.
- search_text: Use this parameter to search for specific text. Optional.
- sky_drive_skip_token:
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/.
- [Read Folder] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/cloud_storage/{{=parameters.serviceId}}/folders.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- serviceId: Required. The ID of the service to access.
- cloud_storage_folder_path: The file path to a cloud storage folder. Optional.
- order: The order in which to sort the results. Optional.
- order_by: The file attribute to use to sort the results. Optional.
- search_text: Use this parameter to search for specific text. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/.
The resource includes the fields from the externalFile template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/cloud_storage.
The result is extracted from:{{=response.storageProviders}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- redirectUrl: The URL the user is redirected to after the cloud storage provider authenticates the user. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorageproviders/list/.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/cloud_storage/{{=parameters.id}}.
The result is extracted from:{{=response.storageProviders}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- redirectUrl: The URL the user is redirected to after the cloud storage provider authenticates the user. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorageproviders/get/.
- [Create] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/cloud_storage.
The result is extracted from:{{=utils.ensureArray(response)}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
The following request parameters will be automatically processed:
-
application/json:
{{={ storageProviders: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorageproviders/create/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/cloud_storage/{{=item.serviceId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/cloudstorage/cloudstorageproviders/delete/.
The resource includes the fields from the cloudStorageProvider template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/connect.
The result is extracted from:{{=response.configurations}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/list/.
- [Read Single] action
-
Endpoint URL address:
/connect/{{=parameters.id}}.
The result is extracted from:{{=response.configurations}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/get/.
- [Create] action
-
Endpoint URL address:
/connect.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/create/.
- [Update] action
-
Endpoint URL address:
/connect.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/update/.
- [Delete] action
-
Endpoint URL address:
/connect/{{=item.connectId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/delete/.
The resource includes the fields from the connectCustomConfiguration template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/connect/{{=parameters.connectId}}/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- connectId: Required. The ID of the custom Connect configuration being accessed.
- email_substring: Filters returned user records by full email address or a substring of email address. Optional.
- list_included_users:
- status: Filters the results by user status. Optional.
- user_name_substring: Filters results based on a full or partial user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/listusers/.
- [Read All] action
-
Endpoint URL address:
/connect/{{=parameters.connectId}}/all/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- connectId: Required. The ID of the custom Connect configuration being accessed.
- email_substring: Filters returned user records by full email address or a substring of email address. Optional.
- domain_users_only:
- status: The status of the item. Optional.
- user_name_substring: Filters results based on a full or partial user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/getconnectallusers/.
The resource includes the fields from the userInfo template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/connect/oauth.
The result is extracted from:{{=[response]}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/getconnectoauthconfig/.
- [Create] action
-
Endpoint URL address:
/connect/oauth.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/createconnectoauthconfig/.
- [Update] action
-
Endpoint URL address:
/connect/oauth.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/updateconnectoauthconfig/.
- [Delete] action
-
Endpoint URL address:
/connect/oauth.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/deleteconnectoauthconfig/.
The resource includes the fields from the connectOAuthConfig template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/connect/logs.
The result is extracted from:{{=response.logs}}.The action has the following user-defined parameters:
- from_date: The start date for a date range in UTC DateTime format. Optional.
- to_date: The end of a search date range in UTC DateTime format. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/list/.
- [Read Single] action
-
Endpoint URL address:
/connect/logs/{{=parameters.id}}.The action has the following user-defined parameters:
- additional_info: When true, the response includes the `connectDebugLog` information. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/get/.
- [Read Failure] action
-
Endpoint URL address:
/connect/failures.
The result is extracted from:{{=response.failures}}.The action has the following user-defined parameters:
- from_date: The start date for a date range in UTC DateTime format. Optional.
- to_date: The end of a search date range in UTC DateTime format. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/listfailures/.
- [Delete] action
-
Endpoint URL address:
/connect/logs/{{=item.logId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/delete/.
The resource includes the fields from the connectLog template.
- action
Field components:
- Contains the following components: deleteFailure, deleteList, retryForEnvelope, retryForEnvelopes.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/tab_definitions.
The result is extracted from:{{=response.tabs}}.The action has the following user-defined parameters:
- custom_tab_only: When true, only custom tabs are returned in the response.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/list/.
- [Read Single] action
-
Endpoint URL address:
/tab_definitions/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/get/.
- [Create] action
-
Endpoint URL address:
/tab_definitions.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/create/.
- [Update] action
-
Endpoint URL address:
/tab_definitions/{{=item.customTabId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/update/.
- [Delete] action
-
Endpoint URL address:
/tab_definitions/{{=item.customTabId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/customtabs/customtabs/delete/.
The resource includes the fields from the tabMetadata template.
Based on resource template WithoutAccountIdBase.
- [Read] action
-
Endpoint URL address:
/v2.1/diagnostics/request_logs.The action has the following user-defined parameters:
- encoding: Reserved for Docusign.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/diagnostics/requestlogs/list/.
- [Read Single] action
-
Endpoint URL address:
/v2.1/diagnostics/request_logs/{{=parameters.id}}.
The result is extracted from:{{=[{ content: response['@@@raw@@@'] }] }}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/diagnostics/requestlogs/get/.
- [Delete] action
-
Endpoint URL address:
/v2.1/diagnostics/request_logs.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/diagnostics/requestlogs/delete/.
The resource includes the fields from the apiRequestLog template.
- content
Data type: DT_IMAGE
- settings
Template: diagnosticsSettingsInformation. The value is gathered from
/v2.1/diagnostics/settingsaddress. The value is sent to/v2.1/diagnostics/settingsaddress.
Based on resource template WithoutAccountIdBase.
- [Read Resource] action
-
Endpoint URL address:
/2.1/.
The result is extracted from:{{=response.resources}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/diagnostics/resources/get/.
- [Read Service] action
-
Endpoint URL address:
/service_information.
The result is extracted from:{{=[response]}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/diagnostics/services/get/.
The resource includes the fields from the serviceInformation template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/settings/bcc_email_archives.
The result is extracted from:{{=response.bccEmailArchives}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/emailarchive/bccemailarchive/list/.
- [Read Single] action
-
Endpoint URL address:
/settings/bcc_email_archives/{{=parameters.id}}.
The result is extracted from:{{=response.bccEmailArchiveHistory}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/emailarchive/bccemailarchive/get/.
- [Create] action
-
Endpoint URL address:
/settings/bcc_email_archives.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/emailarchive/bccemailarchive/create/.
- [Delete] action
-
Endpoint URL address:
/settings/bcc_email_archives/{{=item.bccEmailArchiveId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/emailarchive/bccemailarchive/delete/.
The resource includes the fields from the bccEmailArchive template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/attachments.
The result is extracted from:{{=response.attachments}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeattachments/list/.
- [Read Single] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/attachments/{{=parameters.id}}.
The result is extracted from:{{=[{ data: response['@@@raw@@@'] }] }}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeattachments/get/.
- [Create] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/attachments.
The action uses PUT method.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
The following request parameters will be automatically processed:
-
application/json:
{{={ attachments: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeattachments/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/attachments/{{=parameters.attachmentId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeattachments/update/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/attachments.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
The following request parameters will be automatically processed:
-
application/json:
{{={ attachments: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeattachments/delete/.
The resource includes the fields from the attachment template.
- data
Data type: DT_IMAGE
- envelopeId
Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/recipients/{{=parameters.recipientId}}/consumer_disclosure.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- recipientId: Required. A local reference used to map recipients to other objects, such as specific document tabs.
- langCode: The code for the signer language version of the disclosure that you want to retrieve. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures/getdefault/.
- [Read Single] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/recipients/{{=parameters.id}}/consumer_disclosure/{{=parameters.langCode}}.The action has the following user-defined parameters:
- langCode: Required. The code for the signer language version of the disclosure that you want to retrieve. Omitting will result in the default being returned.
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountconsumerdisclosures/get/.
The resource includes the fields from the consumerDisclosure template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/fields.
The result is extracted from:{{=response.documentFields}}.The action has the following user-defined parameters:
- documentId: Required. The unique ID of the document within the envelope.
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/list/.
- [Create] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documentId: Required. The unique ID of the document within the envelope.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documentId: Required. The unique ID of the document within the envelope.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/update/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documentId: Required. The unique ID of the document within the envelope.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/delete/.
The resource includes the fields from the nameValue template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents.
The result is extracted from:{{=response.envelopeDocuments}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documents_by_userid: When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
- include_docgen_formfields: Reserved for Docusign.
- include_metadata: When true, the response includes metadata that indicates which properties the sender can edit.
- include_tabs: Reserved for Docusign.
- recipient_id: Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to false for this to work.
- shared_user_id: The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/.
- [Read Single] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.id}}.
The result is extracted from:{{=[{data: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- certificate: Used only when the `documentId` parameter is the special keyword `combined`.
- documents_by_userid: When true, allows recipients to get documents by their user id.
- encoding: Reserved for Docusign.
- encrypt: When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account.
- language: Specifies the language for the Certificate of Completion in the response.
- recipient_id: Allows the sender to retrieve the documents as one of the recipients that they control.
- shared_user_id: The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.
- show_changes: When true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
- watermark: When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents/{{=item.documentId}}.The following request parameters will be automatically processed:
-
file:
{{=item.data}}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/update/.
-
file:
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents.The following request parameters will be automatically processed:
-
application/json:
{{={ documents: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/delete/.
-
application/json:
The resource includes the fields from the envelopeDocument template.
- data
Data type: DT_IMAGE
- filename
Template: ShortText.
- envelopeId
A key field. Template: ShortText.
- htmlDefinitions
The value is gathered from
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.id}}/html_definitionsaddress. The gathered value is processed with{{=response.htmlDefinitions}}expression. Field components:- An array.
-
Uses template:
documentHtmlDefinitionOriginal.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/recipients/{{=parameters.recipientId}}/document_visibility.
The result is extracted from:{{=response.documentVisibility}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- recipientId: Required. A local reference used to map recipients to other objects, such as specific document tabs.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/get/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/recipients/document_visibility.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
The following request parameters will be automatically processed:
-
application/json:
{{={documentVisibility: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/update/.
The resource includes the fields from the documentVisibility template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/email_settings.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/get/.
- [Create] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/email_settings.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/email_settings.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/update/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/email_settings.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/delete/.
The resource includes the fields from the emailSettings template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/lock.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/get/.
- [Create] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/update/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/delete/.
The resource includes the fields from the lockInformation template.
- envelopeId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/recipients/{{=item.recipientId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/delete/.
- recipientId
A key field. Template: ShortText.
- envelopeId
A key field. Template: ShortText.
- action
Field components:
-
Uses template:
recipientPreviewRequest. - Contains the following components: createEnvelopeRecipientPreview, createRecipientManualReviewView, createRecipientProofFileResourceToken.
-
Uses template:
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/envelopes.
The result is extracted from:{{=response.envelopes}}.The action has the following user-defined parameters:
- ac_status: Specifies the Authoritative Copy Status for the envelopes. Optional.
- block: When true, removes any results that match one of the provided `transaction_ids`. Optional.
- cdse_mode: Reserved for Docusign. Optional.
- custom_field: Specifies an envelope custom field name and value searched for in the envelopes. Optional.
- email: Limit results to envelopes sent by the account user with this email address. Optional.
- envelope_ids: Comma separated list of envelopeId values. Optional.
- exclude: Excludes information from the response. Optional.
- folder_ids: Returns the envelopes from specific folders. Optional.
- folder_types: Returns the envelopes from folders of a specific type. Optional.
- from_date: The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. E.g. 2017-05-02T01:44Z. Optional.
- from_to_status: The envelope status that you are checking for. Optional.
- include: Specifies additional information to return about the envelopes. Optional.
- include_purge_information: When true, information about envelopes that have been deleted is included in the response. Optional.
- intersecting_folder_ids: A comma-separated list of folders from which you want to get envelopes. Optional.
- last_queried_date: Returns envelopes that were modified prior to the specified date and time. Optional.
- order: Returns envelopes in either ascending (asc) or descending (desc) order. Optional.
- order_by: Sorts results according to a specific property. Optional.
- powerformids: A comma-separated list of PowerFormId values. Optional.
- query_budget: The time in seconds that the query should run before returning data. Optional.
- requester_date_format:
- search_mode:
- search_text: Free text search criteria that you can use to filter the list of envelopes that is returned. Optional.
- status: A comma-separated list of current envelope statuses to be included in the response. Optional.
- to_date: Specifies the date and time to stop looking for status changes. The default is the current date and time. Optional.
- transaction_ids: A comma-separated list of envelope transaction IDs. Optional.
- user_filter: Returns envelopes where the current user is the recipient, the sender, or the recipient only. Optional.
- user_id: The ID of the user who created the envelopes to be retrieved. Optional.
- user_name: Limit results to envelopes sent by the account user with this user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/.
- [Read Single] action
-
Endpoint URL address:
/envelopes/{{=parameters.id}}.The action has the following user-defined parameters:
- advanced_update: When true, envelope information can be added or modified. Optional.
- include: Specifies additional information about the envelope to return. Optional.
- include_anchor_tab_locations: When true, all tabs with anchor tab properties are included in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/.
- [Create] action
-
Endpoint URL address:
/envelopes.The action has the following user-defined parameters:
- cdse_mode: Reserved for Docusign. Optional.
- change_routing_order: When true, users can define the routing order of recipients while sending documents for signature. Optional.
- completed_documents_only: Reserved for Docusign. Optional.
- merge_roles_on_draft: When true, template roles will be merged, and empty recipients will be removed. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}.The action has the following user-defined parameters:
- advanced_update: When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. Optional.
- recycle_on_void:
- resend_envelope: When true, sends the specified envelope again. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/.
The resource includes the fields from the envelope template.
- comment
Data type: DT_IMAGE The value is gathered from
/envelopes/{{=item.envelopeId}}/comments/transcriptaddress.- docGenFormFields
The value is gathered from
/envelopes/{{=item.envelopeId}}/docGenFormFieldsaddress. The gathered value is processed with{{=response.docGenFormFields}}expression. The value is sent to/envelopes/{{=item.envelopeId}}/docGenFormFieldsaddress. Field components:- An array.
-
Uses template:
docGenFormFields.
- formData
Template: envelopeFormData. The value is gathered from
/envelopes/{{=item.envelopeId}}/form_dataaddress.- notification
Template: notification. The value is gathered from
/envelopes/{{=item.envelopeId}}/notificationaddress. The value is sent to/envelopes/{{=item.envelopeId}}/notificationaddress.- action
Field components:
-
Uses template:
documentHtmlDefinition. - Contains the following components: createDocumentResponsiveHTMLpreview, publishHistorical.
-
Uses template:
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/envelopes.
The result is extracted from:{{=response.envelopeTransactionStatuses}}.The action has the following user-defined parameters:
- ac_status: Specifies the Authoritative Copy Status for the envelopes. Optional.
- block: When true, removes any results that match one of the provided `transaction_ids`. Optional.
- cdse_mode: Reserved for Docusign. Optional.
- custom_field: Specifies an envelope custom field name and value searched for in the envelopes. Optional.
- email: Limit results to envelopes sent by the account user with this email address. Optional.
- envelope_ids: Comma separated list of envelopeId values. Optional.
- exclude: Excludes information from the response. Optional.
- folder_ids: Returns the envelopes from specific folders. Optional.
- folder_types: Returns the envelopes from folders of a specific type. Optional.
- from_date: The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. Optional.
- from_to_status: The envelope status that you are checking for. Optional.
- include: Specifies additional information to return about the envelopes. Optional.
- include_purge_information: When true, information about envelopes that have been deleted is included in the response. Optional.
- intersecting_folder_ids: A comma-separated list of folders from which you want to get envelopes. Optional.
- last_queried_date: Returns envelopes that were modified prior to the specified date and time. Optional.
- order: Returns envelopes in either ascending (asc) or descending (desc) order. Optional.
- order_by: Sorts results according to a specific property. Optional.
- powerformids: A comma-separated list of PowerFormId values. Optional.
- query_budget: The time in seconds that the query should run before returning data. Optional.
- requester_date_format:
- search_mode:
- search_text: Free text search criteria that you can use to filter the list of envelopes that is returned. Optional.
- status: A comma-separated list of current envelope statuses to be included in the response. Optional.
- to_date: Specifies the date and time to stop looking for status changes. The default is the current date and time. Optional.
- transaction_ids: A comma-separated list of envelope transaction IDs. Optional.
- user_filter: Returns envelopes where the current user is the recipient, the sender, or the recipient only. Optional.
- user_id: The ID of the user who created the envelopes to be retrieved. Optional.
- user_name: Limit results to envelopes sent by the account user with this user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/.
- [Read Single] action
-
Endpoint URL address:
/envelopes/status.
The result is extracted from:{{=response.envelopeTransactionStatuses[0]}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ envelopeIds: parameters.id } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatus/.
-
application/json:
The resource includes the fields from the envelopeTransactionStatus template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/pages.
The result is extracted from:{{=response.pages}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documentId: Required. The unique ID of the document within the envelope.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/getpageimages/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents/{{=item.documentId}}/pages/{{=item.pageNumber}}/page_image.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/rotatedocumentpage/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents/{{=item.documentId}}/pages/{{=item.pageNumber}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/deletedocumentpage/.
The resource includes the fields from the pageExtended template.
- envelopeId
A key field. Template: ShortText.
- image
Data type: DT_IMAGE The value is gathered from
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/pages/{{=item.pageNumber}}/page_imageaddress.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/templates.
The result is extracted from:{{=response.templates}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- include: Filters the results by template type.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetemplates/list/.
- [Read By document] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/documents/{{=parameters.documentId}}/templates.
The result is extracted from:{{=response.templates}}.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
- documentId: Required. The unique ID of the document within the envelope.
- include: A comma-separated list that limits the results.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetemplates/listbydocument/.
- [Create] action
-
Endpoint URL address:
/envelopes/{{=parameters.envelopeId}}/templates.The action has the following user-defined parameters:
- envelopeId: Required. The envelope's GUID.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentTemplates: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetemplates/apply/.
- [Update] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents/{{=item.documentId}}/templates.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ documentTemplates: item } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetemplates/applytodocument/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/documents/{{=item.documentId}}/templates/{{=item.templateId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetemplates/delete/.
The resource includes the fields from the templateSummary template.
- envelopeId
A key field. Template: ShortText.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/envelopes/transfer_rules.
The result is extracted from:{{=response.envelopeTransferRules}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/get/.
- [Create] action
-
Endpoint URL address:
/envelopes/transfer_rules.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/create/.
- [Update] action
-
Endpoint URL address:
/envelopes/transfer_rules/{{=item.envelopeTransferRuleId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/updateenvelopetransferrule/.
- [Delete] action
-
Endpoint URL address:
/envelopes/transfer_rules/{{=item.envelopeTransferRuleId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/delete/.
The resource includes the fields from the envelopeTransferRule template.
Based on resource template AccountBase.
- [Create] action
-
Endpoint URL address:
/.
- [Delete] action
-
Endpoint URL address:
/envelopes/{{=item.envelopeId}}/views/correct.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/deleteenvelopecorrectview/.
The resource includes the fields from the correctViewRequest template.
- action
Field components:
-
Uses template:
consoleViewRequest. - Contains the following components: createConsole, createCorrect, createEdit, createRecipient, createSender, createSharedRecipient.
-
Uses template:
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/workflow/steps/{{=parameters.workflowStepId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- workflowStepId: Required. The ID of the workflow step.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowstepdefinition/.
- [Create] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/steps.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/createenvelopeworkflowstepdefinition/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/steps/{{=item.workflowStepId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopeworkflowstepdefinition/.
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/steps/{{=item.workflowStepId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowstepdefinition/.
The resource includes the fields from the workflowStep template.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/workflow/steps/{{=parameters.workflowStepId}}/delayedRouting.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- workflowStepId: Required. The ID of the workflow step.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopedelayedroutingdefinition/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/steps/{{=item.workflowStepId}}/delayedRouting.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopedelayedroutingdefinition/.
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/steps/{{=item.workflowStepId}}/delayedRouting.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopedelayedroutingdefinition/.
The resource includes the fields from the delayedRouting template.
- workflowStepId
A key field. Template: ShortText.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/workflow/scheduledSending.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopescheduledsendingdefinition/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/scheduledSending.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopescheduledsendingdefinition/.
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow/scheduledSending.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deletetemplatescheduledsendingdefinition/.
The resource includes the fields from the scheduledSending template.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/workflow.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowdefinition/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopeworkflowdefinition/.
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/workflow.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowdefinition/.
The resource includes the fields from the workflow template.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/documents/{{=parameters.documentId}}/tabs.
The result is extracted from:{{=Docusign.concatTabs(response)}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- documentId: Required. The unique ID of the document within the envelope.
- include_metadata: When true, the response includes metadata indicating which properties are editable. Optional.
- page_numbers: Filters for tabs that occur on the pages that you specify. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/get/.
- [Read Page] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/documents/{{=parameters.documentId}}/pages/{{=parameters.pageNumber}}/tabs.
The result is extracted from:{{=Docusign.concatTabs(response)}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- documentId: Required. The unique ID of the document within the envelope.
- pageNumber: Required. The page number being accessed.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/getbypage/.
- [Create] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/documents/{{=item.documentId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/documents/{{=item.documentId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/update/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/documents/{{=item.documentId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/delete/.
-
application/json:
The resource includes the fields from the tab template.
- type
Template: ShortText.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/recipients/{{=parameters.recipientId}}/tabs.
The result is extracted from:{{=Docusign.concatTabs(response)}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- recipientId: Required. A local reference used to map recipients to other objects, such as specific document tabs.
- include_anchor_tab_locations: When true, all tabs with anchor tab properties are included in the response. Optional.
- include_metadata: When true, the response includes metadata indicating which properties are editable. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/list/.
- [Create] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/recipients/{{=item.recipientId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/recipients/{{=item.recipientId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/update/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/recipients/{{=item.recipientId}}/tabs.The following request parameters will be automatically processed:
-
application/json:
{{={ [item.type]: [item] } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/delete/.
-
application/json:
The resource includes the fields from the tab template.
- recipientId
A key field. Template: ShortText.
- type
Template: ShortText.
- entityType
A key field. Template: ShortText.
- entityId
A key field. Template: ShortText.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.agents}}.
- [Create] action
-
The result is extracted from:{{=response.agents}}.The following request parameters will be automatically processed:
-
application/json:
{{={ agents: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.agents}}.The following request parameters will be automatically processed:
-
application/json:
{{={ agents: [ item ] } }}
-
application/json:
The resource includes the fields from the agent template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.carbonCopies}}.
- [Create] action
-
The result is extracted from:{{=response.carbonCopies}}.The following request parameters will be automatically processed:
-
application/json:
{{={ carbonCopies: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.carbonCopies}}.The following request parameters will be automatically processed:
-
application/json:
{{={ carbonCopies: [ item ] } }}
-
application/json:
The resource includes the fields from the carbonCopy template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.inPersonSigners}}.
- [Create] action
-
The result is extracted from:{{=response.inPersonSigners}}.The following request parameters will be automatically processed:
-
application/json:
{{={ inPersonSigners: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.inPersonSigners}}.The following request parameters will be automatically processed:
-
application/json:
{{={ inPersonSigners: [ item ] } }}
-
application/json:
The resource includes the fields from the inPersonSigner template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.certifiedDeliveries}}.
- [Create] action
-
The result is extracted from:{{=response.certifiedDeliveries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ certifiedDeliveries: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.certifiedDeliveries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ certifiedDeliveries: [ item ] } }}
-
application/json:
The resource includes the fields from the certifiedDelivery template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.editors}}.
- [Create] action
-
The result is extracted from:{{=response.editors}}.The following request parameters will be automatically processed:
-
application/json:
{{={ editors: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.editors}}.The following request parameters will be automatically processed:
-
application/json:
{{={ editors: [ item ] } }}
-
application/json:
The resource includes the fields from the editor template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.intermediaries}}.
- [Create] action
-
The result is extracted from:{{=response.intermediaries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ intermediaries: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.intermediaries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ intermediaries: [ item ] } }}
-
application/json:
The resource includes the fields from the intermediary template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.notaries}}.
- [Create] action
-
The result is extracted from:{{=response.notaries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ notaries: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.notaries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ notaries: [ item ] } }}
-
application/json:
The resource includes the fields from the notaryRecipient template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.participants}}.
- [Create] action
-
The result is extracted from:{{=response.participants}}.The following request parameters will be automatically processed:
-
application/json:
{{={ participants: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.participants}}.The following request parameters will be automatically processed:
-
application/json:
{{={ participants: [ item ] } }}
-
application/json:
The resource includes the fields from the participant template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.seals}}.
- [Create] action
-
The result is extracted from:{{=response.seals}}.The following request parameters will be automatically processed:
-
application/json:
{{={ seals: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.seals}}.The following request parameters will be automatically processed:
-
application/json:
{{={ seals: [ item ] } }}
-
application/json:
The resource includes the fields from the sealSign template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.signers}}.
- [Create] action
-
The result is extracted from:{{=response.signers}}.The following request parameters will be automatically processed:
-
application/json:
{{={ signers: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.signers}}.The following request parameters will be automatically processed:
-
application/json:
{{={ signers: [ item ] } }}
-
application/json:
The resource includes the fields from the signer template.
Based on resource template RecipientTemplate.
- [Read] action
-
The result is extracted from:{{=response.witnesses}}.
- [Create] action
-
The result is extracted from:{{=response.witnesses}}.The following request parameters will be automatically processed:
-
application/json:
{{={ witnesses: [ item ] } }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.witnesses}}.The following request parameters will be automatically processed:
-
application/json:
{{={ witnesses: [ item ] } }}
-
application/json:
The resource includes the fields from the witness template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/custom_fields.
The result is extracted from:{{=_.union(response.textCustomFields, response.listCustomFields)}}.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list/.
- [Create] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/custom_fields.The action has the following user-defined parameters:
- fieldType: Required. The field array type, possible values: listCustomFields, textCustomFields.
The following request parameters will be automatically processed:
-
application/json:
{{={ [parameters.fieldType]: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/custom_fields.The action has the following user-defined parameters:
- fieldType: Required. The field array type, possible values: listCustomFields, textCustomFields.
The following request parameters will be automatically processed:
-
application/json:
{{={ [parameters.fieldType]: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/update/.
- [Delete] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/custom_fields.The action has the following user-defined parameters:
- fieldType: Required. The field array type, possible values: listCustomFields, textCustomFields.
The following request parameters will be automatically processed:
-
application/json:
{{={ [parameters.fieldType]: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/delete/.
The resource includes the fields from the listCustomField template.
- entityId
A key field. Template: ShortText.
- entityType
A key field. Template: ShortText.
Based on resource template WithoutAccountIdBasePagination.
- [Read] action
-
Endpoint URL address:
/v2.1/current_user/notary/journals.
The result is extracted from:{{=response.notaryJournals}}.The action has the following user-defined parameters:
- search_text: Use this parameter to search for specific text. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/notaryjournals/list/.
The resource includes the fields from the notaryJournal template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/folders.
The result is extracted from:{{=response.folders}}.The action has the following user-defined parameters:
- include: A comma-separated list of folder types to include in the response. Optional.
- include_items: Indicates whether folder items are included in the response. If this parameter is omitted, the default is false. Optional.
- sub_folder_depth: If missing or any value other than `-1`, the returned list contains only the top-level folders. Optional.
- template: This parameter is deprecated as of version 2.1. Use `include` instead. Optional.
- user_filter: Narrows down the resulting folder list. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/list/.
- [Read Single] action
-
Endpoint URL address:
/folders/{{=parameters.id}}.
The result is extracted from:{{=response.folders[0].folderItems ? (response.folders[0].folders || []).concat(response.folders[0].folderItems) : response.folders[0].folders}}.The action has the following user-defined parameters:
- from_date: Reserved for Docusign. Optional.
- include_items: Indicates whether folder items are included in the response. If this parameter is omitted, the default is false. Optional.
- owner_email: Reserved for Docusign. Optional.
- owner_name: Reserved for Docusign. Optional.
- search_text: Reserved for Docusign. Optional.
- status: Reserved for Docusign. Optional.
- to_date: Reserved for Docusign. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/listitems/.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.folderId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/moveenvelopes/.
The resource includes the fields from the T_folderAndEnvelope template.
Based on resource template WithoutAccountIdBase.
- [Read] action
-
Endpoint URL address:
/v2.1/current_user/notary.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- include_jurisdictions: When true, the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notary/getnotary/.
- [Create] action
-
Endpoint URL address:
/v2.1/current_user/notary.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notary/createnotary/.
- [Update] action
-
Endpoint URL address:
/v2.1/current_user/notary.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notary/updatenotary/.
The resource includes the fields from the notaryResult template.
Based on resource template WithoutAccountIdBasePagination.
- [Read] action
-
Endpoint URL address:
/v2.1/current_user/notary/jurisdictions.
The result is extracted from:{{=response.notaryJurisdictions}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notaryjurisdiction/getnotaryjurisdictions/.
- [Read Single] action
-
Endpoint URL address:
/v2.1/current_user/notary/jurisdictions/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notaryjurisdiction/getnotaryjurisdiction/.
- [Create] action
-
Endpoint URL address:
/v2.1/current_user/notary/jurisdictions.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notaryjurisdiction/createnotaryjurisdictions/.
- [Update] action
-
Endpoint URL address:
/v2.1/current_user/notary/jurisdictions/{{=item.jurisdictionId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notaryjurisdiction/updatenotaryjurisdiction/.
- [Delete] action
-
Endpoint URL address:
/v2.1/current_user/notary/jurisdictions/{{=item.jurisdictionId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/notary/notaryjurisdiction/deletenotaryjurisdiction/.
The resource includes the fields from the notaryJurisdiction template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/payment_gateway_accounts.
The result is extracted from:{{=response.paymentGatewayAccounts}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/payments/paymentgatewayaccounts/list/.
The resource includes the fields from the paymentGatewayAccount template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/powerforms/{{=parameters.powerFormId}}/form_data.
The result is extracted from:{{=response.envelopes}}.The action has the following user-defined parameters:
- powerFormId: Required. The ID of the PowerForm.
- data_layout: The layout in which to return the PowerForm data. Optional.
- from_date: The start date for a date range in UTC DateTime format. Optional.
- to_date: The end date of a date range in UTC DateTime format. The default value is `UtcNow`. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerformdata/list/.
The resource includes the fields from the powerFormFormDataEnvelope template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/powerforms.
The result is extracted from:{{=response.powerForms}}.The action has the following user-defined parameters:
- from_date: The start date for a date range. Optional.
- order: The order in which to sort the results. Optional.
- order_by: The file attribute to use to sort the results. Optional.
- search_fields: A comma-separated list of additional properties to include in a search. Optional.
- search_text: Use this parameter to search for specific text. Optional.
- to_date: The end date for a date range. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/list/.
- [Read Single] action
-
Endpoint URL address:
/powerforms/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/get/.
- [Read Sender] action
-
Endpoint URL address:
/powerforms/senders.
The result is extracted from:{{=response.powerFormSenders}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/listsenders/.
- [Create] action
-
Endpoint URL address:
/powerforms.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/create/.
- [Update] action
-
Endpoint URL address:
/powerforms/{{=item.powerFormId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/update/.
- [Delete] action
-
Endpoint URL address:
/powerforms/{{=item.powerFormId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/powerforms/powerforms/delete/.
The resource includes the fields from the powerForm template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/signing_groups.
The result is extracted from:{{=response.groups}}.The action has the following user-defined parameters:
- group_type: Filters by the type of signing group. Optional.
- include_users: When true, the response includes the signing group members. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroups/list/.
- [Read Single] action
-
Endpoint URL address:
/signing_groups/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroups/get/.
- [Create] action
-
Endpoint URL address:
/signing_groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroups/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/signing_groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroups/update/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/signing_groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroups/delete/.
-
application/json:
The resource includes the fields from the signingGroup template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/signing_groups/{{=parameters.signingGroupId}}/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- signingGroupId: Required. The ID of the signing group.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroupusers/list/.
- [Update] action
-
Endpoint URL address:
/signing_groups/{{=parameters.signingGroupId}}/users.The action has the following user-defined parameters:
- signingGroupId: Required. The ID of the signing group.
The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroupusers/update/.
- [Delete] action
-
Endpoint URL address:
/signing_groups/{{=parameters.signingGroupId}}/users.The action has the following user-defined parameters:
- signingGroupId: Required. The ID of the signing group.
The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/signinggroups/signinggroupusers/delete/.
The resource includes the fields from the signingGroupUser template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/fields.
The result is extracted from:{{=response.documentFields}}.The action has the following user-defined parameters:
- documentId: Required. The unique ID of the document within the envelope.
- templateId: Required. The ID of the template.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentfields/list/.
- [Create] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- documentId: Required. The unique ID of the document within the envelope.
- templateId: Required. The ID of the template.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentfields/create/.
- [Update] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- documentId: Required. The unique ID of the document within the envelope.
- templateId: Required. The ID of the template.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentfields/update/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/fields.The action has the following user-defined parameters:
- documentId: Required. The unique ID of the document within the envelope.
- templateId: Required. The ID of the template.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentFields: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentfields/delete/.
The resource includes the fields from the nameValue template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/recipients/{{=parameters.recipientId}}/document_visibility.
The result is extracted from:{{=response.documentVisibility}}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
- recipientId: Required. A local reference used to map recipients to other objects, such as specific document tabs.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentvisibility/get/.
- [Update] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/recipients/document_visibility.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
The following request parameters will be automatically processed:
-
application/json:
{{={ documentVisibility: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocumentvisibility/updatelist/.
The resource includes the fields from the documentVisibility template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/lock.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/get/.
- [Create] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/create/.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/update/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/lock.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/delete/.
The resource includes the fields from the lockInformation template.
- templateId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/recipients/{{=item.recipientId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templaterecipients/delete/.
- action
Field components:
-
Uses template:
recipientPreviewRequest. - Contains the following components: createTemplateRecipientPreview.
-
Uses template:
- templateId
A key field. Template: ShortText.
- recipientId
A key field. Template: ShortText.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/templates.
The result is extracted from:{{=response.envelopeTemplates}}.The action has the following user-defined parameters:
- created_from_date: Lists templates created on or after this date. Optional.
- created_to_date: Lists templates created before this date. Optional.
- folder_ids: A comma-separated list of folder ID GUIDs. Optional.
- folder_types: The type of folder to return templates for. Optional.
- from_date: Start of the search date range. Optional.
- include: A comma-separated list of additional template attributes to include in the response. Optional.
- is_deleted_template_only: When true, retrieves templates that have been permanently deleted. The default is false. Optional.
- is_download: When true, downloads the templates listed in template_ids as a collection of JSON definitions in a single zip file. Optional.
- modified_from_date: Lists templates modified on or after this date. Optional.
- modified_to_date: Lists templates modified before this date. Optional.
- order: Specifies the sort order of the search results. Optional.
- order_by: Specifies how the search results are listed. Optional.
- search_fields: A comma-separated list of additional template properties to search. Optional.
- search_text: The text to use to search the names of templates. Optional.
- shared_by_me: When true, the response only includes templates shared by the user. Optional.
- template_ids: A comma-separated list of template IDs to download. Optional.
- to_date: The end of a search date range in UTC DateTime format. Optional.
- used_from_date: Start of the search date range. Optional.
- used_to_date: End of the search date range. Optional.
- user_filter: Filters the templates in the response. Optional.
- user_id: The ID of the user. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/list/.
- [Read Single] action
-
Endpoint URL address:
/templates/{{=parameters.id}}.The action has the following user-defined parameters:
- advanced_update: When true, envelope information can be added or modified. Optional.
- include: Specifies additional information about the envelope to return. Optional.
- include_anchor_tab_locations: When true, all tabs with anchor tab properties are included in the response. The default value is false. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/get/.
- [Create] action
-
Endpoint URL address:
/templates.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/update/.
The resource includes the fields from the envelopeTemplate template.
- notification
Template: notification. The value is gathered from
/templates/{{=item.templateId}}/notificationaddress. The value is sent to/templates/{{=item.templateId}}/notificationaddress. Field components:-
Uses template:
ShortText. - Contains the following components: password.
-
Uses template:
- action
Field components:
-
Uses template:
documentHtmlDefinition. - Contains the following components: createDocumentResponsiveHTMLpreview.
-
Uses template:
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/pages.
The result is extracted from:{{=response.pages }}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
- documentId: Required. The unique ID of the document within the envelope.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/getpageimages/.
- [Read Image] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.documentId}}/pages/{{=parameters.pageNumber}}/page_image.
The result is extracted from:{{=[{image: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
- documentId: Required. The unique ID of the document within the envelope.
- pageNumber: Required. The page number being accessed.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/getdocumentpageimage/.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/documents/{{=item.documentId}}/pages/{{=item.pageNumber}}/page_image.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/rotatedocumentpage/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/documents/{{=item.documentId}}/pages/{{=item.pageNumber}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/deletedocumentpage/.
The resource includes the fields from the pageExtended template.
- image
Data type: DT_IMAGE
- templateId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/{{=item.templatePart}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/updategroupshare/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/{{=item.templatePart}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/deletegroupshare/.
The resource includes the fields from the group template.
- templateId
A key field. Template: ShortText.
- templatePart
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Create] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/views/edit.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templateviews/createedit/.
The resource includes the fields from the templateViewRequest template.
- templateId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents.
The result is extracted from:{{=response.templateDocuments}}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
- include_tabs: Reserved for Docusign.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/list/.
- [Read Single] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/documents/{{=parameters.id}}.
The result is extracted from:{{=[{data: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- templateId: Required. The ID of the template.
- encrypt: When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. Optional.
- file_type: Specifies the file type. Optional.
- show_changes: When true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/get/.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/documents/{{=item.documentId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/documents.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/delete/.
The resource includes the fields from the envelopeDocument template.
- data
Data type: DT_IMAGE
- filename
Template: ShortText.
- templateId
A key field. Template: ShortText.
- htmlDefinitions
The value is gathered from
/templates/{{=parameters.envelopeId}}/documents/{{=parameters.id}}/html_definitionsaddress. The gathered value is processed with{{=response.htmlDefinitions}}expression. Field components:- An array.
-
Uses template:
documentHtmlDefinitionOriginal.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/brands.
The result is extracted from:{{=response.brands}}.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupbrands/get/.
- [Update] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/brands.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
The following request parameters will be automatically processed:
-
application/json:
{{={ brands: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupbrands/update/.
- [Delete] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/brands.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
The following request parameters will be automatically processed:
-
application/json:
{{={ brands: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupbrands/delete/.
The resource includes the fields from the brand template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/groups.
The result is extracted from:{{=response.groups}}.The action has the following user-defined parameters:
- group_type: The type of group to return. Optional.
- include_usercount: When true, every group returned in the response includes a `userCount` property that contains the total number of users in the group. Optional.
- search_text: Filters the results of a GET request based on the text that you specify. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/list/.
- [Create] action
-
Endpoint URL address:
/groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupbrands/update/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/groups.The following request parameters will be automatically processed:
-
application/json:
{{={ groups: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupbrands/delete/.
-
application/json:
The resource includes the fields from the group template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupusers/list/.
- [Update] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/users.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupusers/update/.
- [Delete] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/users.The action has the following user-defined parameters:
- groupId: Required. The ID of the group.
The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groupusers/delete/.
The resource includes the fields from the userInfo template.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/contacts/{{=parameters.contactId}}.
The result is extracted from:{{=response.contacts}}.The action has the following user-defined parameters:
- contactId: Required. The ID of a contact person in the account's address book.
- cloud_provider: The cloud provider from which to retrieve the contacts. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/get/.
- [Create] action
-
Endpoint URL address:
/contacts.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/update/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contacts.The following request parameters will be automatically processed:
-
application/json:
{{={ contacts: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/deletelist/.
-
application/json:
The resource includes the fields from the contact template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/custom_settings.
The result is extracted from:{{=response.customSettings}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usercustomsettings/list/.
- [Update] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/custom_settings.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
The following request parameters will be automatically processed:
-
application/json:
{{={ customSettings: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usercustomsettings/update/.
- [Delete] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/custom_settings.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
The following request parameters will be automatically processed:
-
application/json:
{{={ customSettings: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usercustomsettings/delete/.
The resource includes the fields from the nameValue template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/profile.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/userprofiles/get/.
- [Update] action
-
Endpoint URL address:
/users/{{=item.userId}}/profile.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/userprofiles/update/.
The resource includes the fields from the userProfile template.
- userId
A key field. Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/profile/image.
The result is extracted from:{{=[{image: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- encoding: Reserved for Docusign.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/getprofileimage/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/profile/image.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/deleteprofileimage/.
- image
Data type: DT_IMAGE
- userId
Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/settings.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/getsettings/.
- [Update] action
-
Endpoint URL address:
/users/{{=item.userId}}/settings.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/updatesettings/.
The resource includes the fields from the userSettingsInformation template.
- userId
A key field. Template: ShortText.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- additional_info: When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false. Optional.
- alternate_admins_only: When true, returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is false. Optional.
- domain_users_only: When true, return only users in domains claimed by your organization. The default value is false. Optional.
- email: Filters results based on the email address associated with the user that you want to return. Optional.
- email_substring: Filters results based on a fragment of an email address. For example, you could enter `gmail.com` to return all users who have Gmail addresses. Optional.
- group_id: Filters results based on one or more group IDs. Optional.
- include_usersettings_for_csv: When true, the response includes the `userSettings` object data in CSV format. Optional.
- login_status: When true, the response includes the login status of each user. Optional.
- not_group_id: Return user records excluding the specified group IDs. Optional.
- status: Filters results by user account status. Optional.
- user_name_substring: Filters the user records returned by the user name or a sub-string of user name. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/list/.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.id}}.The action has the following user-defined parameters:
- additional_info: Setting this parameter has no effect in this operation. Optional.
- email: Setting this parameter has no effect in this operation. Optional.
- include_license:
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/get/.
- [Create] action
-
Endpoint URL address:
/users.The following request parameters will be automatically processed:
-
application/json:
{{={ newUsers: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/create/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/users.The action has the following user-defined parameters:
- allow_all_languages:
The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/updatelist/.
- [Delete] action
-
Endpoint URL address:
/users.The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/users/delete/.
-
application/json:
The resource includes the fields from the userInformation template.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/signatures.
The result is extracted from:{{=response.userSignatures}}.The action has the following user-defined parameters:
- stamp_type: The type of the stamps to return. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/list/.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/signatures/{{=parameters.id}}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/get/.
- [Create] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/signatures.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
The following request parameters will be automatically processed:
-
application/json:
{{={ userSignatures: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/create/.
- [Update] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/signatures.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
The following request parameters will be automatically processed:
-
application/json:
{{={ userSignatures: batch } }}
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/updatelist/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/signatures/{{=item.signatureId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/delete/.
The resource includes the fields from the userSignature template.
- userId
Template: ShortText.
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/signatures/{{=parameters.signatureId}}{{=parameters.imageType}}.
The result is extracted from:{{=[{image: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- userId: Required. The ID of the user to access.
- signatureId: Required. The ID of the account stamp.
- imageType: Required. Specificies the type of image.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/getimage/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/signatures/{{=item.signatureId}}{{=item.imageType}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/users/usersignatures/deleteimage/.
- image
Data type: DT_IMAGE
- userId
Template: ShortText.
- signatureId
Template: ShortText.
- imageType
Template: ShortText.
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/workspaces/{{=parameters.workspaceId}}/folders/{{=parameters.folderId}}.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- folderId: Required. The ID of the folder.
- workspaceId: Required. The ID of the workspace.
- include_files: When true, the response includes file information (in addition to folder information). Optional.
- include_thumbnails: When true, the response returns thumbnails. Optional.
- include_user_detail: When true, the response includes extended details about the user. Optional.
- workspace_user_id: If set, the response only includes results associated with the userId that you specify. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/listfolderitems/.
- [Read File] action
-
Endpoint URL address:
/workspaces/{{=parameters.workspaceId}}/folders/{{=parameters.folderId}}/files/{{=parameters.fileId}}.
The result is extracted from:{{=[{file: response['@@@raw@@@']}] }}.The action has the following user-defined parameters:
- fileId: Required. The ID of the file.
- folderId: Required. The ID of the folder.
- workspaceId: Required. The ID of the workspace.
- is_download: When true, the `Content-Disposition` header is set in the response. Optional.
- pdf_version: When true the file is returned in PDF format. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaceitems/getfile/.
The resource includes the fields from the workspaceItem template.
- file
Data type: DT_IMAGE
Based on resource template AccountBasePagination.
- [Read] action
-
Endpoint URL address:
/workspaces.
The result is extracted from:{{=response.workspaces}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/list/.
- [Read Single] action
-
Endpoint URL address:
/workspaces/{{=parameters.id}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/get/.
- [Create] action
-
Endpoint URL address:
/workspaces.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/create/.
- [Update] action
-
Endpoint URL address:
/workspaces/{{=item.workspaceId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/update/.
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.workspaceId}}.Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/workspaces/workspaces/delete/.
The resource includes the fields from the workspace template.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Read Single] action
-
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify record identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Upsert] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
Based on resource template AccountBase.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
count:
{{=parameters.batchSize}} -
start_position:
{{=parameters.iterator}}
-
count:
Based on resource template Base.
Based on resource template WithoutAccountIdBase.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
count:
{{=parameters.batchSize}} -
start_position:
{{=parameters.iterator}}
-
count:
Based on resource template AccountBase.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entityType}}/{{=parameters.entityId}}/recipients.The action has the following user-defined parameters:
- entityType: Required. Select entity type.
- entityId: Required. Specify entity identifier.
- include_anchor_tab_locations: When true and `include_tabs` value is set to true, all tabs with anchor tab properties are included in the response. Optional.
- include_extended: When true, the extended properties are included in the response. Optional.
- include_metadata: Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates). Optional.
- include_tabs: When true, the tab information associated with the recipient is included in the response. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/.
- [Create] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/recipients.The action has the following user-defined parameters:
- resend_envelope: When true, resends the envelope to the recipients that you specify in the request body. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/.
- [Update] action
-
Endpoint URL address:
/{{=item.entityType}}/{{=item.entityId}}/recipients.The action has the following user-defined parameters:
- combine_same_order_recipients: When true, recipients are combined or merged with matching recipients. Optional.
- resend_envelope: When true, resends the envelope to the recipients that you specify in the request body. Optional.
- offline_signing: Indicates if offline signing is enabled for the recipient when a network connection is unavailable. Optional.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/.
- entityId
A key field. Template: ShortText.
- entityType
A key field. Template: ShortText.
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value).toISOString()}}expression.- Date
Data type: DT_DBDATE
- ActionT
- settingsMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: is21CFRPart11, options, rights, uiHint, uiOrder, uiType.
-
Uses template:
- accessCodeFormat
Field components:
-
Uses template:
ShortText. - Contains the following components: formatRequired, formatRequiredMetadata, letterRequired, letterRequiredMetadata, minimumLength, minimumLengthMetadata, numberRequired, numberRequiredMetadata, specialCharacterRequired, specialCharacterRequiredMetadata.
-
Uses template:
- province
Field components:
-
Uses template:
ShortText. - Contains the following components: isoCode, name.
-
Uses template:
- country
Field components:
-
Uses template:
ShortText. - Contains the following components: isoCode, name, provinces, provinceValidated.
-
Uses template:
- accountAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: address1, address2, city, country, email, fax, firstName, lastName, phone, postalCode, state, supportedCountries.
-
Uses template:
- addOn
Field components:
-
Uses template:
ShortText. - Contains the following components: id, active, addOnId, name.
-
Uses template:
- downgradePlanUpdateResponse
Field components:
-
Uses template:
ShortText. - Contains the following components: accountPaymentMethod, discountApplied, downgradeEffectiveDate, downgradePaymentCycle, downgradePlanId, downgradePlanName, downgradeRequestStatus, message, productId, promoCode, saleDiscount, saleDiscountPeriods, saleDiscountType.
-
Uses template:
- currencyFeatureSetPrice
Field components:
-
Uses template:
ShortText. - Contains the following components: currencyCode, currencySymbol, envelopeFee, fixedFee, seatFee.
-
Uses template:
- featureSet
Field components:
-
Uses template:
currencyFeatureSetPrice. - Contains the following components: currencyFeatureSetPrices, envelopeFee, featureSetId, fixedFee, is21CFRPart11, isActive, isEnabled, name, seatFee.
-
Uses template:
- seatDiscount
Field components:
-
Uses template:
ShortText. - Contains the following components: beginSeatCount, discountPercent, endSeatCount.
-
Uses template:
- accountBillingPlan
Field components:
-
Uses template:
addOn. - Contains the following components: addOns, appStoreReceiptExpirationDate, appStoreReceiptPurchaseDate, canCancelRenewal, canUpgrade, currencyCode, downgradePlanInformation, enableSupport, includedSeats, incrementalSeats, isDowngrade, notificationType, otherDiscountPercent, paymentCycle, paymentMethod, perSeatPrice, planClassification, planFeatureSets, planId, planName, planStartDate, productId, renewalDate, renewalStatus, seatDiscounts, subscriptionStartDate, supportIncidentFee, supportPlanFee, taxExemptId.
-
Uses template:
- addressInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: address1, address2, city, country, fax, phone, postalCode, stateOrProvince, zipPlus4.
-
Uses template:
- creditCardInformation
Field components:
-
Uses template:
addressInformation. - Contains the following components: address, cardLastDigits, cardNumber, cardType, cvNumber, expirationMonth, expirationYear, nameOnCard, tokenizedCard.
-
Uses template:
- directDebitProcessorInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: bankBranchCode, bankCheckDigit, bankCode, bankName, bankTransferAccountName, bankTransferAccountNumber, bankTransferType, country, email, firstName, iBAN, lastName.
-
Uses template:
- downgradeRequestInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: downgradeRequestCreation, downgradeRequestProductId, downgradeRequestStatus.
-
Uses template:
- billingEntityInformationResponse
Field components:
-
Uses template:
ShortText. - Contains the following components: billingProfile, entityName, externalEntityId, isExternallyBilled.
-
Uses template:
- paymentProcessorInformation
Field components:
-
Uses template:
addressInformation. - Contains the following components: address, billingAgreementId, email.
-
Uses template:
- referralInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: advertisementId, enableSupport, externalOrgId, groupMemberId, idType, includedSeats, industry, planStartMonth, promoCode, publisherId, referralCode, referrerName, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPercent, saleDiscountPeriods, saleDiscountSeatPriceOverride, shopperId.
-
Uses template:
- appStoreReceipt
Field components:
-
Uses template:
ShortText. - Contains the following components: downgradeProductId, isDowngradeCancellation, productId, receiptData.
-
Uses template:
- recipientDomain
Field components:
-
Uses template:
ShortText. - Contains the following components: active, domainCode, domainName, recipientDomainId.
-
Uses template:
- planInformation
Field components:
-
Uses template:
addOn. - Contains the following components: addOns, currencyCode, freeTrialDaysOverride, planFeatureSets, planId, recipientDomains.
-
Uses template:
- appStoreProduct
Field components:
-
Uses template:
ShortText. - Contains the following components: marketPlace, productId.
-
Uses template:
- creditCardTypes
Field components:
-
Uses template:
LongText. - Contains the following components: cardTypes.
-
Uses template:
- currencyPlanPrice
Field components:
-
Uses template:
ShortText. - Contains the following components: currencyCode, currencySymbol, perSeatPrice, supportedCardTypes, supportIncidentFee, supportPlanFee.
-
Uses template:
- billingPlan
Field components:
-
Uses template:
appStoreReceipt. - Contains the following components: appStoreReceipt, billingAddress, creditcardinformation, directDebitProcessorInformation, enablePreAuth, enableSupport, includedSeats, incrementalSeats, paymentMethod, paymentProcessor, paymentProcessorInformation, planInformation, processPayment, referralInformation, renewalStatus, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPercent, saleDiscountPeriods, saleDiscountSeatPriceOverride, taxExemptId, appStoreProducts, currencyPlanPrices, otherDiscountPercent, paymentCycle, perSeatPrice, planClassification, planFeatureSets, planId, planName, seatDiscounts, supportIncidentFee, supportPlanFee.
-
Uses template:
- accountBillingPlanResponse
Field components:
-
Uses template:
accountAddress. - Contains the following components: billingAddress, billingAddressIsCreditCardAddress, billingPlan, creditCardInformation, directDebitProcessorInformation, downgradePlanInformation, downgradeRequestInformation, entityInformation, paymentMethod, paymentProcessorInformation, referralInformation, successorPlans, taxExemptId.
-
Uses template:
- nameValue
Field components:
-
Uses template:
ShortText. - Contains the following components: name, originalValue, value.
-
Uses template:
- brandEmailContent
Field components:
-
Uses template:
ShortText. - Contains the following components: content, emailContentType, emailToLink, linkText.
-
Uses template:
- brandLink
Field components:
-
Uses template:
ShortText. - Contains the following components: linkText, linkType, showLink, urlOrMailTo.
-
Uses template:
- brandLogos
Field components:
-
Uses template:
ShortText. - Contains the following components: email, primary, secondary.
-
Uses template:
- brandResourceUrls
Field components:
-
Uses template:
ShortText. - Contains the following components: email, sending, signing, signingCaptive.
-
Uses template:
- brand
-
Field components:
-
Uses template:
ShortText. - Contains the following components: brandId, brandCompany, brandLanguages, brandName, colors, defaultBrandLanguage, emailContent, isOrganizationBrand, isOverridingCompanyName, isSendingDefault, isSigningDefault, landingPages, links, logos, organizationBrandLogo, resources.
Documentation: https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/get/#schema_200_brand_brand.
-
Uses template:
- AccountBrands
Field components:
-
Uses template:
brand. - Contains the following components: brands, recipientBrandIdDefault, senderBrandIdDefault.
-
Uses template:
- accountIdentityInputOption
Field components:
-
Uses template:
ShortText. - Contains the following components: isRequired, optionName, valueType.
-
Uses template:
- accountIdentityVerificationWorkflow
Field components:
-
Uses template:
ShortText. - Contains the following components: defaultDescription, defaultName, inputOptions, isDisabled, ownerType, signatureProvider, workflowId, workflowLabel, workflowResourceKey.
-
Uses template:
- accountInformation
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: accountIdGuid, accountName, allowTransactionRooms, billingPeriodDaysRemaining, billingPeriodEndDate, billingPeriodEnvelopesAllowed, billingPeriodEnvelopesSent, billingPeriodStartDate, billingProfile, brands, canUpgrade, connectPermission, createdDate, currencyCode, currentPlanId, displayApplianceStartUrl, displayApplianceUrl, distributorCode, docuSignLandingUrl, dssValues, envelopeSendingBlocked, envelopeUnitPrice, externalAccountId, forgottenPasswordQuestionsCount, freeEnvelopeSendsRemainingForAdvancedDocGen, isDowngrade, paymentMethod, planClassification, planEndDate, planName, planStartDate, recipientDomains, seatsAllowed, seatsInUse, status21CFRPart11, suspensionDate, suspensionStatus, useDisplayAppliance.
-
Uses template:
- accountMinimumPasswordLength
Field components:
-
Uses template:
ShortText. - Contains the following components: maximumLength, minimumLength.
-
Uses template:
- accountNotification
Field components:
-
Uses template:
expirations. - Contains the following components: expirations, reminders, userOverrideEnabled.
-
Uses template:
- accountPasswordExpirePasswordDays
Field components:
-
Uses template:
ShortText. - Contains the following components: maximumDays, minimumDays.
-
Uses template:
- accountPasswordLockoutDurationMinutes
Field components:
-
Uses template:
ShortText. - Contains the following components: maximumMinutes, minimumMinutes.
-
Uses template:
- accountPasswordLockoutDurationType
Field components:
-
Uses template:
LongText. - Contains the following components: options.
-
Uses template:
- accountPasswordMinimumPasswordAgeDays
Field components:
-
Uses template:
ShortText. - Contains the following components: maximumAge, minimumAge.
-
Uses template:
- accountPasswordQuestionsRequired
Field components:
-
Uses template:
ShortText. - Contains the following components: maximumQuestions, minimumQuestions.
-
Uses template:
- accountPasswordRules
Field components:
-
Uses template:
ShortText. - Contains the following components: expirePassword, expirePasswordDays, expirePasswordDaysMetadata, lockoutDurationMinutes, lockoutDurationMinutesMetadata, lockoutDurationType, lockoutDurationTypeMetadata, minimumPasswordAgeDays, minimumPasswordAgeDaysMetadata, minimumPasswordLength, minimumPasswordLengthMetadata, passwordIncludeDigit, passwordIncludeDigitOrSpecialCharacter, passwordIncludeLowerCase, passwordIncludeSpecialCharacter, passwordIncludeUpperCase, passwordStrengthType, passwordStrengthTypeMetadata, questionsRequired, questionsRequiredMetadata.
-
Uses template:
- accountPasswordStrengthType
Field components:
- An array.
-
Uses template:
accountPasswordStrengthTypeOption.
- accountPasswordStrengthTypeOption
Field components:
-
Uses template:
ShortText. - Contains the following components: minimumLength, name, passwordIncludeDigit, passwordIncludeDigitOrSpecialCharacter, passwordIncludeLowerCase, passwordIncludeSpecialCharacter, passwordIncludeUpperCase.
-
Uses template:
- accountRoleSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: allowAccountManagement, allowAccountManagementMetadata, allowApiAccess, allowApiAccessMetadata, allowApiAccessToAccount, allowApiAccessToAccountMetadata, allowApiSendingOnBehalfOfOthers, allowApiSendingOnBehalfOfOthersMetadata, allowApiSequentialSigning, allowApiSequentialSigningMetadata, allowAutoTagging, allowAutoTaggingMetadata, allowBulkSending, allowBulkSendingMetadata, allowDocuSignDesktopClient, allowDocuSignDesktopClientMetadata, allowedAddressBookAccess, allowedAddressBookAccessMetadata, allowedClickwrapsAccess, allowedClickwrapsAccessMetadata, allowedDocumentTemplateLibraryAccess, allowedDocumentTemplateLibraryAccessMetadata, allowedOrchestrationAccess, allowedOrchestrationAccessMetadata, allowedTemplateAccess, allowedTemplateAccessMetadata, allowedToBeEnvelopeTransferRecipient, allowedToBeEnvelopeTransferRecipientMetadata, allowEnvelopeSending, allowEnvelopeSendingMetadata, allowESealRecipients, allowESealRecipientsMetadata, allowPowerFormsAdminToAccessAllPowerFormEnvelopes, allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata, allowSendersToSetRecipientEmailLanguage, allowSendersToSetRecipientEmailLanguageMetadata, allowSignerAttachments, allowSignerAttachmentsMetadata, allowSupplementalDocuments, allowSupplementalDocumentsMetadata, allowTaggingInSendAndCorrect, allowTaggingInSendAndCorrectMetadata, allowTransactions, allowTransactionsMetadata, allowVaulting, allowVaultingMetadata, allowWetSigningOverride, allowWetSigningOverrideMetadata, canCreateTransaction, canCreateTransactionMetadata, canCreateWorkspaces, canCreateWorkspacesMetadata, canDeleteDocumentsInTransaction, canDeleteDocumentsInTransactionMetadata, canDeleteTransaction, canDeleteTransactionMetadata, canSendEnvelopesViaSMS, canSendEnvelopesViaSMSMetadata, disableDocumentUpload, disableDocumentUploadMetadata, disableOtherActions, disableOtherActionsMetadata, enableApiRequestLogging, enableApiRequestLoggingMetadata, enableKeyTermsSuggestionsByDocumentType, enableKeyTermsSuggestionsByDocumentTypeMetadata, enableRecipientViewingNotifications, enableRecipientViewingNotificationsMetadata, enableSequentialSigningInterface, enableSequentialSigningInterfaceMetadata, enableTransactionPointIntegration, enableTransactionPointIntegrationMetadata, powerFormRole, powerFormRoleMetadata, receiveCompletedSelfSignedDocumentsAsEmailLinks, receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata, signingUiVersionMetadata, supplementalDocumentsMustAccept, supplementalDocumentsMustAcceptMetadata, supplementalDocumentsMustRead, supplementalDocumentsMustReadMetadata, supplementalDocumentsMustView, supplementalDocumentsMustViewMetadata, useNewDocuSignExperienceInterface, useNewDocuSignExperienceInterfaceMetadata, useNewSendingInterface, useNewSendingInterfaceMetadata, vaultingMode, vaultingModeMetadata, webForms, webFormsMetadata.
-
Uses template:
- accountSettingsInformation
Field components:
-
Uses template:
accessCodeFormat. - Contains the following components: accessCodeFormat, accountDateTimeFormat, accountDateTimeFormatMetadata, accountDefaultLanguage, accountDefaultLanguageMetadata, accountName, accountNameMetadata, accountNotification, accountUISettings, adoptSigConfig, adoptSigConfigMetadata, advancedCorrect, advancedCorrectMetadata, advancedSearchEnableTabField, advancedSearchEnableTabFieldMetadata, advancedSearchEnableTemplateIdField, advancedSearchEnableTemplateIdFieldMetadata, advancedSearchEnableTemplateNameField, advancedSearchEnableTemplateNameFieldMetadata, allowAccessCodeFormat, allowAccessCodeFormatMetadata, allowAccountManagementGranular, allowAccountManagementGranularMetadata, allowAccountMemberNameChange, allowAccountMemberNameChangeMetadata, allowACE, allowACEMetadata, allowAdvancedRecipientRoutingConditional, allowAdvancedRecipientRoutingConditionalMetadata, allowAgentNameEmailEdit, allowAgentNameEmailEditMetadata, allowAgreementActions, allowAgreementActionsMetadata, allowAgreementOrchestrations, allowAgreementOrchestrationsMetadata, allowAutoNavSettings, allowAutoNavSettingsMetadata, allowAutoTagging, allowAutoTaggingMetadata, allowBulkSend, allowBulkSendMetadata, allowCDWithdraw, allowCDWithdrawMetadata, allowConnectEnvelopeRemovedEvent, allowConnectExtensionUI, allowConnectHttpListenerConfigs, AllowConnectIdentityVerificationUI, allowConnectOAuthUI, allowConnectSendFinishLater, allowConnectSendFinishLaterMetadata, allowConnectUnifiedPayloadUI, allowConsumerDisclosureOverride, allowConsumerDisclosureOverrideMetadata, allowDataDownload, allowDataDownloadMetadata, allowDelayedRouting, allowDelayedRoutingMetadata, allowDelegatedSigning, allowDelegatedSigningMetadata, allowDocGenDocuments, allowDocGenDocumentsMetadata, allowDocumentDisclosures, allowDocumentDisclosuresMetadata, allowDocumentsOnSignedEnvelopes, allowDocumentsOnSignedEnvelopesMetadata, allowDocumentVisibility, allowDocumentVisibilityMetadata, allowEditingEnvelopesOnBehalfOfOthers, allowEditingEnvelopesOnBehalfOfOthersMetadata, allowEHankoStamps, allowEHankoStampsMetadata, allowENoteEOriginal, allowENoteEOriginalMetadata, allowEnvelopeCorrect, allowEnvelopeCorrectMetadata, allowEnvelopeCustodyTransfer, allowEnvelopeCustodyTransferMetadata, allowEnvelopeCustomFields, allowEnvelopeCustomFieldsMetadata, allowEnvelopePublishReporting, allowEnvelopePublishReportingMetadata, allowEnvelopeReporting, allowEnvelopeReportingMetadata, allowExpression, allowExpressionMetadata, allowExpressSignerCertificate, allowExpressSignerCertificateMetadata, allowExtendedSendingResourceFile, allowExtendedSendingResourceFileMetadata, allowExternalLinkedAccounts, allowExternalLinkedAccountsMetadata, allowExternalSignaturePad, allowExternalSignaturePadMetadata, allowIDVForEUQualifiedSignatures, allowIDVForEUQualifiedSignaturesMetadata, allowIDVLevel1, allowIDVLevel1Metadata, allowIDVLevel1Trial, allowIDVLevel1TrialMetadata, allowIDVLevel2, allowIDVLevel2Metadata, allowIDVLevel3, allowIDVLevel3Metadata, allowIDVPlatform, allowIDVPlatformMetadata, allowInPerson, allowInPersonElectronicNotary, allowInPersonElectronicNotaryMetadata, allowInPersonMetadata, allowManagedStamps, allowManagedStampsMetadata, allowManagingEnvelopesOnBehalfOfOthers, allowManagingEnvelopesOnBehalfOfOthersMetadata, allowMarkup, allowMarkupMetadata, allowMemberTimeZone, allowMemberTimeZoneMetadata, allowMergeFields, allowMergeFieldsMetadata, allowMultipleBrandProfiles, allowMultipleBrandProfilesMetadata, allowMultipleSignerAttachments, allowMultipleSignerAttachmentsMetadata, allowNonUSPhoneAuth, allowNonUSPhoneAuthMetadata, allowOcrOfEnvelopeDocuments, allowOcrOfEnvelopeDocumentsMetadata, allowOfflineSigning, allowOfflineSigningMetadata, allowOpenTrustSignerCertificate, allowOpenTrustSignerCertificateMetadata, allowOrganizationBranding, allowOrganizationBrandingMetadata, allowOrganizationDocusignMonitor, allowOrganizationDocusignMonitorFree, allowOrganizationDocusignMonitorFreeMetadata, allowOrganizationDocusignMonitorMetadata, allowOrganizationDomainUserManagement, allowOrganizationDomainUserManagementMetadata, allowOrganizations, allowOrganizationsMetadata, allowOrganizationSsoManagement, allowOrganizationSsoManagementMetadata, allowOrganizationToUseInPersonElectronicNotary, allowOrganizationToUseInPersonElectronicNotaryMetadata, allowOrganizationToUseRemoteNotary, allowOrganizationToUseRemoteNotaryMetadata, allowOrganizationToUseThirdPartyElectronicNotary, allowOrganizationToUseThirdPartyElectronicNotaryMetadata, allowParticipantRecipientType, allowParticipantRecipientTypeMetadata, allowPaymentProcessing, allowPaymentProcessingMetadata, allowPendingDestinationUrlEdition, allowPendingDestinationUrlEditionMetadata, allowPerformanceAnalytics, allowPerformanceAnalyticsMetadata, allowPhoneAuthentication, allowPhoneAuthenticationMetadata, allowPhoneAuthOverride, allowPhoneAuthOverrideMetadata, allowPrivateSigningGroups, allowPrivateSigningGroupsMetadata, allowRecipientConnect, allowRecipientConnectMetadata, allowReminders, allowRemindersMetadata, allowRemoteNotary, allowRemoteNotaryMetadata, allowResourceFileBranding, allowResourceFileBrandingMetadata, allowSafeBioPharmaSignerCertificate, allowSafeBioPharmaSignerCertificateMetadata, allowScheduledSending, allowScheduledSendingMetadata, allowSecurityAppliance, allowSecurityApplianceMetadata, allowSendingEnvelopesOnBehalfOfOthers, allowSendingEnvelopesOnBehalfOfOthersMetadata, allowSendToCertifiedDelivery, allowSendToCertifiedDeliveryMetadata, allowSendToIntermediary, allowSendToIntermediaryMetadata, allowServerTemplates, allowServerTemplatesMetadata, allowSetEmbeddedRecipientStartURL, allowSetEmbeddedRecipientStartURLMetadata, allowSharedTabs, allowSharedTabsMetadata, allowSignatureStamps, allowSignatureStampsMetadata, allowSignDocumentFromHomePage, allowSignDocumentFromHomePageMetadata, allowSignerReassign, allowSignerReassignMetadata, allowSignerReassignOverride, allowSignerReassignOverrideMetadata, allowSigningExtensions, allowSigningExtensionsMetadata, allowSigningGroups, allowSigningGroupsMetadata, allowSigningInsights, allowSigningInsightsMetadata, allowSigningRadioDeselect, allowSigningRadioDeselectMetadata, allowSignNow, allowSignNowMetadata, allowSMSDelivery, allowSMSDeliveryMetadata, allowSocialIdLogin, allowSocialIdLoginMetadata, allowSupplementalDocuments, allowSupplementalDocumentsMetadata, allowThirdPartyElectronicNotary, allowThirdPartyElectronicNotaryMetadata, allowTransactionsWorkspace, allowTransactionsWorkspaceMetadata, allowTransactionsWorkspaceOriginal, allowTransactionsWorkspaceOriginalMetadata, allowUsersToAccessDirectory, allowUsersToAccessDirectoryMetadata, allowValueInsights, allowValueInsightsMetadata, allowWebForms, allowWebFormsMetadata, allowWhatsAppDelivery, allowWhatsAppDeliveryMetadata, anchorPopulationScope, anchorPopulationScopeMetadata, anchorTagVersionedPlacementEnabled, anchorTagVersionedPlacementMetadataEnabled, attachCompletedEnvelope, attachCompletedEnvelopeMetadata, authenticationCheck, authenticationCheckMetadata, autoNavRule, autoNavRuleMetadata, autoProvisionSignerAccount, autoProvisionSignerAccountMetadata, bccEmailArchive, bccEmailArchiveMetadata, betaSwitchConfiguration, betaSwitchConfigurationMetadata, billingAddress, billingAddressMetadata, bulkSend, bulkSendActionResendLimit, bulkSendMaxCopiesInBatch, bulkSendMaxUnprocessedEnvelopesCount, bulkSendMetadata, canSelfBrandSend, canSelfBrandSendMetadata, canSelfBrandSign, canSelfBrandSignMetadata, canUseSalesforceOAuth, canUseSalesforceOAuthMetadata, captureVoiceRecording, captureVoiceRecordingMetadata, cfr21SimplifiedSigningEnabled, cfr21SimplifiedSigningEnabledMetadata, cfrUseWideImage, cfrUseWideImageMetadata, checkForMultipleAdminsOnAccount, checkForMultipleAdminsOnAccountMetadata, chromeSignatureEnabled, chromeSignatureEnabledMetadata, cloudReady, commentEmailShowMessageText, commentEmailShowMessageTextMetadata, commentsAllowEnvelopeOverride, commentsAllowEnvelopeOverrideMetadata, conditionalFieldsEnabled, conditionalFieldsEnabledMetadata, consumerDisclosureFrequency, consumerDisclosureFrequencyMetadata, convertPdfFields, convertPdfFieldsMetadata, dataPopulationScope, dataPopulationScopeMetadata, defaultSigningResponsiveView, defaultSigningResponsiveViewMetadata, defaultToAdvancedEnvelopesFilterForm, defaultToAdvancedEnvelopesFilterFormMetadata, disableAutoTemplateMatching, disableAutoTemplateMatchingMetadata, disableMobileApp, disableMobileAppMetadata, disableMobilePushNotifications, disableMobilePushNotificationsMetadata, disableMobileSending, disableMobileSendingMetadata, disableMultipleSessions, disableMultipleSessionsMetadata, disablePurgeNotificationsForSenderMetadata, disableSignerCertView, disableSignerCertViewMetadata, disableSignerHistoryView, disableSignerHistoryViewMetadata, disableStyleSignature, disableStyleSignatureMetadata, disableUploadSignature, disableUploadSignatureMetadata, disableUserSharing, disableUserSharingMetadata, displayBetaSwitch, displayBetaSwitchMetadata, documentConversionRestrictions, documentConversionRestrictionsMetadata, documentRetention, documentRetentionMetadata, documentRetentionPurgeTabs, documentVisibility, documentVisibilityMetadata, draftEnvelopeRetention, draftEnvelopeRetentionMetadata, dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerb, dss_SIGN_28411_EnableLeavePagePrompt_RadminOption, dss_SIGN_29182_SlideUpBar_RadminOption, emailTemplateVersion, emailTemplateVersionMetadata, enableAccessCodeGenerator, enableAccessCodeGeneratorMetadata, enableAccountWideSearch, enableAccountWideSearchMetadata, enableAdditionalAdvancedWebFormsFeatures, enableAdditionalAdvancedWebFormsFeaturesMetadata, enableAdmHealthcare, enableAdmHealthcareMetadata, enableAdvancedEnvelopesSearch, enableAdvancedEnvelopesSearchMetadata, enableAdvancedPayments, enableAdvancedPaymentsMetadata, enableAdvancedPowerForms, enableAdvancedPowerFormsMetadata, enableAdvancedSearch, enableAdvancedSearchMetadata, enableAgreementActionsForCLM, enableAgreementActionsForCLMMetadata, enableAgreementActionsForESign, enableAgreementActionsForESignMetadata, enableAIContractReview, enableAIContractReviewMetadata, enableAutoNav, enableAutoNavMetadata, enableBatchUpdateEnvelopeTypes, enableBatchUpdateEnvelopeTypesMetadata, enableBccDummyLink, enableBccDummyLinkMetadata, enableCalculatedFields, enableCalculatedFieldsMetadata, enableClickPlus, enableClickPlusConditionalContent, enableClickPlusConditionalContentMetaData, enableClickPlusCustomFields, enableClickPlusCustomFieldsMetaData, enableClickPlusCustomStyle, enableClickPlusCustomStyleMetaData, enableClickPlusDynamicContent, enableClickPlusDynamicContentMetaData, enableClickPlusMetaData, enableClickwraps, enableClickwrapsMetadata, enableCombinedPDFDownloadForSBS, enableCommentsHistoryDownloadInSigning, enableCommentsHistoryDownloadInSigningMetadata, enableContactSuggestions, enableContactSuggestionsMetadata, enableContentSearch, enableContentSearchMetadata, enableCustomerSatisfactionMetricTracking, enableCustomerSatisfactionMetricTrackingMetadata, enableDataVerificationExtensions, enableDataVerificationExtensionsMetadata, enableDocumentTemplateLibrary, enableDocumentTemplateLibraryMetadata, enableDSigEUAdvancedPens, enableDSigEUAdvancedPensMetadata, enableDSigExpressPens, enableDSigExpressPensMetadata, enableDSigIDCheckForAESPens, enableDSigIDCheckForAESPensMetadata, enableDSigIDCheckInPersonForQESPens, enableDSigIDCheckInPersonForQESPensMetadata, enableDSigIDCheckRemoteForQESPens, enableDSigIDCheckRemoteForQESPensMetadata, enableDSigIDVerificationPens, enableDSigIDVerificationPensMetadata, enableDSigIDVerificationPremierPens, enableDSigIDVerificationPremierPensMetadata, enableDSPro, enableDSProMetadata, enableEnforceTlsEmailsSettingMetadata, enableEnvelopeStampingByAccountAdmin, enableEnvelopeStampingByAccountAdminMetadata, enableEnvelopeStampingByDSAdmin, enableEnvelopeStampingByDSAdminMetadata, enableESignAPIHourlyLimitManagement, enableESignAPIHourlyLimitManagementMetadata, enableEsignCommunities, enableEsignCommunitiesMetadata, enableIDFxAccountlessSMSAuthForPart11, enableIDFxAccountlessSMSAuthForPart11Metadata, enableIDFxIntuitKBA, enableIDFxIntuitKBAMetadata, enableIDFxPhoneAuthentication, enableIDFxPhoneAuthenticationMetadata, enableIdfxPhoneAuthSignatureAuthStatus, enableIdfxPhoneAuthSignatureAuthStatusMetadata, enableInboxBrowseViewsPoweredByElasticSearch, enableInboxBrowseViewsPoweredByElasticSearchMetadata, enableInboxRelevanceSort, enableInboxRelevanceSortMetadata, enableInBrowserEditor, enableInBrowserEditorMetadata, enableKeyTermsSuggestionsByDocumentType, enableKeyTermsSuggestionsByDocumentTypeMetadata, enableLargeFileSupport, enableLargeFileSupportMetadata, enableLegacySharedEnvelopes, enableLegacySharedEnvelopesMetadata, enableLicenseManagement, enableLicenseManagementMetadata, enableMultiUserRepositoryFeatures, enableMultiUserRepositoryFeaturesMetadata, enableNavigatorPartialIngestion, enableNavigatorPartialIngestionMetadata, enableNavigatorTrial, enableNavigatorTrialMetadata, enableObligationManagement, enableObligationManagementMetadata, enableParticipantRecipientSettingMetadata, enablePaymentProcessing, enablePaymentProcessingMetadata, enablePDFAConversion, enablePDFAConversionMetadata, enablePowerForm, enablePowerFormDirect, enablePowerFormDirectMetadata, enablePowerFormMetadata, enablePremiumDataVerificationExtensions, enablePremiumDataVerificationExtensionsMetadata, enableRecipientDomainValidation, enableRecipientDomainValidationMetadata, enableRecipientMayProvidePhoneNumber, enableRecipientMayProvidePhoneNumberMetadata, enableReportLinks, enableReportLinksMetadata, enableRequireSignOnPaper, enableRequireSignOnPaperMetadata, enableReservedDomain, enableReservedDomainMetadata, enableResponsiveSigning, enableResponsiveSigningMetadata, enableScheduledRelease, enableScheduledReleaseMetadata, enableSearchServiceAzureUri, enableSearchServiceAzureUriMetadata, enableSearchSiteSpecificApi, enableSearchSiteSpecificApiMetadata, enableSendingTagsFontSettings, enableSendingTagsFontSettingsMetadata, enableSendToAgent, enableSendToAgentMetadata, enableSendToIntermediary, enableSendToIntermediaryMetadata, enableSendToManage, enableSendToManageMetadata, enableSequentialSigningAPI, enableSequentialSigningAPIMetadata, enableSequentialSigningUI, enableSequentialSigningUIMetadata, enableSignerAttachments, enableSignerAttachmentsMetadata, enableSigningExtensionComments, enableSigningExtensionCommentsMetadata, enableSigningExtensionConversations, enableSigningExtensionConversationsMetadata, enableSigningOrderSettingsForAccount, enableSigningOrderSettingsForAccountMetadata, enableSignOnPaper, enableSignOnPaperMetadata, enableSignOnPaperOverride, enableSignOnPaperOverrideMetadata, enableSignWithNotary, enableSignWithNotaryMetadata, enableSmartContracts, enableSmartContractsMetadata, enableSMSAuthentication, enableSMSAuthenticationMetadata, enableSMSDeliveryAdditionalNotification, enableSMSDeliveryAdditionalNotificationMetadata, enableSMSDeliveryPrimary, enableSocialIdLogin, enableSocialIdLoginMetadata, enableStrikeThrough, enableStrikeThroughMetadata, enableTransactionPoint, enableTransactionPointMetadata, enableUnifiedRepository, enableUnifiedRepositoryMetadata, enableVaulting, enableVaultingMetadata, enableWebFormsRuntimeAPIs, enableWebFormsRuntimeAPIsMetadata, enableWebFormsSeparateUserPermissions, enableWebFormsSeparateUserPermissionsMetadata, enableWitnessing, enableWitnessingMetadata, enforceTemplateNameUniqueness, enforceTemplateNameUniquenessMetadata, enforceTlsEmails, enforceTlsEmailsMetadata, envelopeIntegrationAllowed, envelopeIntegrationAllowedMetadata, envelopeIntegrationEnabled, envelopeIntegrationEnabledMetadata, EnvelopeLimitsTotalDocumentSizeAllowedInMB, EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled, EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata, EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata, envelopeSearchMode, envelopeSearchModeMetadata, envelopeStampingDefaultValue, envelopeStampingDefaultValueMetadata, exitPrompt, exitPromptMetadata, expressSend, expressSendAllowTabs, expressSendAllowTabsMetadata, expressSendMetadata, externalDocumentSources, externalSignaturePadType, externalSignaturePadTypeMetadata, faxOutEnabled, faxOutEnabledMetadata, finishReminder, finishReminderMetadata, forbidAddingUserStamps, forbidAddingUserStampsMetadata, guidedFormsHtmlAllowed, guidedFormsHtmlAllowedMetadata, guidedFormsHtmlConversionPolicy, guidedFormsHtmlConversionPolicyMetadata, hasRecipientConnectClaimedDomain, hideAccountAddressInCoC, hideAccountAddressInCoCMetadata, hidePricing, hidePricingMetadata, idCheckConfigurations, idCheckExpire, idCheckExpireDays, idCheckExpireDaysMetadata, idCheckExpireMetadata, idCheckExpireMinutes, idCheckExpireMinutesMetadata, idCheckRequired, idCheckRequiredMetadata, identityVerification, identityVerificationMetadata, idfxKBAAuthenticationOverride, idfxKBAAuthenticationOverrideMetadata, idfxPhoneAuthenticationOverride, idfxPhoneAuthenticationOverrideMetadata, ignoreErrorIfAnchorTabNotFound, ignoreErrorIfAnchorTabNotFoundMetadataEnabled, inPersonIDCheckQuestion, inPersonIDCheckQuestionMetadata, inPersonSigningEnabled, inPersonSigningEnabledMetadata, inSessionEnabled, inSessionEnabledMetadata, inSessionSuppressEmails, inSessionSuppressEmailsMetadata, isConnectDocumentFieldsEnabled, isvEmbed, isvEmbedMetaData, isvOemEmbed, isvOemEmbedMetaData, linkedExternalPrimaryAccounts, maximumSigningGroups, maximumSigningGroupsMetadata, maximumUsersPerSigningGroup, maximumUsersPerSigningGroupMetadata, maxNumberOfCustomStamps, mergeMixedModeResults, mergeMixedModeResultsMetadata, mobileSessionTimeout, mobileSessionTimeoutMetadata, numberOfActiveCustomStamps, optInMobileSigningV02, optInMobileSigningV02Metadata, optInUniversalSignatures, optOutAutoNavTextAndTabColorUpdates, optOutAutoNavTextAndTabColorUpdatesMetadata, optOutNewPlatformSeal, optOutNewPlatformSealPlatformMetadata, originalAccountSite, pdfMaxChunkedUploadPartSize, pdfMaxChunkedUploadPartSizeMetadata, pdfMaxChunkedUploadTotalSize, pdfMaxChunkedUploadTotalSizeMetadata, pdfMaxIndividualUploadSize, pdfMaxIndividualUploadSizeMetadata, phoneAuthRecipientMayProvidePhoneNumber, phoneAuthRecipientMayProvidePhoneNumberMetadata, pkiSignDownloadedPDFDocs, pkiSignDownloadedPDFDocsMetadata, readOnlyMode, readOnlyModeMetadata, recipientsCanSignOffline, recipientsCanSignOfflineMetadata, recipientSigningAutoNavigationControl, recipientSigningAutoNavigationControlMetadata, recycleBinEnvelopeRetention, recycleBinEnvelopeRetentionMetadata, require21CFRpt11Compliance, require21CFRpt11ComplianceMetadata, requireDeclineReason, requireDeclineReasonMetadata, requireExternalUserManagement, requireExternalUserManagementMetadata, requireSignerCertificateType, requireSignerCertificateTypeMetadata, rsaVeridAccountName, rsaVeridPassword, rsaVeridRuleset, rsaVeridUserId, selfSignedRecipientEmailDocument, selfSignedRecipientEmailDocumentMetadata, selfSignedRecipientEmailDocumentUserOverride, selfSignedRecipientEmailDocumentUserOverrideMetadata, senderCanSignInEachLocation, senderCanSignInEachLocationMetadata, senderMustAuthenticateSigning, senderMustAuthenticateSigningMetadata, sendingTagsFontColor, sendingTagsFontColorMetadata, sendingTagsFontName, sendingTagsFontNameMetadata, sendingTagsFontSize, sendingTagsFontSizeMetadata, sendLockoutRecipientNotification, sendLockoutRecipientNotificationMetadata, sendToCertifiedDeliveryEnabled, sendToCertifiedDeliveryEnabledMetadata, sessionTimeout, sessionTimeoutMetadata, setRecipEmailLang, setRecipEmailLangMetadata, setRecipSignLang, setRecipSignLangMetadata, sharedTemplateFolders, sharedTemplateFoldersMetadata, showCompleteDialogInEmbeddedSession, showCompleteDialogInEmbeddedSessionMetadata, showConditionalRoutingOnSend, showConditionalRoutingOnSendMetadata, showInitialConditionalFields, showInitialConditionalFieldsMetadata, showLocalizedWatermarks, showLocalizedWatermarksMetadata, showMaskedFieldsWhenDownloadingDocumentAsSender, showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata, showTutorials, showTutorialsMetadata, signatureProviders, signatureProvidersMetadata, signDateFormat, signDateFormatMetadata, signDateTimeAccountLanguageOverride, signDateTimeAccountLanguageOverrideMetadata, signDateTimeAccountTimezoneOverride, signDateTimeAccountTimezoneOverrideMetadata, signerAttachCertificateToEnvelopePDF, signerAttachCertificateToEnvelopePDFMetadata, signerAttachConcat, signerAttachConcatMetadata, signerCanCreateAccount, signerCanCreateAccountMetadata, signerCanSignOnMobile, signerCanSignOnMobileMetadata, signerInSessionUseEnvelopeCompleteEmail, signerInSessionUseEnvelopeCompleteEmailMetadata, signerLoginRequirements, signerLoginRequirementsMetadata, signerMustHaveAccount, signerMustHaveAccountMetadata, signerMustLoginToSign, signerMustLoginToSignMetadata, signerShowSecureFieldInitialValues, signerShowSecureFieldInitialValuesMetadata, signingSessionTimeout, signingSessionTimeoutMetadata, signingUiVersion, signingUiVersionMetadata, signTimeFormat, signTimeFormatMetadata, signTimeShowAmPm, signTimeShowAmPmMetadata, simplifiedSendingEnabled, simplifiedSendingEnabledMetadata, singleSignOnEnabled, singleSignOnEnabledMetadata, skipAuthCompletedEnvelopes, skipAuthCompletedEnvelopesMetadata, socialIdRecipAuth, socialIdRecipAuthMetadata, specifyDocumentVisibility, specifyDocumentVisibilityMetadata, startInAdvancedCorrect, startInAdvancedCorrectMetadata, supplementalDocumentsMustAccept, supplementalDocumentsMustAcceptMetadata, supplementalDocumentsMustRead, supplementalDocumentsMustReadMetadata, supplementalDocumentsMustView, supplementalDocumentsMustViewMetadata, suppressCertificateEnforcement, suppressCertificateEnforcementMetadata, tabAccountSettings, timezoneOffsetAPI, timezoneOffsetAPIMetadata, timezoneOffsetUI, timezoneOffsetUIMetadata, universalSignatureOptIn, universalSignatureSkipPlatformSignature, universalSignatureSkipPlatformSignatureMetadata, useAccountLevelEmail, useAccountLevelEmailMetadata, useConsumerDisclosure, useConsumerDisclosureMetadata, useConsumerDisclosureWithinAccount, useConsumerDisclosureWithinAccountMetadata, useDerivedKeys, useDerivedKeysMetadata, useDocuSignExpressSignerCertificate, useDocuSignExpressSignerCertificateMetadata, useEnvelopeSearchMixedMode, useEnvelopeSearchMixedModeMetadata, useMultiAppGroupsData, useMultiAppGroupsDataMetadata, useNewBlobForPdf, useNewBlobForPdfMetadata, useNewEnvelopeSearch, useNewEnvelopeSearchMetadata, useNewEnvelopeSearchOnlyWhenSearchingAfterDate, useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata, useNewEnvelopeSearchOnlyWithSearchTerm, useNewEnvelopeSearchOnlyWithSearchTermMetadata, useSAFESignerCertificates, useSAFESignerCertificatesMetadata, usesAPI, usesAPIMetadata, useSignatureProviderPlatform, useSignatureProviderPlatformMetadata, useSmartContractsV1, validationsAllowed, validationsAllowedMetadata, validationsBrand, validationsBrandMetadata, validationsCadence, validationsCadenceMetadata, validationsEnabled, validationsEnabledMetadata, validationsReport, validationsReportMetadata, waterMarkEnabled, waterMarkEnabledMetadata, writeReminderToEnvelopeHistory, writeReminderToEnvelopeHistoryMetadata, wurflMinAllowableScreenSize, wurflMinAllowableScreenSizeMetadata.
-
Uses template:
- accountSignature
Field components:
-
Uses template:
ShortText. - Contains the following components: signatureId, adoptedDateTime, createdDateTime, customField, dateStampProperties, disallowUserResizeStamp, externalID, imageBase64, imageType, initials150ImageId, initialsImageUri, isDefault, lastModifiedDateTime, nrdsId, nrdsLastName, nrdsStatus, phoneticName, signature150ImageId, signatureFont, signatureGroups, signatureImageUri, signatureInitials, signatureName, signatureRights, signatureType, signatureUsers, stampFormat, stampImageUri, stampSizeMM, stampType, status.
-
Uses template:
- accountSignatureProvider
Field components:
-
Uses template:
ShortText. - Contains the following components: isRequired, priority, signatureProviderDisplayName, signatureProviderId, signatureProviderName, signatureProviderOptionsMetadata, signatureProviderRequiredOptions.
-
Uses template:
- accountSignatureProviderOption
Field components:
-
Uses template:
ShortText. - Contains the following components: signatureProviderOptionDisplayName, signatureProviderOptionId, signatureProviderOptionName.
-
Uses template:
- accountUISettings
Field components:
-
Uses template:
adminMessage. - Contains the following components: adminMessage, allowUsersToEditSharedAccess, allowUsersToEditSharedAccessMetadata, askAnAdmin, clickwrapSchemaVersion, clickwrapSchemaVersionMetadata, disableWebAppAccess, disableWebAppAccessMetadata, enableAdminMessage, enableAdminMessageMetadata, enableEasySignCanUseMultiTemplateApply, enableEasySignCanUseMultiTemplateApplyMetadata, enableEasySignTemplateUpload, enableEasySignTemplateUploadMetadata, enableEnvelopeCopyWithData, enableEnvelopeCopyWithDataMetadata, enableEnvelopeTypes, enableEnvelopeTypesMetadata, enableLegacySendflowLink, enableLegacySendflowLinkMetadata, hasExternalLinkedAccounts, hasExternalLinkedAccountsMetadata, hideSendAnEnvelope, hideSendAnEnvelopeMetadata, hideUseATemplate, hideUseATemplateInPrepare, hideUseATemplateInPrepareMetadata, hideUseATemplateMetadata, orderBasedRecipientIdGeneration, orderBasedRecipientIdGenerationMetadata, removeEnvelopeForwarding, removeEnvelopeForwardingMetadata, shouldRedactAccessCode, shouldRedactAccessCodeMetadata, uploadNewImageToSignOrInitial, uploadNewImageToSignOrInitialMetadata.
-
Uses template:
- addressInformationInput
Field components:
-
Uses template:
addressInformation. - Contains the following components: addressInformation, displayLevelCode, receiveInResponse.
-
Uses template:
- adminMessage
Field components:
-
Uses template:
ShortText. - Contains the following components: baseMessage, moreInformation.
-
Uses template:
- agent
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, phoneNumber, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- diagnosticsSettingsInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: apiRequestLogging, apiRequestLogMaxEntries, apiRequestLogRemainingEntries.
-
Uses template:
- apiRequestLog
Field components:
-
Uses template:
DateTime. - Contains the following components: createdDateTime, description, requestLogId, status.
-
Uses template:
- askAnAdmin
Field components:
-
Uses template:
ShortText. - Contains the following components: email, message, name, phone.
-
Uses template:
- attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: attachmentId, accessControl, attachmentType, label, name, remoteUrl.
-
Uses template:
- authenticationMethod
Field components:
-
Uses template:
ShortText. - Contains the following components: authenticationType, lastProvider, lastTimestamp, totalCount.
-
Uses template:
- authenticationStatus
Field components:
-
Uses template:
eventResult. - Contains the following components: accessCodeResult, ageVerifyResult, anySocialIDResult, facebookResult, googleResult, identityVerificationResult, idLookupResult, idQuestionsResult, linkedinResult, liveIDResult, ofacResult, openIDResult, phoneAuthResult, salesforceResult, signatureProviderResult, smsAuthResult, sTANPinResult, twitterResult, yahooResult.
-
Uses template:
- authorizationUser
Field components:
-
Uses template:
ShortText. - Contains the following components: accountId, email, name, userId.
-
Uses template:
- bccEmailAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: bccEmailAddressId, email.
-
Uses template:
- bccEmailArchive
Field components:
-
Uses template:
ShortText. - Contains the following components: bccEmailArchiveId, accountId, action, created, createdBy, email, emailNotificationId, modified, modifiedBy, status, uri.
-
Uses template:
- billingCharge
Field components:
-
Uses template:
ShortText. - Contains the following components: allowedQuantity, blocked, chargeName, chargeType, chargeUnitOfMeasure, discounts, firstEffectiveDate, includedQuantity, incrementalQuantity, lastEffectiveDate, prices, unitPrice, usedQuantity.
-
Uses template:
- billingDiscount
Field components:
-
Uses template:
ShortText. - Contains the following components: beginQuantity, discount, endQuantity.
-
Uses template:
- billingInvoice
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, balance, dueDate, invoiceId, invoiceItems, invoiceNumber, invoiceUri, nonTaxableAmount, pdfAvailable, taxableAmount.
-
Uses template:
- billingInvoiceItem
Field components:
-
Uses template:
ShortText. - Contains the following components: chargeAmount, chargeName, invoiceItemId, quantity, taxAmount, taxExemptAmount, unitPrice.
-
Uses template:
- billingPaymentItem
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, description, paymentDate, paymentId, paymentNumber.
-
Uses template:
- extensionForCreditCardInformation
Template: creditCardInformation. Field components:
-
Uses template:
ShortText. - Contains the following components: accountPaymentMethod, discountApplied, downgradeEffectiveDate, downgradePaymentCycle, downgradePlanId, downgradePlanName, downgradeRequestStatus, message, productId, promoCode, saleDiscount, saleDiscountPeriods, saleDiscountType.
-
Uses template:
- billingPrice
Field components:
-
Uses template:
ShortText. - Contains the following components: beginQuantity, endQuantity, unitPrice.
-
Uses template:
- bulkEnvelope
Field components:
-
Uses template:
ShortText. - Contains the following components: bulkRecipientRow, bulkStatus, email, envelopeId, envelopeUri, name, submittedDateTime, transactionId.
-
Uses template:
- bulkEnvelopeStatus
Field components:
-
Uses template:
ShortText. - Contains the following components: batchId, batchSize, bulkEnvelopes, bulkEnvelopesBatchUri, endPosition, failed, nextUri, previousUri, queued, resultSetSize, sent, startPosition, submittedDate, totalSetSize.
-
Uses template:
- bulkBatchSummaries
Field components:
-
Uses template:
ShortText. - Contains the following components: batchId, action, actionStatus, batchName, batchSize, batchUri, failed, queued, sent, submittedDate, notification, voidReason.
-
Uses template:
- bulkSendBatchStatus
Template: bulkBatchSummaries. Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeIdOrTemplateId, envelopesInfo, envelopesUri, mailingListId, mailingListName, ownerUserId, resendsRemaining, senderUserId.
-
Uses template:
- bulkSendEnvelopesInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: authoritativeCopy, completed, correct, created, declined, deleted, delivered, digitalSignaturesPending, sent, signed, timedOut, transferCompleted, voided.
-
Uses template:
- bulkSendErrorStatus
Field components:
-
Uses template:
DateTime. - Contains the following components: created, envelopeId, errorMessage, recipientEmails.
-
Uses template:
- bulkSendingCopy
Field components:
-
Uses template:
ShortText. - Contains the following components: bulkSendListId, createdByUser, createdDate, name, customFields, docGenFormFields, emailBlurb, emailSubject, recipients.
-
Uses template:
- bulkSendingCopyCustomField
Field components:
-
Uses template:
ShortText. - Contains the following components: name, value.
-
Uses template:
- bulksendingCopyDocGenFormField
Field components:
-
Uses template:
ShortText. - Contains the following components: name, rowValues, value.
-
Uses template:
- bulkSendingCopyDocGenFormFieldRowValue
Field components:
-
Uses template:
LongText. - Contains the following components: docGenFormFieldList.
-
Uses template:
- bulkSendingCopyRecipient
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, clientUserId, customFields, deliveryMethod, email, emailNotification, embeddedRecipientStartURL, faxNumber, hostEmail, hostName, idCheckConfigurationName, idCheckInformationInput, identificationMethod, identityVerification, name, note, phoneAuthentication, recipientId, recipientSignatureProviders, roleName, signerName, signingGroupId, smsAuthentication, socialAuthentications, tabs.
-
Uses template:
- bulkSendingCopyTab
Field components:
-
Uses template:
ShortText. - Contains the following components: initialValue, tabLabel.
-
Uses template:
- carbonCopy
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, agentCanEditEmail, agentCanEditName, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, linkedAccountConfigurationId, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, phoneNumber, proofFile, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- certifiedDelivery
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, agentCanEditEmail, agentCanEditName, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, phoneNumber, proofFile, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- checkbox
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, locked, lockedMetadata, mergeField, mergeFieldXml, name, nameMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, selected, selectedMetadata, selectedOriginal, selectedOriginalMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- chunkedUploadPart
Field components:
-
Uses template:
ShortText. - Contains the following components: sequence, size.
-
Uses template:
- chunkedUpload
Field components:
-
Uses template:
ShortText. - Contains the following components: chunkedUploadId, checksum, chunkedUploadParts, chunkedUploadUri, committed, expirationDateTime, maxChunkedUploadParts, maxTotalSize, totalSize.
-
Uses template:
- cloudStorageProvider
Field components:
-
Uses template:
ShortText. - Contains the following components: userId, serviceId, authenticationUrl, redirectUrl, service.
-
Uses template:
- comment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, envelopeId, hmac, mentions, read, sentByEmail, sentByFullName, sentByImageId, sentByInitials, sentByRecipientId, sentByUserId, signingGroupId, signingGroupName, subject, tabId, text, threadId, threadOriginatorId, timestamp, timeStampFormatted, visibleTo.
-
Uses template:
- conditionalRecipientRule
Field components:
-
Uses template:
conditionalRecipientRuleCondition. - Contains the following components: conditions, order, recipientGroup, recipientId.
-
Uses template:
- conditionalRecipientRuleCondition
Field components:
-
Uses template:
conditionalRecipientRuleFilter. - Contains the following components: filters, order, recipientLabel.
-
Uses template:
- conditionalRecipientRuleFilter
Field components:
-
Uses template:
ShortText. - Contains the following components: operator, recipientId, scope, tabId, tabLabel, tabType, value.
-
Uses template:
- connectCustomConfiguration
Field components:
-
Uses template:
ShortText. - Contains the following components: connectId, allowEnvelopePublish, allowSalesforcePublish, allUsers, allUsersExcept, configurationType, deliveryMode, disabledBy, enableLog, envelopeEvents, eventData, events, externalFolderId, externalFolderLabel, groupIds, includeCertificateOfCompletion, includeCertSoapHeader, includeDocumentFields, includeDocuments, includeEnvelopeVoidReason, includeHMAC, includeOAuth, includeSenderAccountasCustomField, includeTimeZoneInformation, integratorManaged, name, password, recipientEvents, requireMutualTls, requiresAcknowledgement, salesforceApiVersion, salesforceAuthcode, salesforceCallBackUrl, salesforceDocumentsAsContentFiles, senderOverride, senderSelectableItems, sfObjects, signMessageWithX509Certificate, soapNamespace, urlToPublishTo, userIds, userName, useSoapInterface.
-
Uses template:
- connectDebugLog
Field components:
-
Uses template:
ShortText. - Contains the following components: connectConfig, eventDateTime, eventDescription, payload.
-
Uses template:
- connectEventData
Field components:
-
Uses template:
ShortText. - Contains the following components: format, includeData, version.
-
Uses template:
- connectHistoricalEnvelopeRepublish
Field components:
-
Uses template:
connectCustomConfiguration. - Contains the following components: config, envelopes.
-
Uses template:
- connectLog
Field components:
-
Uses template:
ShortText. - Contains the following components: logId, accountId, configUrl, connectDebugLog, connectId, created, email, envelopeId, error, failureId, failureUri, lastTry, logUri, retryCount, retryUri, status, subject, userName.
-
Uses template:
- connectOAuthConfig
Field components:
-
Uses template:
ShortText. - Contains the following components: authorizationServerUrl, clientId, clientSecret, customParameters, scope.
-
Uses template:
- connectSalesforceField
Field components:
-
Uses template:
ShortText. - Contains the following components: id, dsAttribute, dsLink, dsNode, sfField, sfFieldName, sfFolder, sfLockedValue.
-
Uses template:
- connectSalesforceObject
Field components:
-
Uses template:
ShortText. - Contains the following components: id, active, description, insert, onCompleteOnly, selectFields, sfObject, sfObjectName, updateFields.
-
Uses template:
- connectUserObject
Field components:
-
Uses template:
ShortText. - Contains the following components: configurationtype, connectId, enabled, hasAccess, senderSearchableItems.
-
Uses template:
- consentDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: consentKey, deliveryMethod, signerConsentStatus.
-
Uses template:
- consoleViewRequest
Template: ActionT. Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, returnUrl.
-
Uses template:
- consumerDisclosure
Field components:
-
Uses template:
ShortText. - Contains the following components: accountEsignId, allowCDWithdraw, allowCDWithdrawMetadata, changeEmail, changeEmailOther, companyName, companyPhone, copyCostPerPage, copyFeeCollectionMethod, copyRequestEmail, custom, enableEsign, esignAgreement, esignText, languageCode, mustAgreeToEsign, pdfId, useBrand, useConsumerDisclosureWithinAccount, useConsumerDisclosureWithinAccountMetadata, withdrawAddressLine1, withdrawAddressLine2, withdrawByEmail, withdrawByMail, withdrawByPhone, withdrawCity, withdrawConsequences, withdrawEmail, withdrawOther, withdrawPhone, withdrawPostalCode, withdrawState.
-
Uses template:
- contact
Field components:
-
Uses template:
ShortText. - Contains the following components: cloudProvider, cloudProviderContainerId, contactId, contactPhoneNumbers, contactUri, emails, isOwner, name, notaryContactDetails, organization, roomContactType, shared, signingGroup, signingGroupName.
-
Uses template:
- contactPhoneNumber
Field components:
-
Uses template:
ShortText. - Contains the following components: phoneNumber, phoneType.
-
Uses template:
- correctViewRequest
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, beginOnTagger, returnUrl, suppressNavigation, viewUrl.
-
Uses template:
- customField
Field components:
-
Uses template:
ShortText. - Contains the following components: customFieldType, fieldId, listItems, name, required, show, value.
-
Uses template:
- date
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- document
Field components:
-
Uses template:
ShortText. - Contains the following components: applyAnchorTabs, assignTabsToRecipientId, authoritativeCopy, display, documentBase64, documentFields, documentId, documentTemplateAgreementTypeId, documentTemplateId, encryptedWithKeyManager, fileExtension, fileFormatHint, includeInDownload, isDocGenDocument, matchBoxes, name, order, pages, password, pdfFormFieldOption, remoteUrl, signerMustAcknowledge, signerMustAcknowledgeUseAccountDefault, templateLocked, templateRequired, transformPdfFields, uri, documentRaw.
-
Uses template:
- dateStampProperties
Field components:
-
Uses template:
ShortText. - Contains the following components: dateAreaHeight, dateAreaWidth, dateAreaX, dateAreaY.
-
Uses template:
- delayedRouting
Field components:
-
Uses template:
DateTime. - Contains the following components: resumeDate, rules, status.
-
Uses template:
- delegationInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: Email, Name, UserAuthorizationId, UserId.
-
Uses template:
- dobInformationInput
Field components:
-
Uses template:
ShortText. - Contains the following components: dateOfBirth, displayLevelCode, receiveInResponse.
-
Uses template:
- docGenFormField
Field components:
-
Uses template:
ShortText. - Contains the following components: description, label, name, options, order, predefinedValidation, required, rowValues, type, validation, value.
-
Uses template:
- docGenFormFieldOption
Field components:
-
Uses template:
ShortText. - Contains the following components: description, label, selected, value.
-
Uses template:
- docGenFormFieldRowValue
Field components:
-
Uses template:
LongText. - Contains the following components: docGenFormFieldList.
-
Uses template:
- docGenFormFields
Field components:
-
Uses template:
ShortText. - Contains the following components: docGenDocumentStatus, docGenErrors, docGenFormFieldList, documentId.
-
Uses template:
- docGenFormFieldValidation
Field components:
-
Uses template:
ShortText. - Contains the following components: errorMessage, expression.
-
Uses template:
- docGenSyntaxError
Field components:
-
Uses template:
ShortText. - Contains the following components: errorCode, message, tagIdentifier.
-
Uses template:
- documentHtmlCollapsibleDisplaySettings
Field components:
-
Uses template:
ShortText. - Contains the following components: arrowClosed, arrowColor, arrowLocation, arrowOpen, arrowSize, arrowStyle, containerStyle, labelStyle, onlyArrowIsClickable, outerLabelAndArrowStyle.
-
Uses template:
- documentHtmlDefinition
Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, displayAnchorPrefix, displayAnchors, displayOrder, displayPageNumber, documentGuid, headerLabel, maxScreenWidth, removeEmptyTags, showMobileOptimizedToggle, source.
-
Uses template:
- documentHtmlDefinitionOriginal
Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, documentIdGuid, htmlDefinition.
-
Uses template:
- documentHtmlDisplayAnchor
Field components:
-
Uses template:
documentHtmlDisplaySettings. - Contains the following components: caseSensitive, displaySettings, endAnchor, removeEndAnchor, removeStartAnchor, startAnchor.
-
Uses template:
- documentHtmlDisplaySettings
Field components:
-
Uses template:
ShortText. - Contains the following components: cellStyle, collapsibleSettings, display, displayLabel, displayOrder, displayPageNumber, hideLabelWhenOpened, inlineOuterStyle, labelWhenOpened, preLabel, scrollToTopWhenOpened, tableStyle.
-
Uses template:
- documentTemplate
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, documentEndPage, documentId, documentStartPage, templateId.
-
Uses template:
- documentVisibility
Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, recipientId, rights, visible.
-
Uses template:
- downgradeBillingPlanInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: downgradeEventType, planInformation, promoCode, saleDiscount, saleDiscountPeriods, saleDiscountType.
-
Uses template:
- editor
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, phoneNumber, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- emailSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, bccEmailAddresses, replyEmailAddressOverride, replyEmailNameOverride.
-
Uses template:
- eNoteConfiguration
Field components:
-
Uses template:
ShortText. - Contains the following components: apiKey, connectConfigured, eNoteConfigured, organization, password, userName.
-
Uses template:
- envelope
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, accessControlListBase64, accessibility, allowComments, allowMarkup, allowReassign, allowRecipientRecursion, allowViewHistory, anySigner, asynchronous, attachments, attachmentsUri, authoritativeCopy, authoritativeCopyDefault, autoNavigation, brandId, brandLock, burnDefaultTabData, certificateUri, completedDateTime, compositeTemplates, copyRecipientData, createdDateTime, customFieldsUri, dataPopulationScope, declinedDateTime, deletedDateTime, deliveredDateTime, disableResponsiveDocument, documents, documentBase64, documentsCombinedUri, documentsUri, emailBlurb, emailSubject, enableWetSign, enforceSignerVisibility, envelopeCustomMetadata, envelopeIdStamping, envelopeLocation, envelopeMetadata, envelopeUri, eventNotification, expireAfter, expireDateTime, expireEnabled, externalEnvelopeId, hasComments, hasDocumentTemplateLibrary, hasFormDataChanged, hasWavFile, holder, initialSentDateTime, is21CFRPart11, isDynamicEnvelope, isSignatureProviderEnvelope, location, lockInformation, messageLock, notification, notificationUri, powerForm, purgeCompletedDate, purgeRequestDate, purgeState, recipientsLock, recipientsUri, sender, signerCanSignOnMobile, signingLocation, status, statusDateTime, templateId, templatesUri, transactionId, useDisclosure, uSigState, voidedReason, workflow, lastModifiedDateTime, sentDateTime, statusChangedDateTime, voidedDateTime.
-
Uses template:
- envelopeAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: accessControl, attachmentId, attachmentType, label, name.
-
Uses template:
- envelopeCustomMetadata
Field components:
- An array.
-
Uses template:
nameValue.
- envelopeDelayRule
Field components:
-
Uses template:
ShortText. - Contains the following components: delay, resumeDate.
-
Uses template:
- envelopeDocument
Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, addedRecipientIds, attachmentTabId, authoritativeCopy, authoritativeCopyMetadata, availableDocumentTypes, containsPdfFormFields, display, displayMetadata, docGenDocumentStatus, docGenErrors, docGenFormFields, documentBase64, documentFields, documentIdGuid, documentTemplateAgreementTypeId, documentTemplateId, hasDigitalSignature, includeInDownload, includeInDownloadMetadata, isAceGenDocument, isDocGenDocument, isExternallyAvailable, isFlattened, name, nameMetadata, order, pages, signerMustAcknowledge, signerMustAcknowledgeMetadata, sizeBytes, templateLocked, templateRequired, type, uri.
-
Uses template:
- envelopeEvent
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeEventStatusCode, includeDocuments.
-
Uses template:
- envelopeFormData
Field components:
-
Uses template:
ShortText. - Contains the following components: emailSubject, envelopeId, formData, prefillFormData, recipientFormData, sentDateTime, status.
-
Uses template:
- EnvelopeLocks
Field components:
-
Uses template:
ShortText. - Contains the following components: lockDurationInSeconds, lockedByApp, lockedByUser, lockedUntilDateTime, lockToken, lockType, useScratchPad.
-
Uses template:
- envelopeMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: allowAdvancedCorrect, allowCorrect, enableSignWithNotary.
-
Uses template:
- envelopePurgeConfiguration
Field components:
-
Uses template:
ShortText. - Contains the following components: purgeEnvelopes, redactPII, removeTabsAndEnvelopeAttachments, retentionDays.
-
Uses template:
- envelopeSummary
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: ownerName, envelopeId, envelopeUri, status, senderName, senderEmail, senderCompany, createdDateTime, sentDateTime, completedDateTime, subject, recipientsUri, is21CFRPart11.
-
Uses template:
- envelopeTemplate
Field components:
-
Uses template:
ShortText. - Contains the following components: templateId, accessControlListBase64, allowComments, allowMarkup, allowReassign, allowViewHistory, anySigner, asynchronous, attachmentsUri, authoritativeCopy, authoritativeCopyDefault, autoMatch, autoMatchSpecifiedByUser, autoNavigation, brandId, brandLock, burnDefaultTabData, certificateUri, completedDateTime, copyRecipientData, created, createdDateTime, customFieldsUri, dataPopulationScope, declinedDateTime, deletedDateTime, deliveredDateTime, description, disableResponsiveDocument, documents, documentBase64, documentsCombinedUri, documentsUri, emailBlurb, emailSettings, emailSubject, enableWetSign, enforceSignerVisibility, envelopeAttachments, envelopeCustomMetadata, envelopeDocuments, envelopeId, envelopeIdStamping, envelopeLocation, envelopeMetadata, envelopeUri, expireAfter, expireDateTime, expireEnabled, externalEnvelopeId, favoritedByMe, folderId, folderIds, folderName, folders, hasComments, hasDocumentTemplateLibrary, hasFormDataChanged, hasWavFile, holder, initialSentDateTime, is21CFRPart11, isAceGenTemplate, isDocGenTemplate, isDynamicEnvelope, isSignatureProviderEnvelope, lastModified, lastModifiedBy, lastModifiedDateTime, lastUsed, location, lockInformation, messageLock, name, newPassword, notification, notificationUri, owner, pageCount, password, passwordProtected, powerForm, powerForms, purgeCompletedDate, purgeRequestDate, purgeState, recipientsLock, recipientsUri, sender, sentDateTime, shared, signerCanSignOnMobile, signingLocation, status, statusChangedDateTime, statusDateTime, templatesUri, transactionId, uri, useDisclosure, uSigState, voidedDateTime, voidedReason, workflow.
-
Uses template:
- envelopeTransactionStatus
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, status, transactionId.
-
Uses template:
- envelopeTransferRule
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeTransferRuleId, carbonCopyOriginalOwner, enabled, eventType, fromGroup, fromUser, modifiedDate, modifiedUser, toFolder, toUser, fromGroups, fromUsers.
-
Uses template:
- envelopeViewDocumentSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: showEditDocuments, showEditDocumentVisibility, showEditPages, showSaveAsDocumentCustomField.
-
Uses template:
- envelopeViewEnvelopeCustomFieldSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: showEnvelopeCustomFields.
-
Uses template:
- envelopeViewRecipientSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: showBulkSend, showContactsList, showEditMessage, showEditRecipients.
-
Uses template:
- envelopeViewRequest
Template: ActionT. Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, returnUrl, settings, viewAccess.
-
Uses template:
- envelopeViewSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: backButtonAction, documentSettings, envelopeCustomFieldSettings, lockToken, recipientSettings, sendButtonAction, showAdvancedOptions, showBackButton, showDiscardAction, showHeaderActions, showSignNow, startingScreen, taggerSettings, templateSettings.
-
Uses template:
- envelopeViewTaggerSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: paletteDefault, paletteSections, paletteSettings.
-
Uses template:
- envelopeViewTemplateSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: showMatchingTemplatesPrompt.
-
Uses template:
- errorDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: errorCode, message.
-
Uses template:
- eventNotification
Field components:
-
Uses template:
ShortText. - Contains the following components: deliveryMode, envelopeEvents, eventData, events, includeCertificateOfCompletion, includeCertificateWithSoap, includeDocumentFields, includeDocuments, includeEnvelopeVoidReason, includeHMAC, includeOAuth, includeSenderAccountAsCustomField, includeTimeZone, integratorManaged, loggingEnabled, recipientEvents, requireAcknowledgment, signMessageWithX509Cert, soapNameSpace, url, useSoapInterface.
-
Uses template:
- eventResult
Field components:
-
Uses template:
ShortText. - Contains the following components: eventTimestamp, failureDescription, status, vendorFailureStatusCode.
-
Uses template:
- expirations
Field components:
-
Uses template:
ShortText. - Contains the following components: expireAfter, expireEnabled, expireWarn.
-
Uses template:
- externalDocumentSources
Field components:
-
Uses template:
ShortText. - Contains the following components: boxnetEnabled, boxnetMetadata, dropboxEnabled, dropboxMetadata, googleDriveEnabled, googleDriveMetadata, oneDriveEnabled, oneDriveMetadata, salesforceEnabled, salesforceMetadata.
-
Uses template:
- externalFile
Field components:
-
Uses template:
ShortText. - Contains the following components: id, date, hasCompositeTemplate, img, name, ownerName, size, supported, type, uri.
-
Uses template:
- externalPrimaryAccountRecipientAuthRequirements
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, idVerification, kba, phone.
-
Uses template:
- externalPrimaryAccountSafelistAuthRequirements
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, idVerification, kba, phone.
-
Uses template:
- favoriteTemplatesContentItem
Field components:
-
Uses template:
ShortText. - Contains the following components: favoritedDate, templateId.
-
Uses template:
- featureAvailableMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: availabilty, featureName.
-
Uses template:
- fileType
Field components:
-
Uses template:
ShortText. - Contains the following components: fileExtension, mimeType.
-
Uses template:
- filter
Field components:
-
Uses template:
ShortText. - Contains the following components: actionRequired, expires, folderIds, fromDateTime, isTemplate, order, orderBy, searchTarget, searchText, status, toDateTime.
-
Uses template:
- folder
Field components:
-
Uses template:
filter. - Contains the following components: filter, folderId, folderItems, folders, hasAccess, hasSubFolders, itemCount, name, owner, parentFolderId, parentFolderUri, subFolderCount, type, uri.
-
Uses template:
- T_folderAndEnvelope
Template: envelopeSummary. Field components:
-
Uses template:
ShortText. - Contains the following components: folderId, envelopeIds, fromFolderId, filter, folderItems, folders, hasAccess, hasSubFolders, itemCount, name, owner, parentFolderId, parentFolderUri, subFolderCount, type, uri.
-
Uses template:
- folderItem_v2
Field components:
-
Uses template:
DateTime. - Contains the following components: completedDateTime, createdDateTime, envelopeId, envelopeUri, expireDateTime, folderId, folderUri, is21CFRPart11, lastModifiedDateTime, ownerName, recipientsUri, senderCompany, senderEmail, senderName, senderUserId, sentDateTime, status, subject, templateId, templateUri.
-
Uses template:
- forgottenPasswordInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: forgottenPasswordAnswer1, forgottenPasswordAnswer2, forgottenPasswordAnswer3, forgottenPasswordAnswer4, forgottenPasswordQuestion1, forgottenPasswordQuestion2, forgottenPasswordQuestion3, forgottenPasswordQuestion4.
-
Uses template:
- formDataItem
Field components:
-
Uses template:
ShortText. - Contains the following components: listSelectedValue, name, numericalValue, originalNumericalValue, originalValue, value.
-
Uses template:
- graphicsContext
Field components:
-
Uses template:
ShortText. - Contains the following components: fillColor, lineColor, lineWeight.
-
Uses template:
- group
Field components:
-
Uses template:
ShortText. - Contains the following components: accessType, dsGroupId, groupId, groupName, groupType, isManagedByScim, lastModifiedOn, permissionProfileId, users, usersCount.
-
Uses template:
- idCheckConfiguration
Field components:
-
Uses template:
idCheckSecurityStep. - Contains the following components: authSteps, isDefault, name.
-
Uses template:
- idCheckInformationInput
Field components:
-
Uses template:
addressInformationInput. - Contains the following components: addressInformationInput, dobInformationInput, ssn4InformationInput, ssn9InformationInput.
-
Uses template:
- idCheckSecurityStep
Field components:
-
Uses template:
ShortText. - Contains the following components: authType.
-
Uses template:
- inPersonSigner
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, allowSystemOverrideForLockedRecipient, autoNavigation, autoRespondedReason, bulkSendV2Recipient, canSignOffline, clientUserId, completedCount, creationReason, customFields, declinedDateTime, declinedReason, defaultRecipient, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, hostEmail, hostEmailMetadata, hostName, hostNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, inPersonSigningType, inPersonSigningTypeMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, notaryHost, notaryId, note, noteMetadata, offlineAttributes, phoneAuthentication, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientSignatureProviders, recipientSuppliesTabs, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, requireSignerCertificate, requireSignOnPaper, requireUploadSignature, roleName, routingOrder, routingOrderMetadata, sentDateTime, signatureInfo, signedDateTime, signerEmail, signerEmailMetadata, signerFirstName, signerFirstNameMetadata, signerLastName, signerLastNameMetadata, signerName, signerNameMetadata, signInEachLocation, signInEachLocationMetadata, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- intermediary
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, phoneNumber, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- jurisdiction
Field components:
-
Uses template:
ShortText. - Contains the following components: allowSystemCreatedSeal, allowUserUploadedSeal, commissionIdInSeal, county, countyInSeal, enabled, jurisdictionId, name, notaryPublicInSeal, stateNameInSeal.
-
Uses template:
- jurisdictionSummary
Field components:
-
Uses template:
ShortText. - Contains the following components: authorizedForIPen, authorizedForRon, jurisdictionId, jurisdictionName.
-
Uses template:
- linkedExternalPrimaryAccount
Field components:
-
Uses template:
ShortText. - Contains the following components: accountName, configurationId, email, enableRecipientSafelist, exemptMembersOfSameAccountFromAuth, exemptSafelistMembersOfSameAccountFromAuth, linkId, pdfFieldHandlingOption, pdfFieldHandlingPrefillTabPermission, pdfFieldHandlingStandardInputTabPermission, pdfFieldHandlingStandardTabPermission, recipientAuthRequirements, recipientSafelistAuthRequirements, safelistRecipients, status, userId.
-
Uses template:
- listCustomField
Field components:
-
Uses template:
ShortText. - Contains the following components: configurationType, fieldId, listItems, name, required, show, value.
-
Uses template:
- listItem
Field components:
-
Uses template:
ShortText. - Contains the following components: selected, selectedMetadata, text, textMetadata, value, valueMetadata.
-
Uses template:
- localePolicy
Field components:
-
Uses template:
ShortText. - Contains the following components: addressFormat, addressFormatMetadata, allowRegion, calendarType, calendarTypeMetadata, cultureName, cultureNameMetadata, currencyCode, currencyCodeMetadata, currencyNegativeFormat, currencyNegativeFormatMetadata, currencyPositiveFormat, currencyPositiveFormatMetadata, customDateFormat, customSignDateFormat, customSignTimeFormat, customTimeFormat, dateFormat, dateFormatMetadata, effectiveAddressFormat, effectiveCalendarType, effectiveCurrencyCode, effectiveCurrencyNegativeFormat, effectiveCurrencyPositiveFormat, effectiveCustomDateFormat, effectiveCustomTimeFormat, effectiveDateFormat, effectiveInitialFormat, effectiveNameFormat, effectiveTimeFormat, effectiveTimeZone, initialFormat, initialFormatMetadata, nameFormat, nameFormatMetadata, signDateFormat, signDateFormatMetadata, signTimeFormat, signTimeFormatMetadata, timeFormat, timeFormatMetadata, timeZone, timeZoneMetadata.
-
Uses template:
- localePolicyTab
Field components:
-
Uses template:
ShortText. - Contains the following components: addressFormat, calendarType, cultureName, currencyCode, currencyNegativeFormat, currencyPositiveFormat, customDateFormat, customTimeFormat, dateFormat, initialFormat, nameFormat, timeFormat, timeZone, useLongCurrencyFormat.
-
Uses template:
- lockInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: lockDurationInSeconds, lockedByApp, lockedByUser, lockedUntilDateTime, lockToken, lockType, useScratchPad, templatePassword.
-
Uses template:
- matchBox
Field components:
-
Uses template:
ShortText. - Contains the following components: height, pageNumber, width, xPosition, yPosition.
-
Uses template:
- mergeField
Field components:
-
Uses template:
ShortText. - Contains the following components: allowSenderToEdit, allowSenderToEditMetadata, configurationType, configurationTypeMetadata, path, pathExtended, pathExtendedMetadata, pathMetadata, row, rowMetadata, writeBack, writeBackMetadata.
-
Uses template:
- money
Field components:
-
Uses template:
ShortText. - Contains the following components: amountInBaseUnit, currency, displayAmount.
-
Uses template:
- newAccountDefinition
Template: accountInformation. Field components:
-
Uses template:
ShortText. - Contains the following components: accountId, accountName, addressInformation, creditCardInformation, directDebitProcessorInformation, distributorCode, distributorPassword, enablePreAuth, envelopePartitionId, initialUser, paymentMethod, paymentProcessor, paymentProcessorInformation, planInformation, processPayment, referralInformation, socialAccountInformation, taxExemptId.
-
Uses template:
- notary
Field components:
-
Uses template:
DateTime. - Contains the following components: createdDate, enabled, searchable, userInfo.
-
Uses template:
- notaryContactDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: hasDocusignCertificate, jurisdictions.
-
Uses template:
- notaryHost
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, embeddedRecipientStartURL, faxNumber, faxNumberMetadata, hostRecipientId, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, phoneAuthentication, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- notaryJournal
Field components:
-
Uses template:
DateTime. - Contains the following components: createdDate, documentName, jurisdiction, notaryJournalId, notaryJournalMetaData, signerName.
-
Uses template:
- notaryJournalCredibleWitness
Field components:
-
Uses template:
ShortText. - Contains the following components: address, name, signatureImage.
-
Uses template:
- notaryJournalMetaData
Field components:
-
Uses template:
ShortText. - Contains the following components: comment, credibleWitnesses, signatureImage, signerIdType.
-
Uses template:
- notaryJurisdiction
Field components:
-
Uses template:
ShortText. - Contains the following components: jurisdictionId, commissionExpiration, commissionId, county, jurisdiction, registeredName, sealType.
-
Uses template:
- notaryRecipient
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, agentCanEditEmail, agentCanEditName, allowSystemOverrideForLockedRecipient, autoNavigation, autoRespondedReason, bulkRecipientsUri, bulkSendV2Recipient, canNotaryCorrectEnvelope, canSignOffline, clientUserId, completedCount, consentDetailsList, creationReason, customFields, declinedDateTime, declinedReason, defaultRecipient, delegatedBy, delegatedTo, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, isBulkRecipient, isBulkRecipientMetadata, lastName, lastNameMetadata, liveOakStartURL, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, notaryId, notarySignerEmailSent, notarySigners, notarySourceType, notaryThirdPartyPartner, notaryType, note, noteMetadata, offlineAttributes, phoneAuthentication, phoneNumber, proofFile, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientSignatureProviders, recipientSuppliesTabs, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, requireSignerCertificate, requireSignOnPaper, requireUploadSignature, roleName, routingOrder, routingOrderMetadata, sentDateTime, signatureInfo, signedDateTime, signInEachLocation, signInEachLocationMetadata, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- notaryResult
Field components:
-
Uses template:
jurisdiction. - Contains the following components: jurisdictions, notary, createdDate, enabled, searchable, userInfo.
-
Uses template:
- notification
Field components:
-
Uses template:
expirations. - Contains the following components: expirations, reminders, useAccountDefaults.
-
Uses template:
- number
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, formula, formulaMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- offlineAttributes
Field components:
-
Uses template:
ShortText. - Contains the following components: accountEsignId, deviceModel, deviceName, gpsLatitude, gpsLongitude, offlineSigningHash.
-
Uses template:
- page
Field components:
-
Uses template:
ShortText. - Contains the following components: dpi, height, imageBytes, mimeType, pageId, sequence, width.
-
Uses template:
- pageExtended
Template: page. Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, pageNumber, rotate, password.
-
Uses template:
- pageImages
Field components:
-
Uses template:
ShortText. - Contains the following components: endPosition, nextUri, pages, previousUri, resultSetSize, startPosition, totalSetSize.
-
Uses template:
- paletteItemSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: show.
-
Uses template:
- participant
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, consentDetailsList, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, note, noteMetadata, participateFor, participateForGuid, phoneAuthentication, phoneNumber, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- paletteSettings
Field components:
-
Uses template:
paletteItemSettings. - Contains the following components: annotations, custom, merge, notary, seals, smartContracts, smartSections.
-
Uses template:
- pathExtendedElement
Field components:
-
Uses template:
ShortText. - Contains the following components: name, type, typeName.
-
Uses template:
- paymentDetails
Field components:
-
Uses template:
LongText. - Contains the following components: allowedPaymentMethods, chargeId, currencyCode, currencyCodeMetadata, customerId, customMetadata, customMetadataRequired, gatewayAccountId, gatewayAccountIdMetadata, gatewayDisplayName, gatewayName, lineItems, paymentOption, paymentSourceId, signerValues, status, subGatewayName, total.
-
Uses template:
- paymentGatewayAccount
Field components:
-
Uses template:
paymentGatewayAccountSetting. - Contains the following components: allowCustomMetadata, config, displayName, isEnabled, isLegacy, lastModified, paymentGateway, paymentGatewayAccountId, paymentGatewayDisplayName, payPalLegacySettings, supportedCurrencies, supportedPaymentMethods, supportedPaymentMethodsWithOptions, zeroDecimalCurrencies.
-
Uses template:
- paymentGatewayAccountSetting
Field components:
-
Uses template:
ShortText. - Contains the following components: apiFields, authorizationCode, credentialStatus, merchantId.
-
Uses template:
- paymentLineItem
Field components:
-
Uses template:
ShortText. - Contains the following components: amountReference, description, itemCode, name.
-
Uses template:
- paymentMethodWithOptions
Field components:
-
Uses template:
LongText. - Contains the following components: supportedCurrencies, supportedOptions, type.
-
Uses template:
- paymentSignerValues
Field components:
-
Uses template:
ShortText. - Contains the following components: paymentOption.
-
Uses template:
- payPalLegacySettings
Field components:
-
Uses template:
ShortText. - Contains the following components: currency, partner, password, userName, vendor.
-
Uses template:
- permissionProfile
Field components:
-
Uses template:
ShortText. - Contains the following components: modifiedByUsername, modifiedDateTime, permissionProfileId, permissionProfileName, settings, userCount, users.
-
Uses template:
- polyLine
Field components:
-
Uses template:
ShortText. - Contains the following components: x1, x2, y1, y2.
-
Uses template:
- powerForm
Template: userInfoReadOnly. Field components:
-
Uses template:
ShortText. - Contains the following components: powerFormId, createdBy, createdDateTime, emailBody, emailSubject, envelopes, instructions, isActive, lastUsed, limitUseInterval, limitUseIntervalEnabled, limitUseIntervalUnits, maxUseEnabled, name, powerFormUrl, recipients, senderName, senderUserId, signingMode, templateId, templateName, timesUsed, uri, usesRemaining.
-
Uses template:
- powerFormFormDataEnvelope
Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, recipients.
-
Uses template:
- powerFormFormDataRecipient
Field components:
-
Uses template:
ShortText. - Contains the following components: email, formData, name, recipientId.
-
Uses template:
- powerFormRecipient
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeLocked, accessCodeRequired, email, emailLocked, idCheckConfigurationName, idCheckRequired, name, recipientType, roleName, routingOrder, templateRequiresIdLookup, userNameLocked.
-
Uses template:
- prefillFormData
Field components:
-
Uses template:
formDataItem. - Contains the following components: formData, senderEmail, senderName, senderUserId.
-
Uses template:
- propertyMetadata
Field components:
-
Uses template:
LongText. - Contains the following components: options, rights.
-
Uses template:
- radio
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, italic, italicMetadata, locked, lockedMetadata, mergeFieldXml, pageNumber, pageNumberMetadata, required, requiredMetadata, selected, selectedMetadata, status, statusMetadata, tabId, tabIdMetadata, tabOrder, tabOrderMetadata, underline, underlineMetadata, value, valueMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- radioGroup
Field components:
-
Uses template:
ShortText. - Contains the following components: conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, documentId, documentIdMetadata, groupName, groupNameMetadata, originalValue, originalValueMetadata, radios, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, tooltipMetadata, value, valueMetadata.
-
Uses template:
- recipientAdditionalNotification
Field components:
-
Uses template:
recipientPhoneNumber. - Contains the following components: phoneNumber, secondaryDeliveryMethod, secondaryDeliveryMethodMetadata, secondaryDeliveryStatus.
-
Uses template:
- recipientAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: attachmentId, attachmentType, data, label, name, remoteUrl.
-
Uses template:
- recipientEmailNotification
Field components:
-
Uses template:
ShortText. - Contains the following components: emailBody, emailBodyMetadata, emailSubject, emailSubjectMetadata, supportedLanguage, supportedLanguageMetadata.
-
Uses template:
- recipientEvent
Field components:
-
Uses template:
ShortText. - Contains the following components: includeDocuments, recipientEventStatusCode.
-
Uses template:
- recipientFormData
Field components:
-
Uses template:
ShortText. - Contains the following components: DeclinedTime, DeliveredTime, email, formData, name, recipientId, SentTime, SignedTime.
-
Uses template:
- recipientGroup
Field components:
-
Uses template:
ShortText. - Contains the following components: groupMessage, groupName, recipients.
-
Uses template:
- recipientIdentityInputOption
Field components:
-
Uses template:
ShortText. - Contains the following components: name, phoneNumberList, stringValue, valueType.
-
Uses template:
- recipientIdentityPhoneNumber
Field components:
-
Uses template:
ShortText. - Contains the following components: countryCode, countryCodeLock, countryCodeMetadata, extension, extensionMetadata, number, numberMetadata.
-
Uses template:
- recipientIdentityVerification
Field components:
-
Uses template:
recipientIdentityInputOption. - Contains the following components: inputOptions, workflowId, workflowIdMetadata, workflowLabel.
-
Uses template:
- recipientOption
Field components:
-
Uses template:
ShortText. - Contains the following components: email, name, recipientLabel, roleName, signingGroupId.
-
Uses template:
- recipientPhoneAuthentication
Field components:
-
Uses template:
ShortText. - Contains the following components: recipMayProvideNumber, recipMayProvideNumberMetadata, recordVoicePrint, recordVoicePrintMetadata, senderProvidedNumbers, senderProvidedNumbersMetadata, validateRecipProvidedNumber, validateRecipProvidedNumberMetadata.
-
Uses template:
- recipientPhoneNumber
Field components:
-
Uses template:
ShortText. - Contains the following components: countryCode, countryCodeMetadata, number, numberMetadata.
-
Uses template:
- recipientPreviewRequest
Template: ActionT. Field components:
-
Uses template:
ShortText. - Contains the following components: assertionId, authenticationInstant, authenticationMethod, clientURLs, pingFrequency, pingUrl, recipientId, returnUrl, securityDomain, xFrameOptions, xFrameOptionsAllowFromUrl.
-
Uses template:
- recipientProofFile
Field components:
-
Uses template:
ShortText. - Contains the following components: hasIdentityAttempts, isInProofFile.
-
Uses template:
- recipientRouting
Field components:
-
Uses template:
recipientRules. - Contains the following components: rules.
-
Uses template:
- recipientRules
Field components:
- An array.
-
Uses template:
conditionalRecipientRule.
- recipientSignatureInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: fontStyle, signatureInitials, signatureName.
-
Uses template:
- recipientSignatureProvider
Field components:
-
Uses template:
ShortText. - Contains the following components: sealDocumentsWithTabsOnly, sealName, signatureProviderName, signatureProviderNameMetadata, signatureProviderOptions.
-
Uses template:
- recipientSignatureProviderOptions
Field components:
-
Uses template:
ShortText. - Contains the following components: cpfNumber, cpfNumberMetadata, oneTimePassword, oneTimePasswordMetadata, signerRole, signerRoleMetadata, sms, smsMetadata.
-
Uses template:
- recipientSMSAuthentication
Field components:
-
Uses template:
LongText. - Contains the following components: senderProvidedNumbers, senderProvidedNumbersMetadata.
-
Uses template:
- recipientTokenClientURLs
Field components:
-
Uses template:
ShortText. - Contains the following components: onAccessCodeFailed, onCancel, onDecline, onException, onFaxPending, onIdCheckFailed, onSessionTimeout, onSigningComplete, onTTLExpired, onViewingComplete.
-
Uses template:
- recipientViewRequest
Field components:
-
Uses template:
ShortText. - Contains the following components: assertionId, authenticationInstant, authenticationMethod, clientURLs, clientUserId, displayFormat, email, frameAncestors, messageOrigins, pingFrequency, pingUrl, recipientId, returnUrl, securityDomain, userId, userName, xFrameOptions, xFrameOptionsAllowFromUrl.
-
Uses template:
- recipientView
Template: ActionT. Field components:
-
Uses template:
ShortText. - Contains the following components: envelopeId, assertionId, authenticationInstant, authenticationMethod, clientURLs, clientUserId, displayFormat, email, frameAncestors, messageOrigins, pingFrequency, pingUrl, recipientId, returnUrl, securityDomain, userId, userName, xFrameOptions, xFrameOptionsAllowFromUrl.
-
Uses template:
- reminders
Field components:
-
Uses template:
ShortText. - Contains the following components: reminderDelay, reminderEnabled, reminderFrequency.
-
Uses template:
- scheduledSending
Field components:
-
Uses template:
ShortText. - Contains the following components: bulkListId, resumeDate, rules, status.
-
Uses template:
- sealIdentifier
Field components:
-
Uses template:
ShortText. - Contains the following components: sealDisplayName, sealName.
-
Uses template:
- sealSign
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, allowSystemOverrideForLockedRecipient, autoRespondedReason, bulkSendV2Recipient, clientUserId, completedCount, customFields, declinedDateTime, declinedReason, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, emailNotification, embeddedRecipientStartURL, faxNumber, faxNumberMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, note, noteMetadata, phoneAuthentication, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientSignatureProviders, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, roleName, routingOrder, routingOrderMetadata, sentDateTime, signedDateTime, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- senderCompany
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, mergeField, mergeFieldXml, name, nameMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- senderEmailNotifications
Field components:
-
Uses template:
ShortText. - Contains the following components: changedSigner, clickwrapResponsesLimitNotificationEmail, commentsOnlyPrivateAndMention, commentsReceiveAll, deliveryFailed, envelopeComplete, offlineSigningFailed, powerformResponsesLimitNotificationEmail, purgeDocuments, recipientViewed, senderEnvelopeDeclined, withdrawnConsent.
-
Uses template:
- senderName
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, mergeField, mergeFieldXml, name, nameMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- serviceInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: buildBranch, buildBranchDeployedDateTime, buildSHA, buildVersion, linkedSites, serviceVersions, name, originalValue, value.
-
Uses template:
- serviceVersion
Field components:
-
Uses template:
ShortText. - Contains the following components: version, versionUrl.
-
Uses template:
- signatureGroup
Field components:
-
Uses template:
ShortText. - Contains the following components: groupId, groupName, rights.
-
Uses template:
- signatureProviderRequiredOption
Field components:
-
Uses template:
LongText. - Contains the following components: requiredSignatureProviderOptionIds, signerType.
-
Uses template:
- signatureType
Field components:
-
Uses template:
ShortText. - Contains the following components: isDefault, type.
-
Uses template:
- signatureUser
Field components:
-
Uses template:
ShortText. - Contains the following components: isDefault, rights, userId, userName.
-
Uses template:
- signer
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, agentCanEditEmail, agentCanEditName, allowSystemOverrideForLockedRecipient, autoNavigation, autoRespondedReason, bulkRecipientsUri, bulkSendV2Recipient, canSignOffline, clientUserId, completedCount, consentDetailsList, creationReason, customFields, declinedDateTime, declinedReason, defaultRecipient, delegatedBy, delegatedTo, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, isBulkRecipient, isBulkRecipientMetadata, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, notaryId, notarySignerEmailSent, note, noteMetadata, offlineAttributes, phoneAuthentication, phoneNumber, proofFile, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientSignatureProviders, recipientSuppliesTabs, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, requireSignerCertificate, requireSignOnPaper, requireUploadSignature, roleName, routingOrder, routingOrderMetadata, sentDateTime, signatureInfo, signedDateTime, signInEachLocation, signInEachLocationMetadata, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId.
-
Uses template:
- signerEmailNotifications
Field components:
-
Uses template:
ShortText. - Contains the following components: agentNotification, carbonCopyNotification, certifiedDeliveryNotification, commentsOnlyPrivateAndMention, commentsReceiveAll, documentMarkupActivation, envelopeActivation, envelopeComplete, envelopeCorrected, envelopeDeclined, envelopeVoided, faxReceived, offlineSigningFailed, purgeDocuments, reassignedSigner, whenSigningGroupMember.
-
Uses template:
- signingGroup
Field components:
-
Uses template:
DateTime. - Contains the following components: created, createdBy, groupEmail, groupName, groupType, modified, modifiedBy, signingGroupId, users.
-
Uses template:
- signingGroupUser
Field components:
-
Uses template:
ShortText. - Contains the following components: email, userName.
-
Uses template:
- signingGroupUsers
Field components:
- An array.
-
Uses template:
signingGroupUser.
- smartContractInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: code, uri.
-
Uses template:
- smartSectionAnchorPosition
Field components:
- Contains the following components: pageNumber, xPosition, yPosition.
- smartSectionCollapsibleDisplaySettings
Field components:
-
Uses template:
ShortText. - Contains the following components: arrowClosed, arrowColor, arrowLocation, arrowOpen, arrowSize, arrowStyle, containerStyle, labelStyle, onlyArrowIsClickable, outerLabelAndArrowStyle.
-
Uses template:
- smartSectionDisplaySettings
Field components:
-
Uses template:
ShortText. - Contains the following components: cellStyle, collapsibleSettings, display, displayLabel, displayOrder, displayPageNumber, hideLabelWhenOpened, inlineOuterStyle, labelWhenOpened, preLabel, scrollToTopWhenOpened, tableStyle.
-
Uses template:
- socialAccountInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: email, provider, socialId, userName.
-
Uses template:
- socialAuthentication
Field components:
-
Uses template:
ShortText. - Contains the following components: authentication.
-
Uses template:
- ssn
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- ssn4InformationInput
Field components:
-
Uses template:
ShortText. - Contains the following components: displayLevelCode, receiveInResponse, ssn4.
-
Uses template:
- ssn9InformationInput
Field components:
-
Uses template:
ShortText. - Contains the following components: displayLevelCode, ssn9.
-
Uses template:
- stamp
Field components:
-
Uses template:
DateTime. - Contains the following components: adoptedDateTime, createdDateTime, customField, dateStampProperties, disallowUserResizeStamp, externalID, imageBase64, imageType, lastModifiedDateTime, phoneticName, signatureName, stampFormat, stampImageUri, stampSizeMM, status.
-
Uses template:
- supportedLanguages
Field components:
- An array.
-
Uses template:
nameValue.
- tabAccountSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: allowTabOrder, allowTabOrderMetadata, approveDeclineTabsEnabled, approveDeclineTabsMetadata, calculatedFieldsEnabled, calculatedFieldsMetadata, checkboxTabsEnabled, checkBoxTabsMetadata, dataFieldRegexEnabled, dataFieldRegexMetadata, dataFieldSizeEnabled, dataFieldSizeMetadata, drawTabsEnabled, drawTabsMetadata, enableTabAgreementDetails, enableTabAgreementDetailsMetadata, firstLastEmailTabsEnabled, firstLastEmailTabsMetadata, listTabsEnabled, listTabsMetadata, noteTabsEnabled, noteTabsMetadata, numericalTabsEnabled, numericalTabsMetadata, prefillTabsEnabled, prefillTabsMetadata, radioTabsEnabled, radioTabsMetadata, savingCustomTabsEnabled, savingCustomTabsMetadata, senderToChangeTabAssignmentsEnabled, senderToChangeTabAssignmentsMetadata, sharedCustomTabsEnabled, sharedCustomTabsMetadata, tabDataLabelEnabled, tabDataLabelMetadata, tabLocationEnabled, tabLocationMetadata, tabLockingEnabled, tabLockingMetadata, tabScaleEnabled, tabScaleMetadata, tabTextFormattingEnabled, tabTextFormattingMetadata, textTabsEnabled, textTabsMetadata.
-
Uses template:
- tabGroup
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, caption, captionMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, documentId, documentIdMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, groupLabel, groupLabelMetadata, groupRule, groupRuleMetadata, height, heightMetadata, maximumAllowed, maximumAllowedMetadata, mergeField, mergeFieldXml, minimumRequired, minimumRequiredMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabOrder, tabOrderMetadata, tabScope, tabScopeMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, validationMessage, validationMessageMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- tabMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: anchor, anchorCaseSensitive, anchorHorizontalAlignment, anchorIgnoreIfNotPresent, anchorMatchWholeWord, anchorUnits, anchorXOffset, anchorYOffset, bold, collaborative, concealValueOnDocument, createdByDisplayName, createdByUserId, customTabId, disableAutoSize, editable, font, fontColor, fontSize, height, includedInEmail, initialValue, italic, items, lastModified, lastModifiedByDisplayName, lastModifiedByUserId, localePolicy, locked, maximumLength, maxNumericalValue, mergeField, minNumericalValue, name, numericalValue, paymentItemCode, paymentItemDescription, paymentItemName, requireAll, required, requireInitialOnSharedChange, scaleValue, selected, shared, signatureProviderId, stampType, stampTypeMetadata, tabLabel, type, underline, validationMessage, validationPattern, validationType, width.
-
Uses template:
- tab
Field components:
-
Uses template:
ShortText. - Contains the following components: documentId, tabId, anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, buttonText, buttonTextMetadata, caption, captionMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, mergeField, mergeFieldXml, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata, locked, lockedMetadata, name, nameMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, selected, selectedMetadata, selectedOriginal, selectedOriginalMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, comments, threadId, concealValueOnDocument, concealValueOnDocumentMetadata, disableAutoSize, disableAutoSizeMetadata, maxLength, maxLengthMetadata, originalValue, originalValueMetadata, value, valueMetadata, requireAll, requireAllMetadata, senderRequired, senderRequiredMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, declineReason, declineReasonMetadata, allowSignerUpload, useBackgroundAsCanvas, formula, formulaMetadata, hidden, hiddenMetadata, isPaymentAmountMetadata, paymentDetails, roundDecimalPlaces, roundDecimalPlacesMetadata, handDrawRequired, optional, optionalMetadata, scaleValue, scaleValueMetadata, listItems, listSelectedValue, listSelectedValueMetadata, maxNumericalValue, minNumericalValue, numericalValue, originalNumericalValue, validationType, graphicsContext, overlayType, overlayTypeMetadata, polyLines, checkboxTabs, dateTabs, emailTabs, numberTabs, radioGroupTabs, senderCompanyTabs, senderNameTabs, ssnTabs, tabGroups, textTabs, zipTabs, groupName, groupNameMetadata, radios, tooltipMetadata, isSealSignTab, stamp, stampType, stampTypeMetadata, caseSensitive, displaySettings, endAnchor, endPosition, removeEndAnchor, removeStartAnchor, startAnchor, startPosition, groupLabel, groupLabelMetadata, groupRule, groupRuleMetadata, maximumAllowed, maximumAllowedMetadata, minimumRequired, minimumRequiredMetadata, tabScope, tabScopeMetadata, requiredRead, useDash4, useDash4Metadata.
-
Uses template:
- templateMatch
Field components:
-
Uses template:
ShortText. - Contains the following components: documentEndPage, documentStartPage, matchPercentage.
-
Uses template:
- templateSummary
Template: documentTemplate. Field components:
-
Uses template:
ShortText. - Contains the following components: applied, documentId, documentName, hasDocumentTemplateLibrary, name, templateId, templateMatch, uri.
-
Uses template:
- templateViewRequest
Field components:
-
Uses template:
ShortText. - Contains the following components: returnUrl, viewAccess.
-
Uses template:
- text
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, formula, formulaMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
- usageHistory
Field components:
-
Uses template:
DateTime. - Contains the following components: lastSentDateTime, lastSignedDateTime, sentCount, signedCount.
-
Uses template:
- userAccountManagementGranularInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: canManageAccountSecuritySettings, canManageAccountSecuritySettingsMetadata, canManageAccountSettings, canManageAccountSettingsMetadata, canManageAdmins, canManageAdminsMetadata, canManageConnect, canManageConnectMetadata, canManageDocumentRetention, canManageDocumentRetentionMetadata, canManageEnvelopeTransfer, canManageEnvelopeTransferMetadata, canManageGroupsButNotUsers, canManageGroupsButNotUsersMetadata, canManageJointAgreements, canManageJointAgreementsMetadata, canManageReporting, canManageReportingMetadata, canManageSharing, canManageSharingMetadata, canManageSigningGroups, canManageSigningGroupsMetadata, canManageStamps, canManageStampsMetadata, canManageUsers, canManageUsersMetadata, canViewUsers.
-
Uses template:
- userAuthorization
-
Field components:
-
Uses template:
authorizationUser. - Contains the following components: agentUser, authorizationId, created, createdBy, endDate, modified, modifiedBy, permission, principalUser, startDate.
-
Uses template:
- userInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: isIncluded, accountId, accountName, activationAccessCode, email, ipAddress, loginStatus, membershipId, sendActivationEmail, uri, userId, userName, userStatus, userType.
-
Uses template:
- userInfoReadOnly
Template: userInfo. A read-only field.
- userInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: activationAccessCode, company, connectConfigurations, countryCode, createdDateTime, customSettings, defaultAccountId, email, enableConnectForUser, firstName, forgottenPasswordInfo, groupList, hasRemoteNotary, homeAddress, initialsImageUri, isAdmin, isAlternateAdmin, isManagedByScim, isMembershipManagedByScim, isNAREnabled, jobTitle, lastLogin, lastName, loginStatus, middleName, password, passwordExpiration, permissionProfileId, permissionProfileName, profileImageUri, sendActivationEmail, sendActivationOnInvalidLogin, signatureImageUri, subscribe, suffixName, title, uri, userAddedToAccountDateTime, userId, userName, userProfileLastModifiedDate, userStatus, userType, workAddress.
-
Uses template:
- userProfile
Field components:
-
Uses template:
addressInformation. - Contains the following components: address, authenticationMethods, companyName, displayOrganizationInfo, displayPersonalInfo, displayProfile, displayUsageHistory, profileImageUri, title, usageHistory, userDetails, userProfileLastModifiedDate.
-
Uses template:
- userSettingsInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: accountAgreementsAccessType, accountAgreementsAccessTypeMetadata, accountManagementGranular, adminOnly, adminOnlyMetadata, allowAccessToAllAccountAgreements, allowAccessToAllAccountAgreementsMetadata, allowAutoTagging, allowedDocumentTemplateLibraryAccess, allowedDocumentTemplateLibraryAccessMetadata, allowedOrchestrationAccess, allowedOrchestrationAccessMetadata, allowEnvelopeTransferTo, allowEnvelopeTransferToMetadata, allowEsealRecipients, allowEsealRecipientsMetadata, allowPowerFormsAdminToAccessAllPowerFormEnvelope, allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata, allowRecipientLanguageSelection, allowRecipientLanguageSelectionMetadata, allowSendOnBehalfOf, allowSendOnBehalfOfMetadata, allowSupplementalDocuments, allowSupplementalDocumentsMetadata, allowTransactions, allowTransactionsMetadata, anchorTagVersionedPlacementEnabled, apiAccountWideAccess, apiAccountWideAccessMetadata, apiCanExportAC, apiCanExportACMetadata, bulkSend, bulkSendMetadata, canBulkUploadAgreements, canBulkUploadAgreementsMetadata, canChargeAccount, canChargeAccountMetadata, canCreateTransaction, canCreateTransactionMetadata, canDeleteDocumentsInTransaction, canDeleteDocumentsInTransactionMetadata, canDeleteTransaction, canDeleteTransactionMetadata, canEditSharedAddressbook, canEditSharedAddressbookMetadata, canLockEnvelopes, canLockEnvelopesMetadata, canManageAccount, canManageAccountMetadata, canManageAgreementParties, canManageAgreementPartiesMetadata, canManageDistributor, canManageDistributorMetadata, canManageTemplates, canManageTemplatesMetadata, canSendAPIRequests, canSendAPIRequestsMetadata, canSendEnvelope, canSendEnvelopeMetadata, canSendEnvelopesViaSMS, canSendEnvelopesViaSMSMetadata, canSignEnvelope, canSignEnvelopeMetadata, canUseScratchpad, canUseScratchpadMetadata, canUseSmartContracts, canUseSmartContractsMetadata, disableDocumentUpload, disableDocumentUploadMetadata, disableOtherActions, disableOtherActionsMetadata, enableDSPro, enableDSProMetadata, enableKeyTermsSuggestionsByDocumentType, enableKeyTermsSuggestionsByDocumentTypeMetadata, enableSequentialSigningAPI, enableSequentialSigningAPIMetadata, enableSequentialSigningUI, enableSequentialSigningUIMetadata, enableSignerAttachments, enableSignerAttachmentsMetadata, enableSignOnPaperOverride, enableSignOnPaperOverrideMetadata, enableTransactionPoint, enableTransactionPointMetadata, enableVaulting, enableVaultingMetadata, expressSendOnly, isManagedByScim, isManagedByScimMetadata, isMembershipManagedByScim, isMembershipManagedByScimMetadata, locale, localeMetadata, localePolicy, manageClickwrapsMode, manageClickwrapsModeMetadata, modifiedBy, modifiedByMetadata, modifiedDate, modifiedDateMetadata, modifiedPage, modifiedPageMetadata, newSendUI, newSendUIMetadata, powerFormMode, powerFormModeMetadata, recipientViewedNotification, recipientViewedNotificationMetadata, sealIdentifiers, selfSignedRecipientEmailDocument, selfSignedRecipientEmailDocumentMetadata, senderEmailNotifications, signerEmailNotifications, supplementalDocumentIncludeInDownload, supplementalDocumentsMustAccept, supplementalDocumentsMustAcceptMetadata, supplementalDocumentsMustRead, supplementalDocumentsMustReadMetadata, supplementalDocumentsMustView, supplementalDocumentsMustViewMetadata, templateActiveCreation, templateActiveCreationMetadata, templateApplyNotify, templateApplyNotifyMetadata, templateAutoMatching, templateAutoMatchingMetadata, templateMatchingSensitivity, templateMatchingSensitivityMetadata, templatePageLevelMatching, templatePageLevelMatchingMetadata, timezoneDST, timezoneDSTMetadata, timezoneMask, timezoneMaskMetadata, timezoneOffset, timezoneOffsetMetadata, timezoneSendingPref, timezoneSendingPrefMetadata, timezoneSigningPref, timezoneSigningPrefMetadata, transactionPointSiteNameURL, transactionPointSiteNameURLMetadata, transactionPointUserName, transactionPointUserNameMetadata, vaultingMode, vaultingModeMetadata, webForms, webFormsMetadata.
-
Uses template:
- userSignature
Field components:
-
Uses template:
DateTime. - Contains the following components: adoptedDateTime, createdDateTime, customField, dateStampProperties, disallowUserResizeStamp, externalID, imageBase64, imageType, initials150ImageId, initialsImageUri, isDefault, lastModifiedDateTime, nrdsId, nrdsLastName, nrdsStatus, phoneticName, signature150ImageId, signatureFont, signatureId, signatureImageUri, signatureInitials, signatureName, signatureRights, signatureType, stampFormat, stampImageUri, stampSizeMM, stampType, status.
-
Uses template:
- watermark
Field components:
-
Uses template:
ShortText. - Contains the following components: id, displayAngle, enabled, font, fontColor, fontSize, imageBase64, transparency, watermarkText.
-
Uses template:
- witness
Field components:
-
Uses template:
ShortText. - Contains the following components: accessCode, accessCodeMetadata, addAccessCodeToEmail, additionalNotifications, agentCanEditEmail, agentCanEditName, allowSystemOverrideForLockedRecipient, autoNavigation, autoRespondedReason, bulkRecipientsUri, bulkSendV2Recipient, canSignOffline, clientUserId, completedCount, consentDetailsList, creationReason, customFields, declinedDateTime, declinedReason, defaultRecipient, delegatedBy, delegatedTo, deliveredDateTime, deliveryMethod, deliveryMethodMetadata, designatorId, designatorIdGuid, documentTemplateId, documentVisibility, email, emailMetadata, emailNotification, emailRecipientPostSigningURL, embeddedRecipientStartURL, excludedDocuments, faxNumber, faxNumberMetadata, firstName, firstNameMetadata, fullName, fullNameMetadata, idCheckConfigurationName, idCheckConfigurationNameMetadata, idCheckInformationInput, identityVerification, inheritEmailNotificationConfiguration, isBulkRecipient, isBulkRecipientMetadata, lastName, lastNameMetadata, lockedRecipientPhoneAuthEditable, lockedRecipientSmsEditable, name, nameMetadata, notaryId, notarySignerEmailSent, note, noteMetadata, offlineAttributes, phoneAuthentication, phoneNumber, proofFile, recipientAttachments, recipientAuthenticationStatus, recipientFeatureMetadata, recipientId, recipientIdGuid, recipientSignatureProviders, recipientSuppliesTabs, recipientType, recipientTypeMetadata, requireIdLookup, requireIdLookupMetadata, requireSignerCertificate, requireSignOnPaper, requireUploadSignature, roleName, routingOrder, routingOrderMetadata, sentDateTime, signatureInfo, signedDateTime, signInEachLocation, signInEachLocationMetadata, signingGroupId, signingGroupIdMetadata, signingGroupName, signingGroupUsers, smsAuthentication, socialAuthentications, status, statusCode, suppressEmails, templateLocked, templateRequired, totalTabCount, userId, webFormRecipientViewId, witnessFor, witnessForGuid.
-
Uses template:
- workflow
Field components:
-
Uses template:
ShortText. - Contains the following components: currentWorkflowStepId, resumeDate, scheduledSending, workflowStatus, workflowSteps.
-
Uses template:
- workflowStep
Field components:
-
Uses template:
ShortText. - Contains the following components: workflowStepId, action, completedDate, delayedRouting, itemId, recipientRouting, status, triggeredDate, triggerOnItem.
-
Uses template:
- workspace
Field components:
-
Uses template:
ShortText. - Contains the following components: billableAccountId, callerInformation, created, createdByInformation, lastModified, lastModifiedByInformation, settings, status, workspaceBaseUrl, workspaceDescription, workspaceId, workspaceName, workspaceUri.
-
Uses template:
- workspaceItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, callerAuthorization, contentType, created, createdById, createdByInformation, extension, fileSize, fileUri, isPublic, lastModified, lastModifiedById, lastModifiedByInformation, name, pageCount, parentFolderId, parentFolderUri, sha256, thumbHeight, thumbnail, thumbWidth, type, uri, userAuthorization.
-
Uses template:
- workspaceSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: commentsAllowed.
-
Uses template:
- workspaceUser
Field components:
-
Uses template:
ShortText. - Contains the following components: accountId, accountName, activeSince, created, createdById, email, invitationEmailBlurb, invitationEmailSubject, lastModified, lastModifiedById, status, type, userId, userName, workspaceId, workspaceUserBaseUrl, workspaceUserId, workspaceUserUri.
-
Uses template:
- workspaceUserAuthorization
Field components:
-
Uses template:
ShortText. - Contains the following components: canDelete, canMove, canTransact, canView, created, createdById, modified, modifiedById, workspaceUserId, workspaceUserInformation.
-
Uses template:
- zip
Field components:
-
Uses template:
ShortText. - Contains the following components: anchorAllowWhiteSpaceInCharacters, anchorAllowWhiteSpaceInCharactersMetadata, anchorCaseSensitive, anchorCaseSensitiveMetadata, anchorHorizontalAlignment, anchorHorizontalAlignmentMetadata, anchorIgnoreIfNotPresent, anchorIgnoreIfNotPresentMetadata, anchorMatchWholeWord, anchorMatchWholeWordMetadata, anchorString, anchorStringMetadata, anchorTabProcessorVersion, anchorTabProcessorVersionMetadata, anchorUnits, anchorUnitsMetadata, anchorXOffset, anchorXOffsetMetadata, anchorYOffset, anchorYOffsetMetadata, bold, boldMetadata, caption, captionMetadata, concealValueOnDocument, concealValueOnDocumentMetadata, conditionalParentLabel, conditionalParentLabelMetadata, conditionalParentValue, conditionalParentValueMetadata, customTabId, customTabIdMetadata, disableAutoSize, disableAutoSizeMetadata, documentId, documentIdMetadata, font, fontColor, fontColorMetadata, fontMetadata, fontSize, fontSizeMetadata, formOrder, formOrderMetadata, formPageLabel, formPageLabelMetadata, formPageNumber, formPageNumberMetadata, height, heightMetadata, italic, italicMetadata, localePolicy, locked, lockedMetadata, maxLength, maxLengthMetadata, mergeField, mergeFieldXml, name, nameMetadata, originalValue, originalValueMetadata, pageNumber, pageNumberMetadata, recipientId, recipientIdGuid, recipientIdGuidMetadata, recipientIdMetadata, requireAll, requireAllMetadata, required, requiredMetadata, requireInitialOnSharedChange, requireInitialOnSharedChangeMetadata, senderRequired, senderRequiredMetadata, shared, sharedMetadata, shareToRecipients, shareToRecipientsMetadata, smartContractInformation, source, status, statusMetadata, tabGroupLabels, tabGroupLabelsMetadata, tabId, tabIdMetadata, tabLabel, tabLabelMetadata, tabOrder, tabOrderMetadata, tabType, tabTypeMetadata, templateLocked, templateLockedMetadata, templateRequired, templateRequiredMetadata, tooltip, toolTipMetadata, underline, underlineMetadata, useDash4, useDash4Metadata, validationMessage, validationMessageMetadata, validationPattern, validationPatternMetadata, value, valueMetadata, warningDetails, width, widthMetadata, xPosition, xPositionMetadata, yPosition, yPositionMetadata.
-
Uses template:
Knowledge Base
Related scripts
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.





