Docusign TemplateBulkRecipients API is one of 134 APIs that Docusign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include TemplateBulkRecipients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, a getting-started guide, rate-limit docs, and 1 JSON Schema.
This API exposes
3 operations
across 1 path,
and defines 72 schemas.
It is described by OpenAPI 3.2.0, at version v2.
Requests are made against a single base URL, https://www.docusign.net/restapi.
The identity and technical contract details declared by the specification.
radioGroup
object
This group tab is used to place radio buttons on a document. The radios property contains a list of [radio](https://developers.docusign.com/esign-rest-api/refe…
12 properties
addressInformationInput
object
Contains address input information.
3 properties
recipientEmailNotification
object
3 properties
recipientPhoneAuthentication
object
A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderPr…
4 properties
signerAttachment
object
A tab that allows the recipient to attach supporting documents to an envelope.
29 properties
initialHere
object
A tab that allows the recipient to initial the document. May be optional.
29 properties
socialAuthentication
object
1 property
fullName
object
A tab that displays the recipient's full name.
34 properties
recipientIdentityPhoneNumber
object
3 properties
addressInformation
object
Contains address information.
9 properties
emailAddress
object
A tab that displays the recipient's email as entered in the recipient information.
34 properties
zip
object
A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or with…
48 properties
number
object
A tab that allows the recipient to enter numbers and decimal (.) points.
49 properties
eventResult
object
4 properties
listItem
object
One of the selectable items in the listItems property of a [list](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/crea…
3 properties
bulkRecipient
object
10 properties
list
object
This tab offers a list of options to choose from. The listItems property contains a list of [listItem](https://developers.docusign.com/esign-rest-api/reference…
41 properties
view
object
This tab is used with the Approve tab to handle supplemental documents.
37 properties
smartSection
object
33 properties
bulkRecipientsRequest
object
1 property
decline
object
A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.
36 properties
checkbox
object
A tab that allows the recipient to select a yes/no (on/off) option.
32 properties
approve
object
A tab that allows the recipient to approve documents without placing a signature or initials on the document.
35 properties
signHere
object
A tab that allows the recipient to sign a document. May be optional.
31 properties
money
object
Describes information about the total of a payment.
3 properties
paymentSignerValues
object
1 property
propertyMetadata
object
2 properties
bulkRecipientTabLabel
object
2 properties
idCheckInformationInput
object
A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to s…
4 properties
bulkRecipientsSummaryResponse
object
4 properties
userInfo
object
10 properties
documentVisibility
object
5 properties
notarize
object
A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.
27 properties
radio
object
One of the selectable radio buttons in the radios property of a [radioGroup](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipie…
18 properties
title
object
A tab that displays the recipient's title.
41 properties
authenticationStatus
object
Contains information about the authentication status.
19 properties
note
object
A tab that displays additional information, in the form of a note, for the recipient.
37 properties
email
object
A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same paramet…
47 properties
bulkRecipientSignatureProvider
object
2 properties
paymentLineItem
object
A line item describes details about an individual line item in a payment request.
4 properties
firstName
object
A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on s…
34 properties
errorDetails
object
This object describes errors that occur. It is only valid for responses, and ignored in requests.
2 properties
envelopeId
object
A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab.
33 properties
mergeField
object
Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
5 properties
recipientProofFile
object
1 property
lastName
object
A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on sp…
34 properties
text
object
A tab that allows the recipient to enter any type of text.
50 properties
samlAssertionAttribute
object
4 properties
recipientSignatureInformation
object
Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipi…
3 properties
dobInformationInput
object
Complex type containing: dateOfBirth displayLevelCode receiveInResponse
3 properties
ssn4InformationInput
object
3 properties
ssn
object
A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Tex…
47 properties
smartSectionCollapsibleDisplaySettings
object
10 properties
recipientSignatureProvider
object
An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-ap…
4 properties
bulkRecipientsResponse
object
7 properties
signer
object
A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add…
62 properties
formulaTab
object
The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the…
52 properties
recipientSMSAuthentication
object
Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
1 property
smartSectionAnchorPosition
object
3 properties
date
object
A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this ta…
47 properties
recipientSAMLAuthentication
object
Contains the name/value pair information for the SAML assertion attributes: name - The name of the SAML assertion attribute. value - The value associated with…
1 property
bulkRecipientsUpdateResponse
object
1 property
recipientIdentityVerification
object
2 properties
EnvelopeRecipientTabs
object
All of the tabs associated with a recipient. Each property is a list of a type of tab.
27 properties
paymentDetails
object
When a formula tab has a paymentDetails property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuS…
15 properties
dateSigned
object
A tab that displays the date that the recipient signed the document.
34 properties
smartSectionDisplaySettings
object
12 properties
company
object
A tab that displays the recipient's company name.
41 properties
ssn9InformationInput
object
2 properties
recipientSignatureProviderOptions
object
Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](htt…
4 properties
recipientAttachment
object
6 properties
recipientIdentityInputOption
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Docusign publishes across the network.
