Guides

Cancel Signature Request

Cancels an incomplete signature request. This action is not reversible.

🚧

This action is not reversible.

🚧

A 200 OK response does not indicate a successful cancelation of the signature request itself.

  • The cancelation is confirmed via the "signature_request_canceled" event.
  • Our package will handle the event for you updating the HelloSign_Latest_Action_c field to cancelled on the HelloSign_HelloSign_Signature_Request_c object.

Class: HelloSign.SignatureRequestService

Return type: String

Method

Name
cancel()

Acceptable Parameters

NameTypeRequiredNote
signature_request_idStringHelloSign_Signature_Request_ID_c field from the HelloSign_HelloSign_Signature_Request_c object.
isLastCalloutBoolean
String sigReqId = [
    SELECT HelloSign__Signature_Request_ID__c
    FROM HelloSign__HelloSign_Signature_Request__c
    WHERE Id = 'a063F00000GGTQ7QAP'].HelloSign__Signature_Request_ID__c;

// Returns the 200 status code
String statusCode = new HelloSign.SignatureRequestService(sigReqId).cancel();