HelloSign for Salesforce Admin Guide

NOTE

All properties are optional unless specified.

HelloSign.HelloSignDocumentService.Document and HelloSign.HelloSignDraftDocumentService.Document

Property
Type
Description

recordId

Id

The Salesforce ID of the document file.
Required

formFields

List<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.

type

HelloSign.HelloSignDocumentService.FormFieldType*

An enum value representing the type of field. Options include:

  • TEXT Default
  • SIGNATURE
  • INITIALS
  • CHECKBOX
  • DATE_SIGNED

name

String

This is a display name for the field.
Default: “Custom Field”

x

Integer

Location coordinates of the field in pixels.
Default: 1

y

Integer

Location coordinates of the field in pixels.
Default: 1

width

Integer

The width of the field in pixels.
Default: 200

height

Integer

The width of the field in pixels.
Default: 50

required

Boolean

True if the field is required to be completed before signing.
Default: false

signer

HelloSign.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.

Updated 3 months ago

Document


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.