Guides
These docs are for v4.6. Click to read the latest docs for v4.29.

CustomField

πŸ“˜

NOTE

All properties are optional unless specified.

HelloSignDocumentService and
HelloSignDraftDocumentService

PropertyTypeDescription
nameStringThe key corresponding to the field name specified in the embedded Text Tag.
Required
valueStringThe value for the custom merge field.
Required
editorStringThe index number of the signer who can edit the field if the Text Tag is set up as an editable merge field. NB: The index number is offset by one, so use 0’ for signer 1, β€˜1’ for the second signer, β€˜2’ for signer 3, etc.
Required if required is set to true.
requiredBooleanA boolean describing if this field is required.
Default: false