Delete Contract API

10min

Introduction
In the intricate landscape of contract management, the ability to rectify errors and ensure data accuracy is paramount. Enter the Delete Contract API, a powerful tool designed to address the inadvertent creation of contracts by providing a seamless mechanism for their removal. With a straightforward input of the contract ID, this API empowers organizations to swiftly rectify mistakes, enhancing the precision and integrity of their contract management processes.
The Delete Contract API offers a pragmatic solution for instances where contracts are erroneously generated. By leveraging the contract ID, organizations can efficiently remove unintended contracts, preventing potential complications and maintaining a clean and accurate repository. This introduction marks the beginning of an exploration into the features and functionalities of the Delete Contract API, showcasing its role in mitigating errors and fortifying the reliability of contract management workflows. Join us as we delve deeper into how this API contributes to the agility and accuracy of contract administration, ensuring that organizations can effortlessly rectify mistakes and uphold the highest standards of data integrity.
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call. 
API Details
The details of the API can be found here.
Sample cURL
Pre Production
Production
curl --location 'https://api.signzy.app/api/v3/contract/delete' \
--header 'Authorization: ******************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId" : "**************************"
}'
curl --location 'https://api.signzy.app/api/v3/contract/delete' \
--header 'Authorization: ******************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId" : "**************************"
}'
﻿
Input Parameters
Key
Description
Type
Mandatory/Optional
contractId
ID of the contract which needs to be deleted 
String
Mandatory
Sample Response
200
{
    "isSuccess": true
}
{
    "isSuccess": true
}
﻿
Output Parameters
Field Name
Description
Type
isSuccess
The status for the updation of the type of signature
String
Sample Errors
400
400
401
404
500
{
  "name": "error",
  "message": "Contract Expired",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
{
  "name": "error",
  "message": "Contract Expired",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
﻿
Error Parameters
Parameter
Type
Description
name
String
In case of errors, it will have the value "error". It represents an error.
message
String
Message for the error
reason
String
Reasons for the error
type
String
Type of error
statusCode
String
Status code of the error
Error Codes
Error Code
Error Message
Explanation
400
Bad Request
Input parameter has a missing required parameter or invalid inputs
401
Authorization Failed
Authorization token is invalid
404
Not found
Signer ID is not found in the system
500
Internal Server Error
Internal error at Signzy, Please reach out to [email protected]
﻿

Key	Description	Type	Mandatory/Optional
contractId	ID of the contract which needs to be deleted	String	Mandatory

Field Name	Description	Type
isSuccess	The status for the updation of the type of signature	String

Parameter	Type	Description
name	String	In case of errors, it will have the value "error". It represents an error.
message	String	Message for the error
reason	String	Reasons for the error
type	String	Type of error
statusCode	String	Status code of the error

Error Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
404	Not found	Signer ID is not found in the system
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]

Updated 30 Aug 2024

Did this page help you?

Complete Contract API

Generate Contract Query API