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




All properties are optional unless specified.

HelloSign.HelloSignDocumentService.SignatureRequest and HelloSign.HelloSignDraftDocumentService.SignatureRequest

signers(link later) HelloSign.HelloSignDocumentService.Signer*The list of signers.
titleā€ StringThe title you want to assign to the Signature Request.
subjectStringThe subject in the email that will be sent to the signers.
messageStringThe custom message in the email sent to signers.
signingRedirectUrlStringThe URL you want the signer redirected to after they successfully sign.
ccEmailsListThe email addresses that should be Cc'd.
customFieldsList<HelloSignDocumentService.CustomField>List of dynamic merge fields for use with Text Tags-enabled documents. See Example #3 above.
metadataMap<String, String>Key-value data to attach to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 7 metadata keys, with key names up to 40 characters long and values up to 1000 characters long.
testModeBooleanTurns on HelloSign test mode for the signature request. Signature requests with test mode enabled are not legally binding. This is overridden if Test Mode is enabled in HelloSign for Salesforce settings.
Default: false
useTextTagsBooleanSet to true to enable Text Tags parsing in the document.
Default: true
hideTextTagsBooleanSet to true to enable automatic Text Tag removal. When using Text Tags it is preferred that you set this to false and hide your tags with white text or something similar to prevent unwanted clipping.
Default: false
allowDeclineBooleanAllows signers to decline to sign a document
Default: true
allowReassignBooleanAllows signers to assign the document to another signer.
Default: false
usePreexistingFieldsā€”BooleanIf youā€™re not using Text Tags but rather pre-defined fields in your PDF, set this to true and useTextTags to false. We currently only support the use of either Text Tags or pre-defined fields, not both.
Default: false
  • For HelloSign.HelloSignDraftDocumentService.SignatureRequest the property type for signers is List<HelloSign.HelloSignDraftDocumentService.Signer>.
    ā€  Only for use with HelloSign.HelloSignDocumentService.SignatureRequest
    ā€” Only for use with HelloSign.HelloSignDraftDocumentService.SignatureRequest.