- SIGNER
- APPROVER
- ACCEPTOR
- FORM_FILLER
- CERTIFIED_RECIPIENT
Last updated on
Oct 29, 2024
Alert:
This article contains prerelease information. Release dates, features, and other information are subject to change without notice.
Alert:
Using the Send in Bulk CSV upload option does not support in-app authoring of fields. All fields must be placed on the document template before uploading to the Send in Bulk interface.
Create the CSV file
A CSV file is best created using a spreadsheet application like Excel, Numbers, Google Sheets, etc. Most spreadsheets can export into a CSV format, which is required for the upload to succeed.
Spreadsheets present the data in an easily readable table format, where the rows (i.e., records) and columns (i.e., fields) are easily discernable. When creating your CSV, each row represents one child agreement, and each column is one argument applied to the agreement (like the recipient email and personalized form fields).
Two things to consider before you start to build your CSV:
- The Send in Bulk template allows the configuration of many agreement options, and if the CSV does not explicitly define a setting, the default value from the parent template is used. So if all agreements have the same Agreement name, don't include that column in your CSV file.
- A value does not need to be placed in every field because a column exists. Empty fields are ignored, and the default from the parent Send in Bulk template is used. So there is no need to fill in every field in every record.
The CSV itself can be divided into three meaningful sections:
Note:
Customers using a legacy CSV file in the new experience will not be able to insert the Sender as the first signer. A new CSV using the new formatting must be created with the sender defined as the first recipient for each child agreement.
At least one and up to 100 recipients can be included in each child agreement.
Each recipient can be defined by five fields:
- Recipient_X:Email
- Recipient_X:Role
- Recipient_X:Auth_Type
- Recipient_X:Auth_Value
- Recipient_X:Private_Message
Where _X is the recipient index number (Recipient_1, Recipient_2, etc) and the argument after the : is the value used by the system to construct the agreement.
Only the email address is required. All other values can be ignored or inherited from the parent template by omitting the column or leaving the field empty.
Note:
Defining recipient values like the recipient name, title, and company can be achieved using uniquely named column headers that map to the like-named fields in the document. See Defining custom fields for merging field data into the agreements below.
Column headers are case-sensitive and must match the field names exactly.
Field values:
:Email - This field accepts any string in an email format (x@y.zz). Values in the :Email field that don't comply with the email format trigger an error.
:Role - Accepts the standard Roles for agreements:
- DELEGATE_TO_SIGNER
- DELEGATE_TO_APPROVER
- DELEGATE_TO_ACCEPTOR
- DELEGATE_TO_CERTIFIED_RECIPIENT
- DELEGATE_TO_FORM_FILLER
:Auth_Type - Accepts one of the below authentication methods. If an authentication method is defined that isn't enabled for the sending group, and error will be generated.
- PASSWORD - Password authentication requires the customer to enter the password value defined in the :Auth_Type field.
- KBA - Knowledge-based Authentication. US authentication only. The recipient is required to answer several questions drawn from public database sources.
- ADOBE_SIGN - Adobe Acrobat Sign authentication. Requires the recipient to authenticate to the Adobe identity system.
- PHONE - Text or Voice authentication delivered to the phone number defined in the :Auth_Value field.
- EMAIL_OTP - One Time Password via email authentication requires the user to enter a numeric password sent to the recipient's email address.
- GOV_ID - Government ID authentication requires the recipient to provide a government-issued identification (e.g., Driver's License or Passport).
:Auth_Value - Only applicable to PHONE and PASSWORD authentications. No other Auth_Type should include an Auth_Value. Accepts a string that defines the value used to validate the authentication method (when applicable).:
- PASSWORD authentication - A string that defines a value the recipient must enter to pass the authentication challenge.
- PHONE authentication - A string of numbers that defines the recipient's phone number. The phone number will be used to communicate the code to the recipient.
- The phone number must be formatted to have a hyphen between the country code and the phone number (e.g., 1-5555551212 and 91-9934765344)
- The phone number format may include a plus at the beginning and hyphens within the number to produce a more human-readable string as desired. (e.g., +1-555-555-1212)
- The phone number must be formatted to have a hyphen between the country code and the phone number (e.g., 1-5555551212 and 91-9934765344)
:Private_Message - A string of up to 1000 characters delivered to the recipient as a private message in their email body and on the e-signing page.
CC_X:Email - The email of an agreement participant who is CC'd to the agreement and only views the agreement once completed. Like the Recipient, the X value is a number that starts with 1 and increments up if you have multiple CC'd parties. e.g., IF you have three CC'd parties you would need to configure three columns: CC_1:EMAIL, CC_2:EMAIL, CC_3:EMAIL
These columns relate to the Agreement details and Agreement settings sections of the Send in Bulk configuration UI. When configuring the Send in Bulk transaction in the Acrobat Sign interface, you are setting the default values to be used if there isn't a value explicitly defined in these columns. There are five distinct fields:
- Locale - This defines the language (localization) applied to the recipient's experience. The email and e-signing page elements that are part of the Acrobat Sign template are localized only. Custom content added by the sender is not translated. The available values are:
- Basque (Spain) - eu_ES
- Bokmål (Norwegian) - nb_NO
- Catalan (Spain) - ca_ES
- Chinese - zh_CN
- Chinese (Taiwan) - zh_TW
- Croatian - hr_HR
- Czech - cs_CZ
- Danish - da_DK
- Dutch - nl_NL
- Finnish - fi_FI
- French - fr_FR
- German - de_DE
- Hebrew - iw_IL
- Hungarian - hu_HU
- Icelandic - is_IS
- Indonesia - in_ID
- Italian - it_IT
- Japanese - ja_JP
- Korean - ko_KR
- Malay - ms_MY
- Norwegian - no_NO
- Nynorsk (Norwegian) - nn_NO
- Polish - pl_PL
- Portuguese - pt_PT
- Portuguese (Brazil) - pt_BR
- Romanian - ro_RO
- Russian - ru_RU
- Slovak - sk_SK
- Slovenian - sl_SI
- Spanish - es_ES
- Swedish - sv_SE
- Thai - th_TH
- Turkish - tr_TR
- Ukrainian - uk_UA
- UK English - en_GB
- US English - en_US
- Vietnamese - vi_VN
- Agreement_Name - The Agreement name value that is inserted into the recipient email and provided on the Manage page.
- Expires - This field defines the number of days before the agreement will be automatically canceled.
- Agreement_Message - Defines the global message inserted into the recipient's email body.
- Order - This field describes the recipient flow:
- A string of recipients with only commas delimiting each recipient is identified as a sequential signature flow.
- All recipients within parentheses (Recipient_1,Recipient_2), are identified as being in a parallel signature flow. All members are notified at the same time, and all must sign.
- You can freely mix these methods in any order to create a hybrid signature flow:
e.g., Recipient_1,Recipient_2,(Recipient_3,Recipient_4,Recipient_5),Recipient_6,(Recipient_7,Recipient_8),Recipient_9
Adding custom field mapping to the Send in Bulk transaction begins with understanding the field name in the template you upload. The CSV file must use the document template's field name as the column header name.
For example, if you have a field in the document template named Investment, the column header in the CSV must be Investment.
If you intend to fill a field named StreetAddress , the column header in the CSV must be StreetAddress.
Column headers are case-sensitive and must match the field names exactly.
Caution:
There are six reserved words that cannot be used as custom field names:
- Name
- Title
- Company
- Date
- Role
