Abandon Request function

Additional Notes

Table with values for request_status, request_status_info, request_status_date and description:

request_status	request_status_info	request_status_date	description
2	REQUEST_DRAFT	Date of creation	Request state is draft
3	REQUEST_ACCEPTED	Date of last signature	Request document(s) is/are signed
4	REQUEST_LIVE	Date when request was live (sent to recipients)	Request is still waiting for one or more signatures
5	REQUEST_CANCELED	Date when the requester cancelled	Request has been cancelled by requester
6	REQUEST_REJECTED	Date when the recipient rejected	Request has been declined by a recipient
7	REQUEST_EXPIRED	Date of expiry	Request is expired

HTTP Request

Request Content-Type: application/json

JSON BODY PARAMS - name and value pairs description:

request_id: LCS request identifier to update; Value of "request_id" or "unique_submit_id". JSON Data Type: String
request_id_type (optional): Type of LCS identifier for "request_id" field; Values: "request_id" or "unique_submit_id"; Default value: "request_id"; JSON Data Type: String
send_notification (optional): Send notification to all recipients; Value: Boolean (true or false); Default value: false
custom_message (optional): custom message for all recipients; Value: String (UTF-8 chars)

Exemples of JSON for Abandon Request

Example of HTTP Request JSON Body data to abandon a request with a custom message for recipients:

{
	"request_id": "02GB0G",
	"request_id_type": "request_id",
	"send_notification": true,
	"custom_message": "This is a custom message for recipients"
}