Send Request Reminder

Sends an email to the signer reminding them to sign the signature request.

🚧

You cannot send a reminder within 1 hour of the last reminder that was sent for the same email. This includes manual AND automatic reminders.

Class: HelloSign.SignatureRequestService

Return type: HelloSign.ServiceObjects.SignatureRequestResponse

Method

Name

sendReminder()

Acceptable Parameters

Name

Type

Required

Note

signature_request_id

String

HelloSign_Signature_Request_ID_c field from the HelloSign_HelloSign_Signature_Request_c object.

email_address

String

The email address of the signer to send a reminder to.

name

String

The name of the signer to send a reminder to. Include if two or more signers share an email address.

isLastCallout

Boolean

/**
 * Obtain signer details from a signature request record awaiting for signature
 */
HelloSign__HelloSign_Signature_Request__c sigReqRecord = [
    SELECT 
        HelloSign__Signature_Request_ID__c, 
        (SELECT HelloSign__Recipient_Email__c, HelloSign__Recipient_Name__c 
        FROM HelloSign__HelloSign_Document_Status_Details__r) 
    FROM HelloSign__HelloSign_Signature_Request__c 
    WHERE HelloSign__Latest_Action__c = 'Awaiting Signature'
][0];
HelloSign__HelloSign_Signature_Request_Detail__c sigReqDetail = sigReqRecord.HelloSign__HelloSign_Document_Status_Details__r[0];

// Required Params
HelloSign.SignatureRequestService sigReq = new HelloSign.SignatureRequestService(sigReqRecord.HelloSign__Signature_Request_ID__c);
sigReq.email_address = sigReqDetail.HelloSign__Recipient_Email__c;

// Optional Param
sigReq.name = sigReqDetail.HelloSign__Recipient_Name__c;

HelloSign.ServiceObjects.SignatureRequestResponse response = sigReq.sendReminder();

// object type: HelloSign.ServiceObjects.SignatureRequest
System.debug(response.signature_request);

// object type: List<HelloSign.ServiceObjects.Warning>
System.debug(response.warnings);