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

📘

NOTE

All properties are optional unless specified.

HelloSign.HelloSignDocumentService.Document and HelloSign.HelloSignDraftDocumentService.Document

PropertyTypeDescription
recordIdIdThe Salesforce ID of the document file.
Required
formFieldsList<HelloSign.HelloSignDocumentService.FormField>List of form fields to appear on the document.
Note that text tags inside the document are often preferred to form fields.
typeHelloSign.HelloSignDocumentService.FormFieldType*An enum value representing the type of field. Options include:
TEXT Default
SIGNATURE
INITIALS
CHECKBOX
* DATE_SIGNED
nameStringThis is a display name for the field.
Default: “Custom Field”
xIntegerLocation coordinates of the field in pixels.
Default: 1
yIntegerLocation coordinates of the field in pixels.
Default: 1
widthIntegerThe width of the field in pixels.
Default: 200
heightIntegerThe width of the field in pixels.
Default: 50
requiredBooleanTrue if the field is required to be completed before signing.
Default: false
signerHelloSign.HelloSignDocumentService.Signer†The signer responsible for completing the field.
Required
  • For HelloSign.HelloSignDraftDocumentService.FormField the property type for type is HelloSign.HelloSignDraftDocumentService.FormFieldType.
    † For HelloSign.HelloSignDraftDocumentService.FormField the property type for signer is HelloSign.HelloSignDraftDocumentService.Signer.