Delete Contract

9 min

Introduction

Client can choose to delete the contract from Signzy system once the contract is executed and need not be available in Signzy system. Parameters contactId and customerId are used to identify the contract to be deleted. Optional parameter deleteReason can be used to specify the reason of deletion to the signers.

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

Need to pass follow information

Sample Curl

Preproduction

Production

curl --location --request POST 'https://contracting-preproduction.signzy.tech/api/contractdetails/deleteContract' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "contractId": "..contractId..",
        "customerId": "..customerId..",
        "deleteReason": "..deleteReason..."
    }'

curl --location --request POST 'https://contracting.signzy.tech/api/contractdetails/deleteContract' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "contractId": "..contractId..",
        "customerId": "..customerId..",
        "deleteReason": "..deleteReason..."
    }'

Input Parameters

PARAMETERS	DESCRIPTION	REQUIRED/OPTIONAL
contractId	Unique Id of the contract	Required
customerId	Unique Id of the customer	Required
deleteReason	Reason of deletion. If present, it will be displayed in the email sent to the signers.	Optional

Sample Response

{
    "deleteResponse": "SUCCESS"
}

Response Parameter

PARAMETERS	DESCRIPTION
deleteResponse	delete response status for the contract

Sample Error

{
  "type": "Error",
  "status": 400,
  "code": "Invalid Customer Id",
  "statusCode": 400
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.statusCode	Request Status code from Signzy
error.name	the name of the error
error.message	the error message
type	type of the error

Error Codes

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter or not a valid one.
401	Authorization Failed	Authorization token is invalid.
500	Internal Server Error	Internal error at Signzy, please contact support.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].