Delete Counterparty

Purpose

To delete a counterparty.

Endpoints

DELETE /counterparties/{organizationApiName}

Request Details

Request URL

https://contracts.zoho.com/api/v1/counterparties/{organizationApiName}

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.DELETE, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to counterparty details
DELETE - Delete counterparty details

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/counterparties/ABCcompany"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

Typestring
Represents the success response to the request.

organizationApiNamestring
Represents the name of the counterparty in the API.

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.contracts.DELETE scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to delete

Resolution: The user does not have permission to delete records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to delete module details.

Resolution: The user does not have permission to delete module details. Contact your organization administrator.

Sample Response

Copied{
  "Type": String,
  "organizationApiName": String
}