Skip to content

DocuSign: Esignature schemas (part 14)

46 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Creates an envelope — request body — body

FieldTypePresenceDescription and constraints
$objectRootEnvelope object definition.
accessControlListBase64stringOptionalReserved for Docusign.
accessibilitystringOptionalSets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account.

**Note:** This information is currently generated from the Docusign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.
allowCommentsstringOptionalWhen **true,** comments are allowed on the envelope.
allowMarkupstringOptionalWhen **true,** the Document Markup feature is enabled.

**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
allowReassignstringOptionalWhen **true,** the recipient can redirect an envelope to a more appropriate recipient.
allowRecipientRecursionstringOptionalWhen **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
allowViewHistorystringOptionalWhen **true,** users can view the history of the envelope.
anySignerstringOptionalDeprecated. This feature has been replaced by signing groups.
asynchronousstringOptionalWhen **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.


**Note:** A `transactionId` is required for this
call to work correctly. When the envelope is
created, the status is `Processing` and an
`envelopeId` is not returned in the response. To
get the `envelopeId`, use a GET envelope query by
using the
[transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the
Connect notification.
attachmentsarrayOptionalAn array of attachment objects containing details about any envelope attachments.
attachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
attachmentsUristringOptionalThe URI for retrieving the envelope attachments.
authoritativeCopystringOptionalWhen **true,** marks all of the documents in the envelope as authoritative copies.

**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**
authoritativeCopyDefaultstringOptionalThe default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.
If this property is not set, each document defaults to the envelope's `authoritativeCopy`.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
brandIdstringOptionalThe ID of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.

**Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied.
brandLockstringOptionalWhen **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
burnDefaultTabDatastringOptional
certificateUristringOptionalThe URI for retrieving certificate information.
completedDateTimestringOptionalThe date and time that the envelope was completed.
compositeTemplatesarrayOptionalA complex type that can be added to create envelopes from a combination of Docusign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.
compositeTemplates[]ModelEach itemExpand Creates an envelope — request body — body composite Templates item
copyRecipientDatastringOptionalThis value is only applicable when copying an existing envelope. Provide the ID of the envelope to clone in `envelopeId`.

When **true,** the recipient field values of the existing envelope are included. Only values from data entry fields, like checkboxes and radio buttons, will be copied. Fields that require an action, like signatures and initials, will not be included.
createdDateTimestringOptionalThe date and time that the envelope was created.
customFieldsModelOptionalExpand Gets a list of custom fields — response body
An optional array of strings that enables the sender to provide
custom data about the recipient. This information is returned in
the envelope status but otherwise not used by Docusign. Each
`customField` string can be a maximum of 100 characters.


**Note:** Any custom fields you set with this API method
will _replace_ custom fields you have defined with
[Envelope Custom Fields in Admin](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html),
whether the
**Show field to envelope creators**
or
**Make fields required for envelopes**
options are checked or not.
customFieldsUristringOptionalThe URI for retrieving custom fields.
declinedDateTimestringOptionalThe date and time that the recipient declined the envelope.
deletedDateTimestringOptionalThe date and time that the envelope was deleted.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
disableResponsiveDocumentstringOptionalWhen **true,** the responsive document feature is turned off for the envelope.
documentBase64stringOptionalThe 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.
documentsarrayOptionalA complex element that contains details about the documents associated with the envelope.
documents[]ModelEach itemExpand Creates an envelope — request body — body documents item
documentsCombinedUristringOptionalThe URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsUristringOptionalThe URI for retrieving all of the documents associated with the envelope as separate files.
emailBlurbstringOptionalThis optional element holds the body of the email message that is sent to all envelope recipients.

Maximum Length: 10000 characters.
emailSettingsModelOptionalExpand Adds email setting overrides to an envelope — response body
This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope.

**Important Note:** The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings.
emailSubjectstringOptionalThe subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).

**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.
enableWetSignstringOptionalWhen **true,** the signer is allowed to print the document and sign it on paper.
enforceSignerVisibilitystringOptionalWhen **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.

**Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan.

[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/
[sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending
[fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html
[support]: https://support.docusign.com/en/contactSupport#
envelopeAttachmentsarrayOptionalAn array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopeAttachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
envelopeCustomMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Custom Metadata
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe envelope ID.

When used as a request body in [Envelopes: create](/docs/esign-rest-api/reference/envelopes/envelopes/create/), this is the ID of the envelope to clone.
envelopeIdStampingstringOptionalWhen **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.
After a document or attachment is stamped with an Envelope ID,
the ID is seen by all recipients
and becomes a permanent part of the document
and cannot be removed.
envelopeLocationstringOptionalReserved for Docusign.
envelopeMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Metadata
Metadata about the features that are enabled for the envelope.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
eventNotificationModelOptionalExpand Creates an envelope — request body — body event Notification
This optional object is used to register a webhook that will receive status changes for this envelope.
expireAfterstringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
expireDateTimestringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
expireEnabledstringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
externalEnvelopeIdstringOptionalMay contain an external identifier for the envelope.
foldersarrayOptionalAn array of folders that the envelope belongs to.
folders[]ModelEach itemExpand Creates an envelope — request body — body folders item
hasCommentsstringOptionalWhen **true,** indicates that users have added comments to the envelope.
hasFormDataChangedstringOptionalWhen **true,** indicates that the form data associated with the envelope has changed since it was sent. When **false,** this property does not appear in the response.
hasWavFilestringOptionalWhen **true,** indicates that a wave file (voice recording) is part of the envelope.
holderstringOptionalReserved for Docusign.
initialSentDateTimestringOptionalThe date and time that the envelope was first sent.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isDynamicEnvelopestringOptionalWhen **true,** indicates that the envelope is a dynamic envelope.
isSignatureProviderEnvelopestringOptionalWhen **true,** indicates that the envelope is a signature-provided envelope.
isTicketRelatedEnvelopestringOptional
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
locationstringOptionalReserved for Docusign.
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
messageLockstringOptionalWhen **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.
notificationModelOptionalExpand Gets envelope notification information — response body
An optional complex element that specifies the notification options for the envelope.
notificationUristringOptionalThe URI for retrieving notifications.
passwordstringOptionalThe 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.
powerFormModelOptionalExpand Creates a new Power Form — request body — body
Information about any PowerForms that are included in the envelope.
purgeCompletedDatestringOptionalThe date that a purge was completed.
purgeRequestDatestringOptionalThe date that a purge was requested.
purgeStatestringOptionalInitiates a purge request. Valid values are:

- `documents_queued`: Places envelope documents in the purge queue.
- `documents_and_metadata_queued`: Places envelope documents
and metadata in the purge queue.
- `documents_and_metadata_and_redact_queued`: Places envelope documents
and metadata in the purge queue and redacts personal information.

**Related topics**

- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)
- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)
recipientViewRequestModelOptionalExpand Returns a URL to the shared recipient view UI for an envelope — request body — body
recipientsModelOptionalExpand Deletes recipients from an envelope — request body — body
Specifies the envelope recipients.
recipientsLockstringOptionalWhen **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the sender of the envelope.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signerCanSignOnMobilestringOptionalWhen **true,** recipients can sign on a mobile device.

**Note:** Only Admin users can change this setting.
signingLocationstringOptionalSpecifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.
statusstringOptionalIndicates the envelope status. Valid values when creating an envelope are:

* `created`: The envelope is created as a draft. It can be modified and sent later.
* `sent`: The envelope will be sent to the recipients after the envelope is created.

You can query these additional statuses once the recipients have interacted with the envelope.

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusChangedDateTimestringOptionalThe data and time that the status changed.
templateIdstringOptionalThe ID of the template. If a value is not provided, Docusign generates a value.
templateRolesarrayOptionalThis object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements:

* `email`: The recipient's email address.
* `name`: The recipient's name.
* `roleName`: The template roleName associated with the recipient.
* `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true,** an error is generated on sending.
* `defaultRecipient`: Optional, When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.
* `routingOrder`: This specifies the routing order of the recipient in the envelope.
* `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters.
* `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters.
* `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients.
* `tabs`: This property enables the tab values to be specified for matching to tabs in the template.
templateRoles[]ModelEach itemExpand Creates an envelope — request body — body template Roles item
templatesUristringOptionalThe URI for retrieving any templates associated with the envelope.
transactionIdstringOptionalUsed to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. Docusign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to 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.
uSigStatestringOptional
useDisclosurestringOptionalWhen **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **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.
voidedDateTimestringOptionalThe date and time the envelope or template was voided.
voidedReasonstringOptionalThe reason the envelope or template was voided.

**Note:** The string is truncated to the first 200 characters.
workflowModelOptionalExpand Returns the workflow definition for a template — response body
Describes the workflow for this envelope.

Referenced models: Gets a list of custom fields — response body, Locks an envelope — response body, Updates an envelope attachment in a draft or in-process envelope — request body — body, Adds email setting overrides to an envelope — response body, Gets the status of a single envelope — response body — envelope Custom Metadata, Updates a template document — response body, Gets the status of a single envelope — response body — envelope Metadata, Gets envelope notification information — response body, Gets a specific template associated with a specified account — response body — owner, Returns the workflow definition for a template — response body, Deletes recipients from an envelope — request body — body, Creates an envelope — request body — body composite Templates item, Creates an envelope — request body — body documents item, Creates an envelope — request body — body event Notification, Creates an envelope — request body — body folders item, Creates a new Power Form — request body — body, Returns a URL to the shared recipient view UI for an envelope — request body — body, Creates an envelope — request body — body template Roles item

Creates an envelope — request body — body composite Templates item

FieldTypePresenceDescription and constraints
$objectRootThis 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/
compositeTemplateIdstringOptionalThe 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.
documentModelOptionalExpand Creates an envelope — request body — body documents item
An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.
inlineTemplatesarrayOptionalZero 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[]ModelEach itemExpand Creates an envelope — request body — body composite Templates item inline Templates item
pdfMetaDataTemplateSequencestringOptionalA number representing the sequence in which to apply the template that contains the PDF metadata.

Example: `4`
serverTemplatesarrayOptionalZero 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[]ModelEach itemExpand Creates an envelope — request body — body composite Templates item server Templates item

Referenced models: Creates an envelope — request body — body documents item, Creates an envelope — request body — body composite Templates item inline Templates item, Creates an envelope — request body — body composite Templates item server Templates item

Creates an envelope — request body — body composite Templates item inline Templates item

FieldTypePresenceDescription and constraints
$objectRoot
customFieldsModelOptionalExpand Gets a list of custom fields — response body
An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters.
documentsarrayOptionalA complex element that contains details about the documents associated with the envelope.
documents[]ModelEach itemExpand Creates an envelope — request body — body documents item
envelopeModelOptionalExpand Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body
A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.
recipientsModelOptionalExpand Deletes recipients from an envelope — request body — body
An array of recipient objects that provides details about the recipients of the envelope.
sequencestringOptionalSpecifies the order in which templates are overlaid.

Referenced models: Gets a list of custom fields — response body, Deletes recipients from an envelope — request body — body, Creates an envelope — request body — body documents item, Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body

Creates an envelope — request body — body composite Templates item server Templates item

FieldTypePresenceDescription and constraints
$objectRoot
sequencestringOptionalSpecifies the order in which templates are overlaid.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.

Creates an envelope — request body — body documents item

FieldTypePresenceDescription and constraints
$objectRootA document object.
applyAnchorTabsstringOptionalReserved for Docusign.
assignTabsToRecipientIdstringOptional
authoritativeCopybooleanOptionalWhen **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.
displaystringOptionalThis string sets the display and behavior properties of
the document during signing. Valid values:

* `modal`<br>
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`<br>
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.
docGenDocumentStatusstringOptional
docGenFormFieldsarrayOptional
docGenFormFields[]ModelEach itemExpand Updates a template document — response body — doc Gen Form Fields item
documentBase64stringOptionalThe 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.
documentFieldsarrayOptionalThe 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[]ModelEach itemExpand Updates an existing brand — response body — colors item
documentIdstringOptionalSpecifies the document ID of this document. This value is used by tabs to determine which document they appear in.
documentTemplateIdstringOptional
encryptedWithKeyManagerstringOptionalWhen **true,** the document has been encrypted by the sender for use with the Docusign Key Manager Security Appliance.
fileExtensionstringOptionalThe 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.
fileFormatHintstringOptional
htmlDefinitionModelOptionalExpand Creates a preview of the responsive version of a document — request body — body
Defines 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/).
includeInDownloadstringOptionalWhen **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.**
isDocGenDocumentstringOptional
matchBoxesarrayOptionalMatchboxes 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[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — documents item match Boxes item
namestringOptionalThe name of the document.
orderstringOptionalThe order in which to sort the results.

Valid values are:


* `asc`: Ascending order.
* `desc`: Descending order.
pagesstringOptionalThe number of pages in the document. This property is read-only.
passwordstringOptionalThe 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.
pdfFormFieldOptionstringOptional
remoteUrlstringOptionalThe 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/).
signerMustAcknowledgestringOptionalSets how the signer interacts with the supplemental document.
Valid values:

* `no_interaction`<br>
No recipient action is required.

* `view`<br>
The recipient is required to view the document.

* `accept`<br>
The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

* `view_accept`<br>
The recipient is required to view and accept the document.

signerMustAcknowledgeUseAccountDefaultbooleanOptionalWhen **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa).
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
transformPdfFieldsstringOptionalWhen **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.
uristringOptionalA URI containing the user ID.

Referenced models: Updates a template document — response body — doc Gen Form Fields item, Gets a specific template associated with a specified account — response body — documents item match Boxes item, Updates an existing brand — response body — colors item, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body, Creates a preview of the responsive version of a document — request body — body

Creates an envelope — request body — body event Notification

FieldTypePresenceDescription and constraints
$objectRootUse this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/).
deliveryModestringOptional
envelopeEventsarrayOptionalA list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.

To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
envelopeEvents[]ModelEach itemExpand Creates an envelope — request body — body event Notification envelope Events item
eventDataModelOptionalExpand Creates a Connect configuration — response body — event Data
Allows you to specify the format of the information the Connect webhooks returns.
eventsarrayOptionalA comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.

Set this property when you are using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property.

The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) are:

* `envelope-created`
* `envelope-sent`
* `envelope-resent`
* `envelope-delivered`
* `envelope-completed`
* `envelope-declined`
* `envelope-voided`
* `recipient-authenticationfailed`
* `recipient-autoresponded`
* `recipient-declined`
* `recipient-delivered`
* `recipient-completed`
* `recipient-sent`
* `recipient-resent`
* `template-created`
* `template-modified`
* `template-deleted`
* `envelope-corrected`
* `envelope-purge`
* `envelope-deleted`
* `envelope-discard`
* `recipient-reassign`
* `recipient-delegate`
* `recipient-finish-later`
* `click-agreed`
* `click-declined`
events[]stringEach item
includeCertificateOfCompletionstringOptionalWhen **true,** the Connect Service includes the Certificate of Completion with completed envelopes.
includeCertificateWithSoapstringOptionalWhen **true,**
the Connect service will digitally sign
the data.
The signature will be included in the message.
includeDocumentFieldsstringOptionalWhen **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.
includeDocumentsstringOptionalWhen **true,**
the Connect webhook messages
will include the envelope's PDF documents.
Including the PDF documents
greatly increases the size of the notification messages.
Ensure that your listener can handle
incoming messages that are 25MB or larger.
includeEnvelopeVoidReasonstringOptionalWhen **true,** this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message.
includeHMACstringOptionalWhen **true,** HMAC headers will be included with the webhook notifications.

**Note:** [HMAC must enabled](/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](/platform/webhooks/connect/setting-up-hmac/).
includeOAuthstringOptional
includeSenderAccountAsCustomFieldstringOptionalWhen **true,** Connect will include the sender account as Custom Field in the data.
includeTimeZonestringOptionalWhen **true,** the envelope's time zone information is included in the webhook messages.
integratorManagedstringOptional
loggingEnabledstringOptionalWhen **true,** the webhook messages are logged. They can be viewed on the Docusign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](/docs/esign-rest-api/reference/connect/connectevents/).
recipientEventsarrayOptionalA list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the URL property.

To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
recipientEvents[]ModelEach itemExpand Creates an envelope — request body — body event Notification recipient Events item
requireAcknowledgmentstringOptionalWhen **true,** the Docusign Connect service checks that the message was received and retries on failures.
signMessageWithX509CertstringOptionalWhen **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.
soapNameSpacestringOptionalThe namespace of the SOAP interface.

The namespace value must be set if useSoapInterface is set to true.
urlstringOptionalThe endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.

The maximum length of this property is 4096 bytes.
useSoapInterfacestringOptionalWhen **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface.

Referenced models: Creates a Connect configuration — response body — event Data, Creates an envelope — request body — body event Notification envelope Events item, Creates an envelope — request body — body event Notification recipient Events item

Creates an envelope — request body — body event Notification envelope Events item

FieldTypePresenceDescription and constraints
$objectRootFor which envelope events should your webhook be called?
envelopeEventStatusCodestringOptionalAn envelope status for which your webhook should be called. Valid values:

* `Sent`
* `Delivered`
* `Completed`
* `Declined`
* `Voided`
includeDocumentsstringOptionalWhen **true,**
the Connect webhook messages
will include the envelope's PDF documents.
Including the PDF documents
greatly increases the size of the notification messages.
Ensure that your listener can handle
incoming messages that are 25MB or larger.

Creates an envelope — request body — body event Notification recipient Events item

FieldTypePresenceDescription and constraints
$objectRoot
includeDocumentsstringOptionalWhen **true,**
the Connect webhook messages
will include the envelope's PDF documents.
Including the PDF documents
greatly increases the size of the notification messages.
Ensure that your listener can handle
incoming messages that are 25MB or larger.
recipientEventStatusCodestringOptionalSend a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.

Creates an envelope — request body — body folders item

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a folder.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
filterModelOptionalExpand Gets the list of templates — response body — folders item filter
An object used to present a filtered view of the items in a folder.
folderIdstringOptionalThe ID of the folder.
folderItemsarrayOptionalA list of envelopes and templates that the folder contains.
folderItems[]ModelEach itemExpand Creates an envelope — request body — body folders item folder Items item
foldersarrayOptionalA collection of folder objects returned in a response.
folders[]ModelEach itemExpand Creates an envelope — request body — body folders item
hasAccessstringOptionalWhen **true,** the current user has access to the folder.
hasSubFoldersstringOptionalWhen **true,** the folder has subfolders.
itemCountstringOptionalThe number of items in the folder.
namestringOptionalThe name of the folder.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the folder.
parentFolderIdstringOptionalThe ID of the parent folder, or the special value `root` for the root folder.
parentFolderUristringOptionalThe URI of the parent folder.
subFolderCountstringOptionalThe number of subfolders.
typestringOptionalThe type of folder. Possible values include:

- `draft`
- `inbox`
- `normal` (a system-generated folder)
- `recyclebin`
- `sentitems`
- `custom` (a custom folder created by a user)
uristringOptionalThe URI for the folder.

Referenced models: Locks a template — response body — error Details, Gets the list of templates — response body — folders item filter, Gets a specific template associated with a specified account — response body — owner, Creates an envelope — request body — body folders item, Creates an envelope — request body — body folders item folder Items item

Creates an envelope — request body — body folders item folder Items item

FieldTypePresenceDescription and constraints
$objectRootInformation about folder item results.
completedDateTimestringOptionalIf the item is an envelope, this is the UTC DateTime when the envelope was completed.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
envelopeIdstringOptionalIf the item is an envelope, this is the ID of the envelope.
envelopeUristringOptionalIf the item is an envelope, this is the URI for retrieving it.
expireDateTimestringOptionalThe date and time the envelope is set to expire.
folderIdstringOptionalThe ID of the folder.
folderUristringOptionalIf the item is a subfolder, this is the URI for retrieving it.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
ownerNamestringOptionalThe name of the user who owns the folder.
recipientsModelOptionalExpand Deletes recipients from an envelope — request body — body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderCompanystringOptionalThe name of the sender's company.
senderEmailstringOptionalThe sender's email address.
senderNamestringOptionalThe sender's name.
senderUserIdstringOptionalThe sender's id.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
statusstringOptionalIndicates 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.
subjectstringOptionalThe subject of the envelope.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateUristringOptionalThe URI for retrieving the template.

Referenced models: Deletes recipients from an envelope — request body — body

Creates an envelope — request body — body template Roles item

FieldTypePresenceDescription and constraints
$objectRootInformation about a specific role.
accessCodestringOptionalIf a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer `accessCode` property is set in the envelope, then that value is used.

If blank and the signer `accessCode` property is not set, then the access code is not required.
additionalNotificationsarrayOptionalAn array of additional notification objects.
additionalNotifications[]ModelEach itemExpand Deletes recipients from a template — response body — agents item additional Notifications item
clientUserIdstringOptionalSpecifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.

**Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.

Maximum length: 100 characters.
defaultRecipientstringOptionalWhen **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
emailstringOptionalThe email address of the person associated with a role name. It is the email address of the person specified in the `name` property.

For an in-person signer, this is the email address of the host.
emailNotificationModelOptionalExpand Deletes recipients from a template — response body — seals item email Notification
This optional property allows you to set a specific email subject and
body for this recipient's notification email.

**Note:** If you use this property, you _must_
provide a value for the `supportedLanguage` sub-property.


You can set the `emailNotification` property separately
for each recipient. If you set the value only for certain
recipients, the other recipients are assigned the values from
the top-level `emailSubject` and `emailBlurb`.
embeddedRecipientStartURLstringOptionalSpecifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.

It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets.

*Example*:

`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
inPersonSignerNamestringOptionalThe full legal name of the in-person signer.

Maximum Length: 100 characters.
namestringOptionalSpecifies the recipient's name.

For an in-person signer, this is the name of the host.
phoneNumberModelOptionalExpand Deletes recipients from a template — response body — agents item phone Number
Describes the recipient phone number.
recipientSignatureProvidersarrayOptionalThe default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)
recipientSignatureProviders[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Signature Providers item
roleNamestringOptionalOptional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients.
routingOrderstringOptionalSpecifies the routing order of the recipient in the envelope.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.
signingGroupTypestringOptional
signingGroupUsersarrayOptionalA complex type that contains information about users in the signing group.
signingGroupUsers[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Referenced models: Deletes recipients from a template — response body — agents item additional Notifications item, Deletes recipients from a template — response body — seals item email Notification, Deletes recipients from a template — response body — agents item phone Number, Deletes recipients from a template — response body — seals item recipient Signature Providers item, Gets a specific template associated with a specified account — response body — owner, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body

Creates an envelope — response body

FieldTypePresenceDescription and constraints
$objectRootThis object describes an envelope.
bulkEnvelopeStatusModelOptionalExpand Creates an envelope — response body — bulk Envelope Status
An object that describes the status of the bulk send envelopes.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientSigningUristringOptional
recipientSigningUriErrorstringOptional
statusstringOptionalIndicates the envelope status. Valid values are:

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `created`: The envelope is created as a draft. It can be modified and sent later.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `sent`: The envelope will be sent to the recipients after the envelope is created.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusDateTimestringOptionalThe DateTime that the envelope changed status (i.e. was created or sent.)
uristringOptionalA URI containing the user ID.

Referenced models: Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details

Creates an envelope — response body — bulk Envelope Status

FieldTypePresenceDescription and constraints
$objectRoot
batchIdstringOptionalSpecifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
batchSizestringOptionalThe number of items returned in this response.
bulkEnvelopesarrayOptionalA list of bulk envelope objects.
bulkEnvelopes[]ModelEach itemExpand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item
bulkEnvelopesBatchUristringOptionalURI at which you can retrieve the batch envelopes.
endPositionstringOptionalThe last index position in the result set.
failedstringOptionalThe number of entries with a status of failed.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
queuedstringOptionalThe number of entries with a status of queued.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
sentstringOptionalThe number of entries with a status of sent.
startPositionstringOptionalThe starting index position of the current result set.
submittedDatestringOptionalThe date on which the bulk envelope was created.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates an envelope — response body — bulk Envelope Status bulk Envelopes item

Creates an envelope — response body — bulk Envelope Status bulk Envelopes item

FieldTypePresenceDescription and constraints
$objectRoot
bulkRecipientRowstringOptionalThe row of the recipient in the CSV file used to create the bulk recipient list.
bulkStatusstringOptionalIndicates the status of the bulk send operation. Returned values can be:
- `queued`
- `processing`
- `sent`
- `failed`
emailstringOptionalThe email address of the recipient assigned to this envelope transaction.
envelopeIdstringOptionalGUID of the bulk envelope.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the recipient assigned to this envelope transaction.
submittedDateTimestringOptionalThe date and time on which the bulk envelope was created.
transactionIdstringOptionalIdentifier for the envelope transaction. The ID is a sender-generated value and is valid in the Docusign system for 7 days. Docusign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned.

Referenced models: Locks a template — response body — error Details

Creates custom document fields in an existing envelope document — response body

FieldTypePresenceDescription and constraints
$objectRootEnvelope document fields
documentFieldsarrayOptionalThe array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:

* name - A string that can be a maximum of 50 characters.
* value - A string that can be a maximum of 200 characters.

*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element.
documentFields[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Creates one or more templates — response body

FieldTypePresenceDescription and constraints
$objectRootSummary of a template request.
appliedstringOptionalReserved for Docusign.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing document's ID attribute.
documentNamestringOptionalThe name of the document.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the template.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateMatchModelOptionalExpand Creates one or more templates — response body — template Match
uristringOptionalA URI containing the user ID.

Referenced models: Locks a template — response body — error Details, Creates one or more templates — response body — template Match

Creates one or more templates — response body — template Match

FieldTypePresenceDescription and constraints
$objectRoot
documentEndPagestringOptional
documentStartPagestringOptional
matchPercentagestringOptional

Delete multiple user authorizations — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
authorizationsarrayOptional
authorizations[]stringEach item

Delete multiple user authorizations — response body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayOptional
results[]ModelEach itemExpand Delete multiple user authorizations — response body — results item

Referenced models: Delete multiple user authorizations — response body — results item

Delete multiple user authorizations — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
authorizationIdstringOptional
errorMessagestringOptional
successstringOptional

Deletes a Connect failure log entry — response body

FieldTypePresenceDescription and constraints
$objectRoot

Deletes a contact — response body

FieldTypePresenceDescription and constraints
$objectRootThis response objects shows the updated details for the contacts.
contactsarrayOptionalA list of contacts.
contacts[]ModelEach itemExpand Deletes a contact — response body — contacts item

Referenced models: Deletes a contact — response body — contacts item

Deletes a contact — response body — contacts item

FieldTypePresenceDescription and constraints
$objectRoot
canManagestringOptional
cloudProviderstringOptionalThe cloud service that provided the contact. Valid values are:

- `rooms`
- `docusignCore` (default)

<!-- Future:

- `Box`
- `GoogleDrive`
- `Dropbox`
- `SalesForce`
- `SkyDrive`

-->
cloudProviderContainerIdstringOptionalThe ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room.
contactIdstringOptionalThe ID of a contact person in the account's address book.
contactPhoneNumbersarrayOptionalA list of the contact's phone numbers.

**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:

- Sending an envelope by using SMS
- Using phone authentication

You must ask the user who added the contact for the phone number and then manually enter it into the authentication box.
contactPhoneNumbers[]ModelEach itemExpand Deletes a contact — response body — contacts item contact Phone Numbers item
contactUristringOptionalThe URI for retrieving information about the contact.
emailsarrayOptionalAn array of email addresses.
emails[]stringEach item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
isOwnerbooleanOptional
namestringOptionalThe name of the contact.
notaryContactDetailsModelOptionalExpand Deletes a contact — response body — contacts item notary Contact Details
organizationstringOptional
roomContactTypestringOptional
sharedstringOptionalWhen **true,** this contact is shared.
signingGroupstringOptionalThe ID of the signing group.
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.

Referenced models: Deletes a contact — response body — contacts item contact Phone Numbers item, Locks a template — response body — error Details, Deletes a contact — response body — contacts item notary Contact Details

Deletes a contact — response body — contacts item contact Phone Numbers item

FieldTypePresenceDescription and constraints
$objectRootDetails about the phone numbers associated with a specific contact.
phoneNumberstringOptionalThe contact's phone number.

Example: `+12223334444`
phoneTypestringOptionalThe type of phone number. Valid values are:

- `home`
- `mobile`
- `work`
- `other`
- `fax`

Deletes a contact — response body — contacts item notary Contact Details

FieldTypePresenceDescription and constraints
$objectRoot
hasDocusignCertificatestringOptional
jurisdictionsarrayOptional
jurisdictions[]ModelEach itemExpand Deletes a contact — response body — contacts item notary Contact Details jurisdictions item

Referenced models: Deletes a contact — response body — contacts item notary Contact Details jurisdictions item

Deletes a contact — response body — contacts item notary Contact Details jurisdictions item

FieldTypePresenceDescription and constraints
$objectRoot
authorizedForIPenstringOptional
authorizedForRonstringOptional
jurisdictionIdstringOptionalThe ID of the jurisdiction.
The following jurisdictions
are supported:

- `5 - California`
- `6 - Colorado`
- `9 - Florida`
- `10 - Georgia`
- `12 - Idaho`
- `13 - Illinois`
- `14 - Indiana`
- `15 - Iowa`
- `17 - Kentucky`
- `23 - Minnesota`
- `25 - Missouri`
- `30 - New Jersey`
- `32 - New York`
- `33 - North Carolina`
- `35 - Ohio`
- `37 - Oregon`
- `38 - Pennsylvania`
- `40 - South Carolina`
- `43 - Texas`
- `44 - Utah`
- `47 - Washington`
- `48 - West Virginia`
- `49 - Wisconsin`
- `62 - Florida Commissioner of Deeds`
jurisdictionNamestringOptional

Deletes a page from a document in an template — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
passwordstringOptionalThe 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.
rotatestringOptionalSets the direction the page image is rotated. The possible settings are: left or right

Deletes an existing user group — response body

FieldTypePresenceDescription and constraints
$objectRootThis object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/).
endPositionstringOptionalThe last index position in the result set.
groupsarrayOptionalA collection group objects containing information about the groups.
groups[]ModelEach itemExpand Deletes an existing user group — response body — groups item
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Deletes an existing user group — response body — groups item

Deletes an existing user group — response body — groups item

FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a group.
accessTypestringOptional
dsGroupIdstringOptionalReserved for Docusign.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupIdstringOptionalThe Docusign group ID for the group.
This is a read-only property.
groupNamestringOptionalThe name of the group.
groupTypestringOptionalThe group type.
isManagedByScimbooleanOptional
lastModifiedOnstringOptional
permissionProfileIdstringOptionalThe ID of the permission profile associated with the group.

Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)
to get a list of permission profiles and their IDs.
userGroupTypestringOptional
usersarrayOptionalA list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/)
users[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
usersCountstringOptionalThe total number of users in the group.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Deletes custom document fields from an existing template document — response body

FieldTypePresenceDescription and constraints
$objectRoot
documentFieldsarrayOptionalThe 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[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Deletes custom user settings for a specified user — response body

FieldTypePresenceDescription and constraints
$objectRoot
customSettingsarrayOptionalThe name/value pair information for the user custom setting.
customSettings[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Deletes documents from a draft envelope — response body

FieldTypePresenceDescription and constraints
$objectRoot
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe envelope ID.

Referenced models: Updates a template document — response body

Deletes documents from a template — response body

FieldTypePresenceDescription and constraints
$objectRootThe results of this method.
templateDocumentsarrayOptionalAn array of document objects that contain information about the documents associated with the template.
templateDocuments[]ModelEach itemExpand Updates a template document — response body
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.

Referenced models: Updates a template document — response body

Deletes envelope custom fields in a template — response body

FieldTypePresenceDescription and constraints
$objectRootContains information about custom fields.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Deletes files or sub-folders from a workspace — request body — body

FieldTypePresenceDescription and constraints
$objectRootAn array of objects that describe the items in a workspace.
itemsarrayOptionalA list of workspace items.
items[]ModelEach itemExpand Creates a workspace file — response body

Referenced models: Creates a workspace file — response body

Deletes one or more Power Forms — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
powerFormsarrayOptionalAn array of PowerForm objects.
powerForms[]ModelEach itemExpand Creates a new Power Form — request body — body

Referenced models: Creates a new Power Form — request body — body

Deletes one or more envelope attachments from a draft envelope — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayOptionalAn object that contains information about the attachment.
attachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body

Referenced models: Updates an envelope attachment in a draft or in-process envelope — request body — body

Deletes one or more envelope attachments from a draft envelope — response body

FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayOptionalAn array of attachment objects that contain information about the attachments.
attachments[]ModelEach itemExpand Deletes one or more envelope attachments from a draft envelope — response body — attachments item

Referenced models: Deletes one or more envelope attachments from a draft envelope — response body — attachments item

Deletes one or more envelope attachments from a draft envelope — response body — attachments item

FieldTypePresenceDescription and constraints
$objectRoot
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient. Possible values are:

- `.htm`
- `.xml`
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
labelstringOptional
namestringOptional

Referenced models: Locks a template — response body — error Details

Deletes one or more users from a group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
usersarrayOptionalAn array of `userInfo` objects containing information about the users in the group.
users[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner

Referenced models: Gets a specific template associated with a specified account — response body — owner

Deletes one or more users from a group — response body

FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
usersarrayOptionalUser management information.
users[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner

Referenced models: Gets a specific template associated with a specified account — response body — owner

Deletes recipients from a template — response body

FieldTypePresenceDescription and constraints
$objectRootSpecifies the envelope recipients.
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Deletes recipients from a template — response body — authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Deletes recipients from a template — response body — carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Deletes recipients from a template — response body — in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Deletes recipients from a template — response body — notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Deletes recipients from a template — response body — notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe number of recipients in the envelope.
sealsarrayOptionalA list of electronic seals to apply to documents.
seals[]ModelEach itemExpand Deletes recipients from a template — response body — seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Deletes recipients from a template — response body — signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Deletes recipients from a template — response body — witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — authorized Signatories item, Deletes recipients from a template — response body — carbon Copies item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — in Person Signers item, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — notaries item, Deletes recipients from a template — response body — notary Witnesses item, Deletes recipients from a template — response body — participants item, Deletes recipients from a template — response body — seals item, Deletes recipients from a template — response body — signers item, Deletes recipients from a template — response body — witnesses item

Deletes recipients from a template — response body — agents item

FieldTypePresenceDescription and constraints
$objectRootContains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.
accessCodestringOptionalIf a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer `accessCode` property is set in the envelope, then that value is used.

If blank and the signer `accessCode` property is not set, then the access code is not required.
accessCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
addAccessCodeToEmailstringOptionalOptional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.
additionalNotificationsarrayOptionalAn array of additional notification objects.
additionalNotifications[]ModelEach itemExpand Deletes recipients from a template — response body — agents item additional Notifications item
allowSystemOverrideForLockedRecipientstringOptionalWhen **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.
autoRespondedReasonstringOptionalError message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.
bulkSendV2RecipientstringOptional
clientUserIdstringOptionalSpecifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.

**Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.

Maximum length: 100 characters.
completedCountstringOptionalIndicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only.
consentDetailsListarrayOptional
consentDetailsList[]ModelEach itemExpand Deletes recipients from a template — response body — agents item consent Details List item
customFieldsarrayOptionalAn optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters.
customFields[]stringEach item
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
declinedReasonstringOptionalThe reason the recipient declined the document. This property is read-only.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
deliveryMethodMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
designatorIdstringOptionalReserved for Docusign.
designatorIdGuidstringOptionalReserved for Docusign.
documentTemplateIdstringOptional
documentVisibilityarrayOptionalA list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**
documentVisibility[]ModelEach itemExpand Updates document visibility for recipients — response body — document Visibility item
emailstringOptionalThe email ID of the agent. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.
emailMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `email` property is editable. This property is read-only.
emailNotificationModelOptionalExpand Deletes recipients from a template — response body — seals item email Notification
This optional property allows you to set a specific email subject and
body for this recipient's notification email.

**Note:** If you use this property, you _must_
provide a value for the `supportedLanguage` sub-property.


You can set the `emailNotification` property separately
for each recipient. If you set the value only for certain
recipients, the other recipients are assigned the values from
the top-level `emailSubject` and `emailBlurb`.
emailRecipientPostSigningURLstringOptional
embeddedRecipientStartURLstringOptionalSpecifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.

It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets.

*Example*:

`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
excludedDocumentsarrayOptionalSpecifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.

When enforce signer visibility is enabled, 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.
excludedDocuments[]stringEach item
faxNumberstringOptionalReserved for Docusign.
faxNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
firstNamestringOptionalThe recipient's first name. Maximum Length: 50 characters.
firstNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `firstName` property is editable. This property is read-only.
fullNamestringOptionalReserved for Docusign.
fullNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
idCheckConfigurationNamestringOptionalThe name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:

- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.
- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.
- `ID Check $`: The recipient must answer detailed security questions.

**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
idCheckConfigurationNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
idCheckInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input
An object that contains input information related to a recipient ID check.
identityVerificationModelOptionalExpand Deletes recipients from a template — response body — seals item identity Verification
Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
inheritEmailNotificationConfigurationstringOptionalWhen **true** and the envelope recipient creates a Docusign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
lastNamestringOptionalThe recipient's last name.
lastNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `lastName` property is editable. This property is read-only.
lockedRecipientPhoneAuthEditablestringOptionalReserved for Docusign.
lockedRecipientSmsEditablestringOptionalReserved for Docusign.
namestringOptionalThe full legal name of the recipient. Maximum Length: 100 characters.

**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `name` property is editable. This property is read-only.
notestringOptionalA note sent to the recipient in the signing email.
This note is unique to this recipient.
In the user interface,
it appears near the upper left corner
of the document
on the signing screen.

Maximum Length: 1000 characters.
noteMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `note` property is editable. This property is read-only.
phoneAuthenticationModelOptionalExpand Deletes recipients from a template — response body — seals item phone Authentication
When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:

* `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose.
* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.
* `recordVoicePrint`: Reserved for Docusign.
* `validateRecipProvidedNumber`: Reserved for Docusign.

phoneNumberModelOptionalExpand Deletes recipients from a template — response body — agents item phone Number
Describes the recipient phone number.
proofFileModelOptionalExpand Deletes recipients from a template — response body — seals item proof File
The proof file of the recipient.
recipientAttachmentsarrayOptionalReserved for Docusign.
recipientAttachments[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Attachments item
recipientAuthenticationStatusModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status
Information about the recipient's authentication status. This property is read-only.
recipientFeatureMetadataarrayOptionalMetadata about the features that are supported for the recipient type. This property is read-only.
recipientFeatureMetadata[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Feature Metadata item
recipientIdstringOptionalA local reference used to map
recipients to other objects, such as specific
document tabs.

A `recipientId` must be
either an integer or a GUID,
and the `recipientId` must be
unique within an envelope.

For example, many envelopes assign the first recipient
a `recipientId` of `1`.
recipientIdGuidstringOptionalThe 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.
recipientTypestringOptionalThe recipient type, as specified by the following values:
- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.
- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
- `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer.
- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
- `seal`: Electronic seal recipients represent legal entities.
- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.
recipientTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
requireIdLookupstringOptionalWhen **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
requireIdLookupMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
roleNamestringOptionalOptional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients.
routingOrderstringOptionalSpecifies the routing order of the recipient in the envelope.
routingOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signedDateTimestringOptionalReserved for Docusign.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
signingGroupIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.
signingGroupTypestringOptional
signingGroupUsersarrayOptionalA complex type that contains information about users in the signing group.
signingGroupUsers[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
smsAuthenticationModelOptionalExpand Deletes recipients from a template — response body — seals item sms Authentication
When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.

socialAuthenticationsarrayOptionalDeprecated.
socialAuthentications[]ModelEach itemExpand Deletes recipients from a template — response body — seals item social Authentications item
statusstringOptionalThe recipient's status. This property is read-only.

Valid values:

- `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.
- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).
- `declined`: The recipient declined to sign the documents in the envelope.
- `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope.
- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.
- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.
- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.
statusCodestringOptionalThe code associated with the recipient's status. This property is read-only.
suppressEmailsstringOptionalWhen **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox.
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
totalTabCountstringOptionalThe total number of tabs in the documents. This property is read-only.
userIdstringOptionalThe ID of the user to access.

**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
webFormRecipientViewIdstringOptional

Referenced models: Deletes recipients from a template — response body — seals item recipient Authentication Status, Deletes recipients from a template — response body — agents item consent Details List item, Updates document visibility for recipients — response body — document Visibility item, Locks a template — response body — error Details, Deletes recipients from a template — response body — seals item recipient Feature Metadata item, Deletes recipients from a template — response body — seals item id Check Information Input, Updates a template document — response body — name Metadata, Deletes recipients from a template — response body — agents item additional Notifications item, Deletes recipients from a template — response body — seals item recipient Attachments item, Deletes recipients from a template — response body — seals item email Notification, Deletes recipients from a template — response body — seals item identity Verification, Deletes recipients from a template — response body — seals item phone Authentication, Deletes recipients from a template — response body — agents item phone Number, Deletes recipients from a template — response body — seals item proof File, Deletes recipients from a template — response body — seals item sms Authentication, Deletes recipients from a template — response body — seals item social Authentications item, Gets a specific template associated with a specified account — response body — owner

Deletes recipients from a template — response body — agents item additional Notifications item

FieldTypePresenceDescription and constraints
$objectRootDescribes an additional notification method.
phoneNumberModelOptionalExpand Deletes recipients from a template — response body — agents item phone Number
The phone number to receive the additional notifcation.
secondaryDeliveryMethodstringOptionalThe secondary delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
secondaryDeliveryMethodMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata about the delivery method.
secondaryDeliveryStatusstringOptionalThe status of the delivery. This property is read-only.

One of:

- `autoresponded`
- `optedout`
- `limitreached`

Referenced models: Updates a template document — response body — name Metadata, Deletes recipients from a template — response body — agents item phone Number

Deletes recipients from a template — response body — agents item consent Details List item

FieldTypePresenceDescription and constraints
$objectRoot
consentKeystringOptional
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
signerConsentStatusstringOptional

Deletes recipients from a template — response body — agents item phone Number

FieldTypePresenceDescription and constraints
$objectRootDescribes the recipient phone number.
countryCodestringOptionalThe numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,

Do not include the `+` symbol.
countryCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the `countryCode` property is editable.
numberstringOptionalThe telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.

Do not include the `countryCode`. For US, Canada, and other
[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`.
numberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the `number` property is editable.

Referenced models: Updates a template document — response body — name Metadata

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.