HelloSign for Salesforce Admin Guide

SignatureRequest

NOTE

All properties are optional unless specified.

HelloSign.HelloSignDocumentService.SignatureRequest and HelloSign.HelloSignDraftDocumentService.SignatureRequest

Property
Type
Description

signers

(link later) HelloSign.HelloSignDocumentService.Signer*

The list of signers.
Required

title†

String

The title you want to assign to the Signature Request.

subject

String

The subject in the email that will be sent to the signers.

message

String

The custom message in the email sent to signers.

signingRedirectUrl

String

The URL you want the signer redirected to after they successfully sign.

ccEmails

List<String>

The email addresses that should be Cc'd.

customFields

List<HelloSignDocumentService.CustomField>

List of dynamic merge fields for use with Text Tags-enabled documents. See Example #3 above.

metadata

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

testMode

Boolean

Turns 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

useTextTags

Boolean

Set to true to enable Text Tags parsing in the document.
Default: true

hideTextTags

Boolean

Set 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

allowDecline

Boolean

Allows signers to decline to sign a document
Default: true

allowReassign

Boolean

Allows signers to assign the document to another signer.
Default: false

usePreexistingFields‡

Boolean

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

Updated 27 days ago

SignatureRequest


Suggested Edits are limited on API Reference Pages

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