E-signature Envelope Void

Expire or void envelopes associated with an object.

Resource 

1/connect/e-sign/signature-requests/$SOURCE_OBJECT_ID/envelopes/void

Available Version 

56.0

HTTP Methods 

PATCH

Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v56.0/connect/e-sign/signature-requests/{sourceObjectId}/envelopes/void

JSON Example 

1{
2    "voidedReason": "",//required
3    "senderEmail": ""
4}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
senderEmailStringRefers to the email of the user who initiated the voiding.Optional56.0
voidedReasonStringReason for which the envelope is being voided.Required56.0

Response Body for PATCH 

Envelope Void Response