What are Editable Merge Fields, aka Custom Fields?
Editable Merge Fields (referred to as “Custom Fields” in the API documentation) let requesters allow signers to edit data that has already been pre-filled in by the requester.
The ability of the signer to edit the field is only for single-signer requests, OR the first signer of ordered signature requests. If there's more than one signer in an unordered request with editable fields, the editor value WILL be ignored and the field will not be editable.
When are Editable Merge Fields useful?
Editable Merge Fields are particularly useful when requesters have information that can potentially be corrected by signers. Examples:
- Name: the requester has pre-populated the name “William” in the field for “signer name.” However, the signer actually prefers “Bill.” With Editable Merge Fields, the signer will be able to easily change “William” to “Bill” without requiring the requester to re-send the document.
- Phone number: the requester has an incorrect number, or the signer prefers an alternative number (e.g. Google Voice number instead of cell).
What should Editable Merge Fields not be used for?
For information that should not be corrected or changed, we recommend not allowing signers to edit. Examples:
- Pertinent contract-related information (e.g. pricing)
- Financial-related information (e.g. salary details)
To turn on editable merge fields
Two endpoints will allow you to use this feature:
You will see a new implementation to pass information into the template.
You also will to change the signer assigned to the field to 'Me(when sending).
Note: “Merge Fields” are referred to as “Custom Fields” in the API documentation.
In this example, the signer role ‘Client’ is allowed to edit the field. This following example is a cURL call. We also have code examples from other popular languages.
By allowing the custom_fields to be editable, the signer will now see an editable field, like this:
We also have walkthroughs in our API documentation. We’ve created a new section on how to use merge fields. Because Editable Merge Fields work only with templates, if you’d like to start from the very beginning, start with our creating templates walkthrough.
**Please Note: Editable merge fields are available for single signer request only, or for the first signer of ordered signature requests. If more than one signer is assigned to the unordered signature request, any editor value is ignored and the field will not be editable.