CustomField

Constructor


HelloSign.ServiceObjects.CustomField()
HelloSign.ServiceObjects.CustomField(String name, String value)

Parameters

Name	Type	Note
name	String	The name, or "Field Label," of the custom field (the field's API ID can be used here as well)
value	String
editor	String	The RoleName or Index Based signer allowed to edit the custom field (optional, but required if 'required' is defined) Editable custom_fields are only supported for single signer requests or 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.
required	Boolean	Not setting a value will use the default value false.
validation_type	String	Please visit the "Data validation types" section through the following link for more information: https://app.hellosign.com/api/reference
validation_custom_regex	String
validation_custom_regex_format_label	String

HelloSign.ServiceObjects.CustomField firstField = new HelloSign.ServiceObjects.CustomField(
    'myFirstField',
    'Hello First Field'
);
firstField.validation_type = 'letters_only';
firstField.editor = 'Contact.signer1';
firstField.required = true;

HelloSign.ServiceObjects.CustomField secondField = new HelloSign.ServiceObjects.CustomField(
    'mySecondField',
    'Salutations Second Field'
);
secondField.validation_type = 'custom_regex';
secondField.validation_custom_regex = '^[\\s\\S]{1,10}$';
secondField.validation_custom_regex_format_label = 'Please enter no more than 10 characters';
secondField.required = false;

HelloSign.ServiceObjects.CustomField thirdField = new HelloSign.ServiceObjects.CustomField();
thirdField.name = 'myThirdField';
thirdField.value = 'Goodbye Third Field';