DocuSign: Esignature schemas (part 13)
43 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Adds updates a user signature — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
userSignatures | array | Optional | An array of `userSignature` objects. |
userSignatures[] | Model | Each item | Expand Updates the user signature for a specified user — response body |
Referenced models: Updates the user signature for a specified user — response body
Applies a bulk action to all envelopes from a specified bulk send — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Optional | The action to apply. Valid values: * `Resend` * `Correct` * `Void` This property is required and case-sensitive. The value must correspond to the `bulkAction` query parameter. |
notification | Model | Optional | Expand Gets envelope notification information — response body The notification settings to apply to the bulk send envelopes. This property is required if `action` is `Correct`. |
voidReason | string | Optional | A string explaining why the envelope is voided. This value is shown in a message to the recipients. This property is required if `action` is `Void`. |
Referenced models: Gets envelope notification information — response body
Commit a chunked upload — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This response object is returned after you upload a chunked upload. |
checksum | string | Optional | A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused. |
chunkedUploadId | string | Optional | The ID of the chunked upload. |
chunkedUploadParts | array | Optional | A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload. |
chunkedUploadParts[] | Model | Each item | Expand Commit a chunked upload — response body — chunked Upload Parts item |
chunkedUploadUri | string | Optional | The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. |
committed | string | Optional | When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. |
expirationDateTime | string | Optional | The UTC time at which the chunked upload expires and is no longer addressable. **Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it. |
maxChunkedUploadParts | string | Optional | The maximum number of parts allowed for a chunked upload. This value is configurable per Docusign environment, account, or integrator. The default value is 128. The maximum possible value is 256. |
maxTotalSize | string | Optional | The maximum total size allowed for a chunked upload. This value is configured per Docusign environment, account, or integrator. The default value is 50 MB. |
totalSize | string | Optional | The total size of the parts of the chunked upload. **Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents. |
Referenced models: Commit a chunked upload — response body — chunked Upload Parts item
Commit a chunked upload — response body — chunked Upload Parts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object that contains information about the chunked upload part. |
sequence | string | Optional | The order of the part in the chunked upload. |
size | string | Optional | The size of the part in bytes. Docusign recommends that a chunked upload part is no larger than a few MB in size. |
Creates a BCC email archive configuration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information abut a BCC email archive configuration (a BCC email address used to archive Docusign-generated emails). |
accountId | string | Optional | The ID of the account that owns the BCC email archive configuration. |
bccEmailArchiveId | string | Optional | The ID of the BCC email archive configuration. |
created | string | Optional | The UTC DateTime when the BCC email archive configuration was created. |
createdBy | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Details about the user who created the BCC email archive configuration. |
email | string | Optional | The BCC email address to use for archiving Docusign messages. Example: customer_bcc@example.com |
emailNotificationId | string | Optional | The GUID of the activation email message sent to the BCC email address. |
modified | string | Optional | The UTC DateTime when the BCC email archive configuration was last modified. |
modifiedBy | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Details about the user who last modified the BCC email archive configuration. |
status | string | Optional | The status of the BCC email address. Possible values are: - `activation_sent`: An activation link has been sent to the BCC email address. - `active`: The BCC email address is actively used for archiving. - `closed`: The BCC email address is no longer used for archiving. |
uri | string | Optional | The helper URI for retrieving the BCC email archive. |
Referenced models: Gets a specific template associated with a specified account — response body — owner
Creates a Connect configuration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The `connectCustomConfiguration` object describes a Connect configuration for your account. |
allUsers | string | Optional | When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.** **Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
allUsersExcept | string | Optional | This flag enables you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.** This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
allowEnvelopePublish | string | Optional | Set this value to **true** to enable the webhook. The default property is **false.** |
allowSalesforcePublish | string | Optional | When **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.** This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
configurationType | string | Optional | The type of the configuration. Valid values: * `custom`: Creates an account-level configuration * `customrecipient`: Creates a Recipient Connect configuration * `salesforce` * `eOriginal` This property is required. |
connectId | string | Optional | The Docusign-generated ID for the Connect configuration. This property is read-only. |
deliveryMode | string | Optional | The delivery mode of the configuration. Valid values: * `SIM` * `Aggregate` This property is required. |
disabledBy | string | Optional | |
enableLog | string | Optional | When **true,** Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues. You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console. This property is required. |
enableOAuthPerConfiguration | string | Optional | |
envelopeEvents | array | Optional | A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. When using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `Delivered` * `Completed` * `Declined` * `Voided` **Note:** These values are case-sensitive. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
envelopeEvents[] | string | Each item | |
eventData | Model | Optional | Expand Creates a Connect configuration — response body — event Data Allows you to specify the format of the information the Connect webhooks returns. This property is required. |
events | array | Optional | A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property. Set this property when you are using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property. The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) are: * `envelope-created` * `envelope-sent` * `envelope-resent` * `envelope-delivered` * `envelope-completed` * `envelope-declined` * `envelope-voided` * `recipient-authenticationfailed` * `recipient-autoresponded` * `recipient-declined` * `recipient-delivered` * `recipient-completed` * `recipient-sent` * `recipient-resent` * `template-created` * `template-modified` * `template-deleted` * `envelope-corrected` * `envelope-purge` * `envelope-deleted` * `envelope-discard` * `recipient-reassign` * `recipient-delegate` * `recipient-finish-later` * `click-agreed` * `click-declined` This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
events[] | string | Each item | |
externalFolderId | string | Optional | The ID of an external folder. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
externalFolderLabel | string | Optional | The label for an external folder. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
groupIds | array | Optional | |
groupIds[] | string | Each item | |
includeCertSoapHeader | string | Optional | |
includeCertificateOfCompletion | string | Optional | When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
includeDocumentFields | string | Optional | When **true,** the document fields associated with the envelope's documents are included in the notification messages. Document fields are optional custom name-value pairs added to documents using the API. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
includeDocuments | string | Optional | Reserved for Docusign. |
includeEnvelopeVoidReason | string | Optional | When **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
includeHMAC | string | Optional | When **true,** Connect will use HMAC to verify the request. This property is required. |
includeOAuth | string | Optional | |
includeSenderAccountasCustomField | string | Optional | When **true,** Connect will include the sender account as custom field in the data. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
includeTimeZoneInformation | string | Optional | When **true,** Connect will include the envelope time zone information. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
integratorManaged | string | Optional | |
name | string | Optional | The name of the Connect configuration. This property is required. |
oAuthConfiguration | Model | Optional | Expand Set up Connect O Auth for the specified account — response body |
password | string | Optional | The password for the Connect configuration. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
pausePublish | string | Optional | |
recipientEvents | array | Optional | An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the `url` property. When using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property. The [possible event statuses](/platform/webhooks/connect/event-triggers/) are: * `Sent` * `AutoResponded` * `Delivered` * `Completed` * `Declined` * `AuthenticationFailed` **Note:** These values are case-sensitive. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
recipientEvents[] | string | Each item | |
requireMutualTls | string | Optional | When **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
requiresAcknowledgement | string | Optional | When **true,** event delivery acknowledgements are enabled for your Connect configuration. Docusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back. #### When **true** and Send Individual Messages (SIM) mode is activated If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down. The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead, they will be immediately queued with the reason `Pending`. When a message succeeds, all queued messages for the configuration will be tried immediately, in order. There is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification. #### When **true** and SIM mode is not activated If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification. #### When **false** When `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually. This property is required. |
salesforceApiVersion | string | Optional | The version of the Salesforce API that you are using. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
salesforceAuthcode | string | Optional | |
salesforceCallBackUrl | string | Optional | |
salesforceDocumentsAsContentFiles | string | Optional | When **true,** Docusign can use documents in your Salesforce account for sending and signing. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
senderOverride | string | Optional | |
senderSelectableItems | array | Optional | This property sets the items that are available for selection when adding or editing Connect objects. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
senderSelectableItems[] | string | Each item | |
sfObjects | array | Optional | An array of Salesforce objects. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
sfObjects[] | Model | Each item | Expand Creates a Connect configuration — response body — sf Objects item |
signMessageWithX509Certificate | string | Optional | When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. This property is required. |
soapNamespace | string | Optional | The namespace of the SOAP interface. **Note:** If `useSoapInterface` is set to **true,** you must set this value. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
urlToPublishTo | string | Optional | The web address of the listener or retrieving service endpoint. It must be an HTTPS URL. This property is required. |
useSoapInterface | string | Optional | When **true,** the notifications are sent to your endpoint as SOAP requests. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
userIds | array | Optional | A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. By default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.** **Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
userIds[] | string | Each item | |
userName | string | Optional | The name of the user. This property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint. |
Referenced models: Creates a Connect configuration — response body — event Data, Set up Connect O Auth for the specified account — response body, Creates a Connect configuration — response body — sf Objects item
Creates a Connect configuration — response body — event Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object lets you choose the data format of your Connect response. |
format | string | Optional | Reserved for Docusign. |
includeData | array | Optional | A string array of the data to be included. The default is the empty array `[]`. - `attachments`: Include attachments associated with the envelope. - `custom_fields`: Include the custom fields associated with the envelope. - `documents`: Include the documents associated with the envelope. - `extensions`: Include information about the email settings associated with the envelope. - `folders`: Include the folder where the envelope exists. - `payment_tabs`: Include the payment tabs associated with the envelope. - `powerform`: Include the PowerForms associated with the envelope. - `prefill_tabs`: Include the [pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope. - `recipients`: Include the recipients associated with the envelope. - `tabs`: Include the tabs associated with the envelope. |
includeData[] | string | Each item | |
version | string | Optional | Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default. |
Creates a Connect configuration — response body — sf Objects item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account. When you install Docusign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize Docusign Connect for Salesforce by associating Docusign objects with Salesforce objects so that Docusign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see [Docusign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New). |
active | string | Optional | When **true,** the `connectSalesforceObject` is active. |
description | string | Optional | A description of the `connectSalesforceObject`. |
id | string | Optional | The ID of the `connectSalesforceObject`. |
insert | string | Optional | |
onCompleteOnly | string | Optional | When **true,** Salesforce is updated only when the envelope is complete. |
selectFields | array | Optional | The Docusign and Salesforce fields that you want to use to match a Salesforce object with Docusign information. This information tells Connect when to send updates to Salesforce. |
selectFields[] | Model | Each item | Expand Creates a Connect configuration — response body — sf Objects item select Fields item |
sfObject | string | Optional | The Salesforce.com object type, such as `case`, `contact`, or `opportunity`. |
sfObjectName | string | Optional | A name for the Salesforce object. **Note:** You can enter any name for the object. It does not have to match the `sfObject` property. |
updateFields | array | Optional | The Docusign and Salesforce fields that you want to update. **Note:** You can choose to update SalesForce (with information from Docusign) only, update Docusign only, or both. |
updateFields[] | Model | Each item | Expand Creates a Connect configuration — response body — sf Objects item select Fields item |
Referenced models: Creates a Connect configuration — response body — sf Objects item select Fields item
Creates a Connect configuration — response body — sf Objects item select Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used to match a Docusign field to a Salesforce field so that Docusign can send information to your Salesforce account. |
dsAttribute | string | Optional | |
dsLink | string | Optional | A URL that links to the information in the Docusign field. |
dsNode | string | Optional | |
id | string | Optional | A unique ID for the Salesforce object. |
sfField | string | Optional | |
sfFieldName | string | Optional | The name of the Salesforce field. |
sfFolder | string | Optional | The name of the Salesforce folder. |
sfLockedValue | string | Optional |
Creates a bulk send list — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the details for the bulk send list. |
bulkCopies | array | Optional | An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information. |
bulkCopies[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item |
listId | string | Optional | The GUID of the bulk send list. |
name | string | Optional | The name of the bulk send list. |
Referenced models: Creates a bulk send list — response body — bulk Copies item
Creates a bulk send list — response body — bulk Copies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance. |
customFields | array | Optional | The custom fields for this copy of the envelope. **Note:** These custom fields must also be included in the original envelope or template that you want to send. |
customFields[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item custom Fields item |
docGenFormFields | array | Optional | |
docGenFormFields[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item |
emailBlurb | string | Optional | The email body for this copy of the envelope. |
emailSubject | string | Optional | The email subject line for this copy of the envelope. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
prefillTabs | array | Optional | Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
prefillTabs[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item prefill Tabs item |
recipients | array | Optional | Information about the recipients associated with this copy of the envelope. |
recipients[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item recipients item |
Referenced models: Creates a bulk send list — response body — bulk Copies item custom Fields item, Creates a bulk send list — response body — bulk Copies item prefill Tabs item, Creates a bulk send list — response body — bulk Copies item recipients item, Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item
Creates a bulk send list — response body — bulk Copies item custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send. |
name | string | Optional | The name of the custom field. |
value | string | Optional | The value of the custom field. |
Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | |
rowValues | array | Optional | |
rowValues[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item row Values item |
value | string | Optional | Specifies the value of the tab. |
Referenced models: Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item row Values item
Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item row Values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
docGenFormFieldList | array | Optional | |
docGenFormFieldList[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item |
Referenced models: Creates a bulk send list — response body — bulk Copies item doc Gen Form Fields item
Creates a bulk send list — response body — bulk Copies item prefill Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
initialValue | string | Optional | The original value of the tab. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
Creates a bulk send list — response body — bulk Copies item recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a bulk send recipient. |
accessCode | string | Optional | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. |
clientUserId | string | Optional | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. |
customFields | array | Optional | An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. |
customFields[] | string | Each item | |
deliveryMethod | string | Optional | The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ |
email | string | Optional | The recipient's email address. |
emailNotification | Model | Optional | Expand Deletes recipients from a template — response body — seals item email Notification This optional property allows you to set a specific email subject and body for this recipient's notification email. **Note:** If you use this property, you _must_ provide a value for the `supportedLanguage` sub-property. You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients are assigned the values from the top-level `emailSubject` and `emailBlurb`. |
embeddedRecipientStartURL | string | Optional | Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |
faxNumber | string | Optional | Reserved for Docusign. |
hostEmail | string | Optional | The email address of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. |
hostName | string | Optional | The name of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. |
idCheckConfigurationName | string | Optional | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckInformationInput | Model | Optional | Expand Deletes recipients from a template — response body — seals item id Check Information Input An object that contains input information related to a recipient ID check. |
identificationMethod | string | Optional | |
identityVerification | Model | Optional | Expand Deletes recipients from a template — response body — seals item identity Verification Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |
name | string | Optional | |
note | string | Optional | A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. |
phoneAuthentication | Model | Optional | Expand Deletes recipients from a template — response body — seals item phone Authentication When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for Docusign. * `validateRecipProvidedNumber`: Reserved for Docusign. |
recipientId | string | Optional | A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. |
recipientSignatureProviders | array | Optional | The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) |
recipientSignatureProviders[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item recipient Signature Providers item |
roleName | string | Optional | The name of the role associated with the recipient. **Note:** Every recipient must be assigned either a `recipientId` or a `roleName` but not both. You cannot use `roleName` and `recipientId` in the same list. |
signerName | string | Optional | The in-person signer's full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. |
signingGroupId | string | Optional | The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). |
smsAuthentication | Model | Optional | Expand Deletes recipients from a template — response body — seals item sms Authentication When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. |
socialAuthentications | array | Optional | Deprecated. |
socialAuthentications[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item social Authentications item |
tabs | array | Optional | A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information. You can use the following types of tabs to match bulk send recipients to an envelope: - Text tabs - Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list) - List tabs |
tabs[] | Model | Each item | Expand Creates a bulk send list — response body — bulk Copies item recipients item tabs item |
Referenced models: Creates a bulk send list — response body — bulk Copies item recipients item tabs item, Deletes recipients from a template — response body — seals item id Check Information Input, Deletes recipients from a template — response body — seals item email Notification, Deletes recipients from a template — response body — seals item identity Verification, Deletes recipients from a template — response body — seals item phone Authentication, Deletes recipients from a template — response body — seals item sms Authentication, Deletes recipients from a template — response body — seals item recipient Signature Providers item, Deletes recipients from a template — response body — seals item social Authentications item
Creates a bulk send list — response body — bulk Copies item recipients item tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information. |
initialValue | string | Optional | The initial value that you want to assign to the tab. |
tabLabel | string | Optional | The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. Maximum Length: 500 characters. |
Creates a bulk send request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The object contains the response to a bulk send request. |
batchId | string | Optional | A batch identifier that you can use to get the status of the batch. |
batchName | string | Optional | |
batchSize | string | Optional | The total number of items in the batch being queried. |
envelopeOrTemplateId | string | Optional | The GUID of the envelope or template that was sent. |
errorDetails | array | Optional | A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests. |
errorDetails[] | string | Each item | |
errors | array | Optional | A list of errors that occurred. This information is intended to be parsed by machine. |
errors[] | string | Each item | |
queueLimit | string | Optional | |
totalQueued | string | Optional |
Creates a bulk send test — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about the envelope or template that you want to send in bulk. |
batchName | string | Optional | The human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object. |
envelopeOrTemplateId | string | Optional | The GUID of the envelope or template that you want to send in bulk. |
Creates a bulk send test — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the results of a bulk send test. |
canBeSent | boolean | Optional | When **true,** the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend: createBulkSendRequest][BulkSendRequest] method. **Note:** This property is only returned in responses and ignored in requests. [BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/ |
validationErrorDetails | array | Optional | Human-readable details about any validation errors that occurred. |
validationErrorDetails[] | string | Each item | |
validationErrors | array | Optional | A list of validation errors that were encountered during the bulk send test. **Note:** This information is intended to be parsed by machine. |
validationErrors[] | string | Each item |
Creates a custom tab — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
anchor | string | Optional | An optional string that is used to auto-match tabs to strings located in the documents of an envelope. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
bold | string | Optional | When **true,** the information in the tab is bold. |
collaborative | string | Optional | |
concealValueOnDocument | string | Optional | When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
createdByDisplayName | string | Optional | The user name of the Docusign user who created this object. |
createdByUserId | string | Optional | The userId of the Docusign user who created this object. |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
disableAutoSize | string | Optional | When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. |
editable | string | Optional | When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified. |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
includedInEmail | string | Optional | When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs. |
initialValue | string | Optional | The original value of the tab. |
italic | string | Optional | When **true,** the information in the tab is italic. |
items | array | Optional | If the tab is a list, this represents the values that are possible for the tab. |
items[] | string | Each item | |
lastModified | string | Optional | The UTC DateTime this object was last modified. This is in ISO 8601 format. |
lastModifiedByDisplayName | string | Optional | The User Name of the Docusign user who last modified this object. |
lastModifiedByUserId | string | Optional | The userId of the Docusign user who last modified this object. |
localePolicy | Model | Optional | Expand Creates a custom tab — response body — locale Policy Locale-specific settings. |
locked | string | Optional | When **true,** the signer cannot change the data of the custom tab. |
maxNumericalValue | string | Optional | |
maximumLength | string | Optional | The maximum number of entry characters supported by the custom tab. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
minNumericalValue | string | Optional | |
name | string | Optional | |
numericalValue | string | Optional | |
paymentItemCode | string | Optional | If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: `SHAK1` Maximum Length: 100 characters. |
paymentItemDescription | string | Optional | If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: `The Danish play by Shakespeare` Maximum Length: 100 characters. |
paymentItemName | string | Optional | If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: `Hamlet` |
requireAll | string | Optional | When **true** and shared is true, information must be entered in this field to complete the envelope. |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
required | string | Optional | When **true,** the signer is required to fill out this tab. |
scaleValue | string | Optional | Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. |
selected | string | Optional | When **true,** the radio button is selected. |
shared | string | Optional | When **true,** this custom tab is shared. |
signatureProviderId | string | Optional | Reserved for Docusign. |
stampType | string | Optional | The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null |
stampTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `stampType` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
underline | string | Optional | When **true,** the information in the tab is underlined. |
validationMessage | string | Optional | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationPattern | string | Optional | A regular expression used to validate input for the tab. |
validationType | string | Optional | Specifies how numerical data is validated. Valid values: - `number` - `currency` |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
Referenced models: Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata
Creates a custom tab — response body — locale Policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Allows you to customize locale settings. |
addressFormat | string | Optional | Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` |
calendarType | string | Optional | Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` |
cultureName | string | Optional | The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. |
currencyCode | string | Optional | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL` |
currencyNegativeFormat | string | Optional | Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00` |
currencyPositiveFormat | string | Optional | Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR) |
customDateFormat | string | Optional | |
customTimeFormat | string | Optional | |
dateFormat | string | Optional | Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d |
initialFormat | string | Optional | When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs --> |
nameFormat | string | Optional | Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 --> |
timeFormat | string | Optional | Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 --> |
timeZone | string | Optional | Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime` |
useLongCurrencyFormat | string | Optional | When **true,** use the long currency format for the locale. |
Creates a custom tab — response body — merge Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information for transferring values between Salesforce data fields and Docusign tabs. |
allowSenderToEdit | string | Optional | When **true,** the sender can modify the value of the `mergeField` tab during the sending process. |
allowSenderToEditMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `allowSenderToEdit` property. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
configurationTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `configurationType` property. |
path | string | Optional | Sets the object associated with the custom tab. Currently this is the Salesforce Object. |
pathExtended | array | Optional | Reserved for Docusign. |
pathExtended[] | Model | Each item | Expand Creates a custom tab — response body — merge Field path Extended item |
pathExtendedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
pathMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `path` property is editable. |
row | string | Optional | Specifies the row number in a Salesforce table that the merge field value corresponds to. |
rowMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `row` property is editable. |
writeBack | string | Optional | When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. |
writeBackMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `writeBack` property. |
Referenced models: Creates a custom tab — response body — merge Field path Extended item, Updates a template document — response body — name Metadata
Creates a custom tab — response body — merge Field path Extended item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
typeName | string | Optional |
Creates a jurisdiction object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A notary jurisdiction. |
commissionExpiration | string | Optional | The expiration date of the notary's commission in format: `MM/DD/YYYY`. |
commissionId | string | Optional | The notary's commission identification. This varies from jurisdiction to jurisdiction. |
county | string | Optional | The county that the commission is valid in. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
jurisdiction | Model | Optional | Expand Creates a jurisdiction object — response body — jurisdiction Description of the jurisdiction for this notary. This is a read-only property. |
registeredName | string | Optional | The registered name of the notary. |
sealType | string | Optional | The seal type used for this juridiction. - `not_available` - `system_created` - `user_uploaded` |
Referenced models: Locks a template — response body — error Details, Creates a jurisdiction object — response body — jurisdiction
Creates a jurisdiction object — response body — jurisdiction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the jurisdiction of a notary. This is read-only object. |
allowSystemCreatedSeal | string | Optional | When **true,** the seal can be generated by the platform. |
allowUserUploadedSeal | string | Optional | When **true,** the seal can be uploaded by the user. |
commissionIdInSeal | string | Optional | When **true,** the notary's `comissionId` appears in the seal. |
county | string | Optional | The county of the jurisdiction. |
countyInSeal | string | Optional | When **true,** the county name appears in the seal. |
enabled | string | Optional | When **true,** this jurisdiction is enabled. |
jurisdictionId | string | Optional | The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds` |
name | string | Optional | The name of the jurisdiction. Typically the state name. |
notaryPublicInSeal | string | Optional | When **true,** the name of the notary appears in the seal. |
stateNameInSeal | string | Optional | When **true,** the name of the state appears in the seal. |
Creates a new Power Form — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a PowerForm. |
createdBy | string | Optional | The ID of the user who created the PowerForm. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
emailBody | string | Optional | The body of the email message sent to the recipients. Maximum length: 10000 characters. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
envelopes | array | Optional | |
envelopes[] | Model | Each item | Expand Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
instructions | string | Optional | The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters. |
isActive | string | Optional | When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value. When **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender. |
lastUsed | string | Optional | The UTC DateTime when the PowerForm was last used. |
limitUseInterval | string | Optional | The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property. |
limitUseIntervalEnabled | string | Optional | When **true,** the `limitUseInterval` is enabled. |
limitUseIntervalUnits | string | Optional | The units associated with the `limitUseInterval`. Valid values are: - `minutes` - `hours - `days` - `weeks` - `months` For example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`. |
maxUseEnabled | string | Optional | When **true,** you can set a maximum number of uses for the PowerForm. |
name | string | Optional | The name of the PowerForm. |
powerFormId | string | Optional | The ID of the PowerForm. |
powerFormUrl | string | Optional | The URL for the PowerForm. |
recipients | array | Optional | An array of recipient objects that provides details about the recipients of the envelope. |
recipients[] | Model | Each item | Expand Creates a new Power Form — response body — recipients item |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The ID of the sender. |
signingMode | string | Optional | The signing mode to use. Valid values are: - `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. - `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. |
templateId | string | Optional | The ID of the template used to create the PowerForm. |
templateName | string | Optional | The name of the template used to create the PowerForm. |
timesUsed | string | Optional | The number of times the PowerForm has been used. |
uri | string | Optional | The URI for the PowerForm. |
usesRemaining | string | Optional | The number of times the PowerForm can still be used. |
Referenced models: Locks a template — response body — error Details, Creates a new Power Form — response body — recipients item, Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body
Creates a new Power Form — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a PowerForm. |
createdBy | string | Optional | The ID of the user who created the PowerForm. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
emailBody | string | Optional | The body of the email message sent to the recipients. Maximum length: 10000 characters. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
envelopes | array | Optional | |
envelopes[] | Model | Each item | Expand Gets the status of a single envelope — response body |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
instructions | string | Optional | The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters. |
isActive | string | Optional | When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value. When **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender. |
lastUsed | string | Optional | The UTC DateTime when the PowerForm was last used. |
limitUseInterval | string | Optional | The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property. |
limitUseIntervalEnabled | string | Optional | When **true,** the `limitUseInterval` is enabled. |
limitUseIntervalUnits | string | Optional | The units associated with the `limitUseInterval`. Valid values are: - `minutes` - `hours - `days` - `weeks` - `months` For example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`. |
maxUseEnabled | string | Optional | When **true,** you can set a maximum number of uses for the PowerForm. |
name | string | Optional | The name of the PowerForm. |
powerFormId | string | Optional | The ID of the PowerForm. |
powerFormUrl | string | Optional | The URL for the PowerForm. |
recipients | array | Optional | An array of recipient objects that provides details about the recipients of the envelope. |
recipients[] | Model | Each item | Expand Creates a new Power Form — response body — recipients item |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The ID of the sender. |
signingMode | string | Optional | The signing mode to use. Valid values are: - `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. - `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. |
templateId | string | Optional | The ID of the template used to create the PowerForm. |
templateName | string | Optional | The name of the template used to create the PowerForm. |
timesUsed | string | Optional | The number of times the PowerForm has been used. |
uri | string | Optional | The URI for the PowerForm. |
usesRemaining | string | Optional | The number of times the PowerForm can still be used. |
Referenced models: Gets the status of a single envelope — response body, Locks a template — response body — error Details, Creates a new Power Form — response body — recipients item
Creates a new Power Form — response body — recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. |
accessCode | string | Optional | (Optional) The access code that the recipient must enter to access the PowerForm. Maximum Length: 50 characters. The code must also conform to the account's access code format setting. If blank but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required. |
accessCodeLocked | string | Optional | When **true,** the `accessCode` property is locked and cannot be edited. |
accessCodeRequired | string | Optional | When **true,** the recipient must enter the `accessCode` to access the PowerForm. |
email | string | Optional | The email address of the recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. |
emailLocked | string | Optional | When **true,** the recipient's email address is locked and cannot be edited. |
idCheckConfigurationName | string | Optional | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckRequired | string | Optional | Indicates if authentication is configured for the account. Valid values are: - `always`: Authentication checks are performed on every envelope. - `never`: Authentication checks are not performed on any envelopes. - `optional:` Authentication is configurable per envelope. |
name | string | Optional | The name of the PowerForm recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. |
recipientType | string | Optional | The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
roleName | string | Optional | The role associated with the recipient (for example, `Member`). This property is required when you are working with template recipients and PowerForm recipients. |
routingOrder | string | Optional | Specifies the routing order of the recipient in the envelope. |
templateRequiresIdLookup | string | Optional | When **true,** the template used to create the PowerForm requires ID lookup for the recipient. |
userNameLocked | string | Optional | When **true,** the `userName` property for the recipient is locked and cannot be edited. |
Creates a preview of the responsive version of a document — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). |
displayAnchorPrefix | string | Optional | Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance. |
displayAnchors | array | Optional | An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the [`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings) |
displayAnchors[] | Model | Each item | Expand Creates a preview of the responsive version of a document — request body — body display Anchors item |
displayOrder | string | Optional | The position on the page where the display section appears. |
displayPageNumber | string | Optional | The number of the page on which the display section appears. |
documentGuid | string | Optional | The GUID of the document. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
headerLabel | string | Optional | Header text or an HTML tag to place above the responsive HTML block. |
maxScreenWidth | string | Optional | If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level. |
removeEmptyTags | string | Optional | Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes). |
showMobileOptimizedToggle | string | Optional | When **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed. the **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing. |
source | string | Optional | Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: ``` source: "<html> ... <body><p>hello world</p></body></html>" ``` If the value of this property is the string `document`, the HTML signing page is generated from the provided document. ``` source: "document" ``` **Related topics** - [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html |
Referenced models: Creates a preview of the responsive version of a document — request body — body display Anchors item
Creates a preview of the responsive version of a document — request body — body display Anchors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caseSensitive | boolean | Optional | When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content. |
displaySettings | Model | Optional | Expand Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays. |
endAnchor | string | Optional | Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. |
removeEndAnchor | boolean | Optional | When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. |
removeStartAnchor | boolean | Optional | When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. |
startAnchor | string | Optional | Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. |
Referenced models: Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings
Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object defines how to display the HTML between the `startAnchor` and `endAnchor`. |
cellStyle | string | Optional | Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. |
collapsibleSettings | Model | Optional | Expand Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings collapsible Settings This object defines the appearance and function of a collapsible section or item. |
display | string | Optional | Sets the display and behavior properties. Possible values are: - `inline`: Leaves the HTML where it is in the document. This property lets you add a label or present on a separate page. - `collapsible`: The HTML in this section may be expanded or collapsed. Initially this section is expanded. - `collapsed`: The HTML in this section may be expanded or collapsed. Initially this section is collapsed. - `continue_button`: Creates a stop point in the document to draw the reader's attention before proceeding to the next section. - `responsive_table`: Turns this section into a responsive table. Note that this is only used on HTML tables that fall within the anchor start and end positions. - `responsive_table_single_column`: Turns this section into a responsive single-column table. Note this is only used on HTML tables that fall within the anchor start and end positions. The table will be converted to one single column where each current column will become a row, then stacked. - `print_only`: Do not show this portion of the HTML in the responsive signing view. |
displayLabel | string | Optional | The label to add to this display section in the signing page. |
displayOrder | integer | Optional | The position on the page where the display section appears. Format: int32 |
displayPageNumber | integer | Optional | The number of the page on which the display section appears. Format: int32 |
hideLabelWhenOpened | boolean | Optional | When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. |
inlineOuterStyle | string | Optional | Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. |
labelWhenOpened | string | Optional | The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. |
preLabel | string | Optional | Enables you to add descriptive text that appears before a collapsed section or continue button. |
scrollToTopWhenOpened | boolean | Optional | When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. |
tableStyle | string | Optional | Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. |
Referenced models: Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings collapsible Settings
Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings collapsible Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Display settings for collapsible section. |
arrowClosed | string | Optional | Indicates the direction of the disclosure arrow when the collapsible section is in the closed state. One of the following: - `up`: In the closed state, the disclosure arrow points up. - `down`: In the closed state, the disclosure arrow points down. - `left`: In the closed state, the disclosure arrow points left. - `right`: In the closed state, the disclosure arrow points right. |
arrowColor | string | Optional | A CSS color value (such as `#DCF851`) that indicates the color of the arrow. |
arrowLocation | string | Optional | The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` |
arrowOpen | string | Optional | Indicates the direction of the disclosure arrow when the collapsible section is in the open state. One of the following: - `up`: In the open state, the disclosure arrow points up. - `down`: In the open state, the disclosure arrow points down. - `left`: In the open state, the disclosure arrow points left. - `right`: In the open state, the disclosure arrow points right. |
arrowSize | string | Optional | Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) |
arrowStyle | string | Optional | The name of the CSS style to be used on collapsible arrow section. |
containerStyle | string | Optional | The name of the CSS style to be used for the collapsible container. |
labelStyle | string | Optional | The name of the CSS style to be used for the collapsible container's label. |
onlyArrowIsClickable | boolean | Optional | When **true,** only the arrow is clickable to expand or collapse the section. When **false** (the default), both the label and the arrow are clickable. If no arrow is used, this setting is ignored. |
outerLabelAndArrowStyle | string | Optional | The name of the CSS style to be used for the collapsible container's outer label and arrow style. |
Creates a preview of the responsive version of a document — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
htmlDefinitions | array | Optional | Holds the properties that define how to generate the responsive-formatted HTML for the document. |
htmlDefinitions[] | string | Each item |
Creates a resource token for a sender to request ID Evidence data — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
proofBaseURI | string | Optional | |
resourceToken | string | Optional |
Creates a signing group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
groups | array | Optional | A collection group objects containing information about the groups. |
groups[] | Model | Each item | Expand Updates a signing group — response body |
Referenced models: Updates a signing group — response body
Creates a template recipient preview — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This request object contains the information necessary to create a recipient preview. |
assertionId | string | Optional | A unique identifier of the authentication event executed by the client application. |
authenticationInstant | string | Optional | A sender-generated value that indicates the date and time that the signer was authenticated. |
authenticationMethod | string | Optional | Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: * Biometric * HTTPBasicAuth * Kerberos * KnowledgeBasedAuth * None * PaperDocuments * Password * RSASecureID * SingleSignOn_CASiteminder * SingleSignOn_InfoCard * SingleSignOn_MicrosoftActiveDirectory * SingleSignOn_Other * SingleSignOn_Passport * SingleSignOn_SAML * Smartcard * SSLMutualAuth * X509Certificate This information is included in the Certificate of Completion. |
clientURLs | Model | Optional | Expand Creates a template recipient preview — request body — body client UR Ls |
pingFrequency | string | Optional | Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds. |
pingUrl | string | Optional | The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
returnUrl | string | Optional | The URL to which the user will be redirected in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL. This property is required. |
securityDomain | string | Optional | The domain in which the user authenticated. |
xFrameOptions | string | Optional | Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - `deny`: The page cannot be displayed in a frame. - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. |
xFrameOptionsAllowFromUrl | string | Optional | When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. |
Referenced models: Creates a template recipient preview — request body — body client UR Ls
Creates a template recipient preview — request body — body client UR Ls
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
onAccessCodeFailed | string | Optional | |
onCancel | string | Optional | |
onDecline | string | Optional | |
onException | string | Optional | |
onFaxPending | string | Optional | |
onIdCheckFailed | string | Optional | |
onSessionTimeout | string | Optional | |
onSigningComplete | string | Optional | |
onTTLExpired | string | Optional | |
onViewingComplete | string | Optional |
Creates a template recipient preview — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Optional | URL for the template edit view. |
Creates a workspace file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents an item in a workspace, which can be either a file or folder. |
callerAuthorization | Model | Optional | Expand Creates a workspace file — response body — user Authorization |
contentType | string | Optional | If the item is a file, this property specifies the content type of the file. |
created | string | Optional | The UTC DateTime when the workspace item was created. |
createdById | string | Optional | The ID of the user who created the workspace item. |
createdByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who created the workspace item. |
extension | string | Optional | The file extension of a file item. |
fileSize | string | Optional | The size of the file in bytes. |
fileUri | string | Optional | The URI for retrieving the file. |
id | string | Optional | A unique ID for the Salesforce object. |
isPublic | string | Optional | When **true,** the item is public. |
lastModified | string | Optional | The UTC date and time that the comment was last updated. **Note:** This can only be done by the creator. |
lastModifiedById | string | Optional | The ID of the user who last modified the item. |
lastModifiedByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who last modified the workspace item. |
name | string | Optional | The name of the file or folder. |
pageCount | string | Optional | The number of pages in a file. |
parentFolderId | string | Optional | The ID of the parent folder, or the special value `root` for the root folder. |
parentFolderUri | string | Optional | The URI of the parent folder. |
sha256 | string | Optional | A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused. |
thumbHeight | string | Optional | The height of the thumbnail image. |
thumbWidth | string | Optional | The width of the thumbnail image. |
thumbnail | Model | Optional | Expand Creates a workspace file — response body — thumbnail |
type | string | Optional | The type of the workspace item. Valid values are file, folder. |
uri | string | Optional | A URI containing the user ID. |
userAuthorization | Model | Optional | Expand Creates a workspace file — response body — user Authorization |
Referenced models: Creates a workspace file — response body — thumbnail, Get Workspace — response body — caller Information, Creates a workspace file — response body — user Authorization
Creates a workspace file — response body — thumbnail
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Description of a page of a document. |
dpi | string | Optional | The number of dots per inch used for the page image. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details If an error occurs, this property describes the error. |
height | string | Optional | The height of the page in pixels. Must be an integer. |
imageBytes | string | Optional | The number of image bytes. |
mimeType | string | Optional | The MIME type. |
pageId | string | Optional | The ID of the page. |
sequence | string | Optional | The sequence of the page in the document, or page number. |
width | string | Optional | The width of the page in pixels. Must be an integer. |
Referenced models: Locks a template — response body — error Details
Creates a workspace file — response body — user Authorization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides properties that describe user authorization to a workspace. |
canDelete | string | Optional | When **true,** the workspace user can delete items from the workspace. |
canMove | string | Optional | When **true,** the workspace user can move the items in the workspace. |
canTransact | string | Optional | When **true,** the workspace user can create transactions from the workspace. |
canView | string | Optional | When **true,** the workspace user can view the items in the workspace. |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdById | string | Optional | The ID of the user who created the workspace user authorization. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
modified | string | Optional | The UTC DateTime when the workspace user authorization was last modified. |
modifiedById | string | Optional | The ID of the user who last modified the workspace user authorization. |
workspaceUserId | string | Optional | The ID of the workspace user. |
workspaceUserInformation | Model | Optional | Expand Get Workspace — response body — caller Information An object that provides details about the workspace user. |
Referenced models: Locks a template — response body — error Details, Get Workspace — response body — caller Information
Creates an account custom field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object provides details about a custom field. |
customFieldType | string | Optional | The type of custom field. Valid values are: - `text` (default) - `list` |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | Optional | The ID of the custom field. |
listItems | array | Optional | For a list custom field, this is an array of strings that represent the items in a list. Maximum Length: 2,000 characters. |
listItems[] | string | Each item | |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** the signer must complete the custom field. |
show | string | Optional | When **true,** the custom field displays at the top of the Certificate of Completion. |
value | string | Optional | Specifies the value of the custom field. Maximum Length: 2,000 characters. |
Referenced models: Locks a template — response body — error Details