DocuSign: Esignature schemas (part 1)
23 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Add archive metadata to envelopes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bulkEnvelopeStatus | Model | Optional | Expand Add envelope archive metadata — response body — bulk Envelope Status |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
recipientSigningUri | string | Optional | |
recipientSigningUriError | string | Optional | |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
statusDateTime | string | Optional | |
uri | string | Optional |
Referenced models: Add envelope archive metadata — response body — bulk Envelope Status, Add envelope archive metadata — response body — error Details
Add envelope archive metadata — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessControlListBase64 | string | Optional | |
accessibility | string | Optional | |
allowComments | string | Optional | |
allowMarkup | string | Optional | When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this |
allowReassign | string | Optional | When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. |
allowRecipientRecursion | string | Optional | |
allowViewHistory | string | Optional | |
anySigner | string | Optional | |
archiveAction | string | Optional | |
asynchronous | string | Optional | When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. |
attachments | array | Optional | |
attachments[] | Model | Each item | Expand Add envelope archive metadata — request body — body attachments item |
attachmentsUri | string | Optional | |
authoritativeCopy | string | Optional | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. |
authoritativeCopyDefault | string | Optional | |
autoNavigation | string | Optional | |
brandId | string | Optional | |
brandLock | string | Optional | |
burnDefaultTabData | string | Optional | |
certificateUri | string | Optional | Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. |
completedDateTime | string | Optional | Specifies the date and time this item was completed. |
compositeTemplates | array | Optional | |
compositeTemplates[] | Model | Each item | Expand Add envelope archive metadata — request body — body composite Templates item |
copyRecipientData | string | Optional | |
createdDateTime | string | Optional | Indicates the date and time the item was created. |
customFields | Model | Optional | Expand Add envelope archive metadata — request body — body custom Fields |
customFieldsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the custom fields. |
declinedDateTime | string | Optional | The date and time the recipient declined the document. |
deletedDateTime | string | Optional | Specifies the data and time the item was deleted. |
deliveredDateTime | string | Optional | Reserved: For DocuSign use only. |
disableResponsiveDocument | string | Optional | |
documentBase64 | string | Optional | |
documents | array | Optional | Complex element contains the details on the documents in the envelope. |
documents[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item |
documentsCombinedUri | string | Optional | |
documentsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the documents. |
emailBlurb | string | Optional | |
emailSettings | Model | Optional | Expand Add envelope archive metadata — request body — body email Settings |
emailSubject | string | Optional | Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. |
enableWetSign | string | Optional | When set to **true**, the signer is allowed to print the document and sign it on paper. |
enforceSignerVisibility | string | Optional | When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. |
envelopeAttachments | array | Optional | |
envelopeAttachments[] | Model | Each item | Expand Add envelope archive metadata — request body — body attachments item |
envelopeClassification | string | Optional | |
envelopeCustomMetadata | Model | Optional | Expand Add envelope archive metadata — request body — body envelope Custom Metadata |
envelopeDocuments | array | Optional | |
envelopeDocuments[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Documents item |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
envelopeIdStamping | string | Optional | When set to **true**, Envelope ID Stamping is enabled. |
envelopeLocation | string | Optional | |
envelopeMetadata | Model | Optional | Expand Add envelope archive metadata — request body — body envelope Metadata |
envelopeUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. |
eventNotification | Model | Optional | Expand Add envelope archive metadata — request body — body event Notification |
eventNotifications | array | Optional | |
eventNotifications[] | Model | Each item | Expand Add envelope archive metadata — request body — body event Notification |
expireAfter | string | Optional | |
expireDateTime | string | Optional | |
expireEnabled | string | Optional | |
externalEnvelopeId | string | Optional | |
folders | array | Optional | |
folders[] | Model | Each item | Expand Add envelope archive metadata — request body — body folders item |
generateDataSource | string | Optional | |
generateProperties | array | Optional | |
generateProperties[] | Model | Each item | Expand Add envelope archive metadata — request body — body generate Properties item |
generateSchemaId | string | Optional | |
hasComments | string | Optional | |
hasFormDataChanged | string | Optional | |
hasWavFile | string | Optional | |
holder | string | Optional | |
imageHandling | string | Optional | |
initialSentDateTime | string | Optional | |
is21CFRPart11 | string | Optional | When set to **true**, indicates that this module is enabled on the account. |
isDynamicEnvelope | string | Optional | |
isSignatureProviderEnvelope | string | Optional | |
isTicketRelatedEnvelope | string | Optional | |
lastModifiedDateTime | string | Optional | The date and time the item was last modified. |
location | string | Optional | |
lockInformation | Model | Optional | Expand Add envelope archive metadata — request body — body lock Information |
messageLock | string | Optional | When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. |
notification | Model | Optional | Expand Add envelope archive metadata — request body — body notification |
notificationUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the notifications. |
password | string | Optional | |
powerForm | Model | Optional | Expand Add envelope archive metadata — request body — body power Form |
purgeCompletedDate | string | Optional | |
purgeRequestDate | string | Optional | |
purgeState | string | Optional | |
recipientViewRequest | Model | Optional | Expand Add envelope archive metadata — request body — body recipient View Request |
recipients | Model | Optional | Expand Add envelope archive metadata — request body — body recipients |
recipientsLock | string | Optional | When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
saveDocumentsToArchive | string | Optional | |
sender | Model | Optional | Expand Add envelope archive metadata — request body — body sender |
sentDateTime | string | Optional | The date and time the envelope was sent. |
signerCanSignOnMobile | string | Optional | |
signingLocation | string | Optional | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
statusChangedDateTime | string | Optional | The data and time the status changed. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, DocuSign will generate a value. |
templateRoles | array | Optional | |
templateRoles[] | Model | Each item | Expand Add envelope archive metadata — request body — body template Roles item |
templatesUri | string | Optional | Contains a URI for an endpoint which you can use to retrieve the templates. |
transactionId | string | Optional | Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. |
uSigState | string | Optional | |
useDisclosure | string | Optional | When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. |
voidedDateTime | string | Optional | The date and time the envelope or template was voided. |
voidedReason | string | Optional | The reason the envelope or template was voided. |
watermarkLanguage | string | Optional | |
workflow | Model | Optional | Expand Add envelope archive metadata — request body — body workflow |
Referenced models: Add envelope archive metadata — request body — body attachments item, Add envelope archive metadata — request body — body composite Templates item, Add envelope archive metadata — request body — body custom Fields, Add envelope archive metadata — request body — body documents item, Add envelope archive metadata — request body — body email Settings, Add envelope archive metadata — request body — body envelope Custom Metadata, Add envelope archive metadata — request body — body envelope Documents item, Add envelope archive metadata — request body — body generate Properties item, Add envelope archive metadata — request body — body envelope Metadata, Add envelope archive metadata — request body — body notification, Add envelope archive metadata — request body — body event Notification, Add envelope archive metadata — request body — body folders item, Add envelope archive metadata — request body — body lock Information, Add envelope archive metadata — request body — body power Form, Add envelope archive metadata — request body — body recipient View Request, Add envelope archive metadata — request body — body recipients, Add envelope archive metadata — request body — body template Roles item, Add envelope archive metadata — request body — body sender, Add envelope archive metadata — request body — body workflow
Add envelope archive metadata — request body — body attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an attachment. |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. |
data | string | Optional | A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. |
label | string | Optional | A label for the attachment. Potential values include: - `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. |
Add envelope archive metadata — request body — body composite Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/ |
compositeTemplateId | string | Optional | The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. |
document | Model | Optional | Expand Add envelope archive metadata — request body — body documents item |
inlineTemplates | array | Optional | Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. |
inlineTemplates[] | Model | Each item | Expand Add envelope archive metadata — request body — body composite Templates item inline Templates item |
pdfMetaDataTemplateSequence | string | Optional | A number representing the sequence in which to apply the template that contains the PDF metadata. Example: `4` |
serverTemplates | array | Optional | Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. |
serverTemplates[] | Model | Each item | Expand Add envelope archive metadata — request body — body composite Templates item server Templates item |
Referenced models: Add envelope archive metadata — request body — body documents item, Add envelope archive metadata — request body — body composite Templates item inline Templates item, Add envelope archive metadata — request body — body composite Templates item server Templates item
Add envelope archive metadata — request body — body composite Templates item inline Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customFields | Model | Optional | Expand Add envelope archive metadata — request body — body custom Fields |
documents | array | Optional | A complex element that contains details about the documents associated with the envelope. |
documents[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item |
envelope | Model | Optional | Expand Add envelope archive metadata — request body — body power Form envelopes item |
recipients | Model | Optional | Expand Add envelope archive metadata — request body — body recipients |
sequence | string | Optional | Specifies the order in which templates are overlaid. |
Referenced models: Add envelope archive metadata — request body — body custom Fields, Add envelope archive metadata — request body — body documents item, Add envelope archive metadata — request body — body power Form envelopes item, Add envelope archive metadata — request body — body recipients
Add envelope archive metadata — request body — body composite Templates item server Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sequence | string | Optional | Specifies the order in which templates are overlaid. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, DocuSign will generate a value. |
Add envelope archive metadata — request body — body custom Fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about custom fields. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body custom Fields list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body custom Fields text Custom Fields item |
Referenced models: Add envelope archive metadata — request body — body custom Fields list Custom Fields item, Add envelope archive metadata — request body — body custom Fields text Custom Fields item
Add envelope archive metadata — request body — body custom Fields list Custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a list custom field from which envelope creators and senders can select custom data. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
fieldId | string | Optional | The ID of the custom field. |
listItems | array | Optional | An array of strings that represents the options in a list. Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters. |
listItems[] | string | Each item | |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** senders are required to select an option from the list before they can send the envelope. |
show | string | Optional | When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. |
value | string | Optional | The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. |
Referenced models: Add envelope archive metadata — response body — error Details
Add envelope archive metadata — request body — body custom Fields text Custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a free text custom field where envelope creators and senders can enter custom data. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
fieldId | string | Optional | The ID of the custom field. |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** senders are required to enter or select information for the field before they can send the envelope. |
show | string | Optional | When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. |
value | string | Optional | The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters. |
Referenced models: Add envelope archive metadata — response body — error Details
Add envelope archive metadata — request body — body documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A document object. |
applyAnchorTabs | string | Optional | Reserved for Docusign. |
assignTabsToRecipientId | string | Optional | |
authoritativeCopy | boolean | Optional | When **true,** this document is considered an authoritative copy. If this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property. When **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property. |
display | string | Optional | This string sets the display and behavior properties of the document during signing. Valid values: - `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. - `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents. |
docGenDocumentStatus | string | Optional | |
docGenFormFields | array | Optional | |
docGenFormFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documentFields | array | Optional | The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: - `name`: A string that can be a maximum of 50 characters. - `value`: A string that can be a maximum of 200 characters. If you are using XML, the name/value pair is contained in a `nameValue` element. |
documentFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item |
documentId | string | Optional | Specifies the document ID of this document. This value is used by tabs to determine which document they appear in. |
documentTemplateId | string | Optional | |
encryptedWithKeyManager | string | Optional | When **true,** the document has been encrypted by the sender for use with the Docusign Key Manager Security Appliance. |
fileExtension | string | Optional | The file extension type of the document. Non-PDF documents are converted to PDF. If the document is not a PDF, `fileExtension` is required. If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message. |
fileFormatHint | string | Optional | |
htmlDefinition | Model | Optional | Expand Add envelope archive metadata — request body — body documents item html Definition |
includeInDownload | string | Optional | When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.** |
isDocGenDocument | string | Optional | |
matchBoxes | array | Optional | Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. |
matchBoxes[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item match Boxes item |
name | string | Optional | The name of the document. |
order | string | Optional | A string value consisting of an integer index of the document's position within the list of documents attached to the envelope. |
pages | string | Optional | The number of pages in the document. This property is read-only. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
pdfFormFieldOption | string | Optional | |
remoteUrl | string | Optional | The file ID from the cloud storage service where the document is located. This information is returned using [CloudStorage: listFolders](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/) or [CloudStorage: list](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/). |
signerMustAcknowledge | string | Optional | Sets how the signer interacts with the supplemental document. Valid values: - `no_interaction` No recipient action is required. - `view` The recipient is required to view the document. - `accept` The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. - `view_accept` The recipient is required to view and accept the document. **Note:** The `view` value is used for both View and Accept and Read and Accept. Visit the [Supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/) page for more information. |
signerMustAcknowledgeUseAccountDefault | boolean | Optional | When **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa). |
tabs | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
transformPdfFields | string | Optional | When **true,** PDF form field data is transformed into document tab values when the PDF form field name matches the Docusign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. |
uri | string | Optional | A URI containing the user ID. |
Referenced models: Add envelope archive metadata — request body — body documents item doc Gen Form Fields item, Add envelope archive metadata — request body — body documents item html Definition, Add envelope archive metadata — request body — body documents item match Boxes item, Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item, Add envelope archive metadata — request body — body documents item tabs
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The document fields available for document generation. This object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored. |
children | array | Optional | |
children[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details |
defaultValue | string | Optional | |
description | string | Optional | A description of the field. Displayed with the label. |
filter | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item filter |
format | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item format |
fullyQualifiedPath | string | Optional | Reserved for Docusign use. This value is returned in the `getEnvelopeDocGenFormFields` response but should not be included in `updateEnvelopeDocGenFormFields` requests. |
hidden | boolean | Optional | |
label | string | Optional | A label displayed near the field. |
name | string | Optional | The name of the sender field. Required for PUT requests. |
options | array | Optional | When `type` is `Select`, this array describes the available options. |
options[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item options item |
order | string | Optional | Not currently used. |
predefinedValidation | string | Optional | Reserved for Docusign. |
readOnly | boolean | Optional | |
required | string | Optional | When **true,** the field is required. |
rowValues | array | Optional | For fields of type `TableRow`, this property represents the sender fields in the row. For GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row. For PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table. |
rowValues[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item row Values item |
type | string | Optional | The kind of data the sender field holds. Valid values: - `TextBox` - `Date` - `Number` - `Select` - `TableRow` |
validation | Model | Optional | Expand Updates a template document — response body — doc Gen Form Fields item validation |
value | string | Optional | The value of the sender field. For PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields). |
Referenced models: Updates a template document — response body — doc Gen Form Fields item options item, Updates a template document — response body — doc Gen Form Fields item validation, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item filter, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item row Values item, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item format
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recordId | string | Optional |
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expression | string | Optional | |
locale | string | Optional |
Add envelope archive metadata — request body — body documents item doc Gen Form Fields item row Values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing a row of a dynamic table. |
docGenFormFieldList | array | Optional | The sender fields in each row of the table. For GET requests, the `label`, `type`, `required`, and `name` properties will be returned. For POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column. |
docGenFormFieldList[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item |
Referenced models: Add envelope archive metadata — request body — body documents item doc Gen Form Fields item
Add envelope archive metadata — request body — body documents item html Definition
| 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 Add envelope archive metadata — request body — body documents item html Definition 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html) is enabled, the HTML code is used to display the signing page: ```text 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. ```text 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/) |
Referenced models: Add envelope archive metadata — request body — body documents item html Definition display Anchors item
Add envelope archive metadata — request body — body documents item html Definition 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 Add envelope archive metadata — request body — body documents item html Definition display Anchors item display Settings |
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: Add envelope archive metadata — request body — body documents item html Definition display Anchors item display Settings
Add envelope archive metadata — request body — body documents item html Definition 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 Add envelope archive metadata — request body — body documents item html Definition display Anchors item display Settings collapsible Settings |
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. |
displayPageNumber | integer | Optional | The number of the page on which the display section appears. |
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: Add envelope archive metadata — request body — body documents item html Definition display Anchors item display Settings collapsible Settings
Add envelope archive metadata — request body — body documents item html Definition 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. |
Add envelope archive metadata — request body — body documents item match Boxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. Must be 1 for supplemental documents. |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
Add envelope archive metadata — request body — body documents item tabs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. |
approveTabs | array | Optional | A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. |
approveTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs approve Tabs item |
checkboxTabs | array | Optional | A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. |
checkboxTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs checkbox Tabs item |
commentThreadTabs | array | Optional | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. |
commentThreadTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs comment Thread Tabs item |
commissionCountyTabs | array | Optional | A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. |
commissionCountyTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. |
commissionExpirationTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. |
commissionNumberTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. |
commissionStateTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company). A Company tab displays a field for the name of the recipient's company. This value can't be set. |
companyTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date Signed tab displays the date that the recipient signed the document. This value can't be set. |
dateSignedTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. |
dateTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. |
declineTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. |
emailAddressTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. |
emailTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. |
envelopeIdTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. |
firstNameTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html). |
formulaTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Full Name tab displays the recipient's full name. This value can't be set. |
fullNameTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to initial the document. May be optional. This value can't be set. |
initialHereTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. |
lastNameTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs last Name Tabs item |
listTabs | array | Optional | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). |
listTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. |
notarizeTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs notarize Tabs item |
notarySealTabs | array | Optional | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). |
notarySealTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Note tab displays additional information to the recipient in the form of a note. This value can be set. |
noteTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs note Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). |
numberTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs number Tabs item |
numericalTabs | array | Optional | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). |
numericalTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). |
phoneNumberTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs prefill Tabs |
radioGroupTabs | array | Optional | A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. |
radioGroupTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to sign a document. May be optional. This value can't be set. |
signHereTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. |
signerAttachmentTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs signer Attachment Tabs item |
smartSectionTabs | array | Optional | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. |
smartSectionTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. |
ssnTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). |
textTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs text Tabs item |
titleTabs | array | Optional | A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Title tab displays the recipient's title. This value can't be set. |
titleTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs title Tabs item |
viewTabs | array | Optional | A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A View tab is used with an Approve tab to handle supplemental documents. This value can be set. |
viewTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. |
zipTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs zip Tabs item |
Referenced models: Add envelope archive metadata — request body — body documents item tabs approve Tabs item, Add envelope archive metadata — request body — body documents item tabs checkbox Tabs item, Add envelope archive metadata — request body — body documents item tabs comment Thread Tabs item, Add envelope archive metadata — request body — body documents item tabs commission County Tabs item, Add envelope archive metadata — request body — body documents item tabs commission Expiration Tabs item, Add envelope archive metadata — request body — body documents item tabs commission Number Tabs item, Add envelope archive metadata — request body — body documents item tabs commission State Tabs item, Add envelope archive metadata — request body — body documents item tabs company Tabs item, Add envelope archive metadata — request body — body documents item tabs date Tabs item, Add envelope archive metadata — request body — body documents item tabs date Signed Tabs item, Add envelope archive metadata — request body — body documents item tabs decline Tabs item, Add envelope archive metadata — request body — body documents item tabs draw Tabs item, Add envelope archive metadata — request body — body documents item tabs email Tabs item, Add envelope archive metadata — request body — body documents item tabs email Address Tabs item, Add envelope archive metadata — request body — body documents item tabs envelope Id Tabs item, Add envelope archive metadata — request body — body documents item tabs first Name Tabs item, Add envelope archive metadata — request body — body documents item tabs formula Tabs item, Add envelope archive metadata — request body — body documents item tabs full Name Tabs item, Add envelope archive metadata — request body — body documents item tabs initial Here Tabs item, Add envelope archive metadata — request body — body documents item tabs last Name Tabs item, Add envelope archive metadata — request body — body documents item tabs list Tabs item, Add envelope archive metadata — request body — body documents item tabs notarize Tabs item, Add envelope archive metadata — request body — body documents item tabs notary Seal Tabs item, Add envelope archive metadata — request body — body documents item tabs note Tabs item, Add envelope archive metadata — request body — body documents item tabs number Tabs item, Add envelope archive metadata — request body — body documents item tabs numerical Tabs item, Add envelope archive metadata — request body — body documents item tabs phone Number Tabs item, Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item, Add envelope archive metadata — request body — body documents item tabs prefill Tabs, Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item, Add envelope archive metadata — request body — body documents item tabs sign Here Tabs item, Add envelope archive metadata — request body — body documents item tabs signer Attachment Tabs item, Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item, Add envelope archive metadata — request body — body documents item tabs tab Groups item, Add envelope archive metadata — request body — body documents item tabs text Tabs item, Add envelope archive metadata — request body — body documents item tabs title Tabs item, Add envelope archive metadata — request body — body documents item tabs view Tabs item, Add envelope archive metadata — request body — body documents item tabs zip Tabs item
Add envelope archive metadata — request body — body documents item tabs approve Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to approve documents without placing a signature or initials on the document. |
agreementAttribute | string | Optional | N/A - do not use |
agreementAttributeLocked | string | Optional | N/A - do not use |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorXOffset | string | Optional | Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
buttonText | string | Optional | Specifies the approval text that displays in the tab. |
buttonTextMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
conditionalParentLabel | string | Optional | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details |
customTabId | string | Optional | The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
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 - OcrA (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 |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
localePolicy | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | **Note:** Approve tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs checkbox Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to select a yes/no (on/off) option. |
agreementAttribute | string | Optional | When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract |
agreementAttributeLocked | string | Optional | When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorXOffset | string | Optional | Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
conditionalParentLabel | string | Optional | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details |
customTabId | string | Optional | The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
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 - OcrA (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 |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
locked | string | Optional | When **true,** the signer cannot change the data of the custom tab. |
lockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
pageNumber | string | Optional | The page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
required | string | Optional | This property does not apply to `checkbox` tabs. To require users to check at least one, or at most some number of checkboxes, associate the checkbox tabs with a [`tabGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups). Then set the following `tabGroup` properties: - [`maximumAllowed`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed) - [`minimumRequired`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired) - [`groupRule`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule) specifies how the other two properties are interpreted. You can find an example at [Stack Overflow](https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277). |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
selected | string | Optional | When **true,** the checkbox is selected. |
selectedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
selectedOriginal | string | Optional | |
selectedOriginalMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shareToRecipients | string | Optional | Reserved for Docusign. |
shareToRecipientsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shared | string | Optional | When **true,** this tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information