Skip to product menu
Skip to main content

Create Counterparty Type

Purpose

To create a counterparty type in Choice Lists.

Request Details

Request URL

https://contracts.zoho.com/api/v1/admin/counterpartytypes

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.meta.CREATE, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to counterparty type details
CREATE - Create counterparty type

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/admin/counterpartytypes/"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Input JSON Keys

  • namestring

    Represents the name of the counterparty type.

Sample Input

Copied{
       "name": "Procurement"
}

Response JSON Keys

  • modifiedTimestring

    Represents the last modified time of the counterparty type.

  • namestring

    Represents the name of the counterparty type.

  • idstring

    Represents the unique ID of the counterparty type.

  • addedByuser

    Represents the user who created the counterparty type.

  • apiNamestring

    Represents the API name of the counterparty type.

  • addedTimestring

    Represents the time when the counterparty type was added.

  • modifiedByuser

    Represents the user who last modified the counterparty type.

Sample Response

Copied{
   "counterpartytypes":[
      {
         "modifiedTime":"Oct 09, 2023 12:23 PM",
         "apiName":"procurement",
         "addedBy":{
            "displayName":"Smith Jones",
            "emailId":"smith.jones@zylker.com",
            "id":"596000000183025"
         },
         "name":"Procurement",
         "addedTime":"Oct 09, 2023 12:23 PM",
         "modifiedBy":{
            "displayName":"Smith Jones",
            "emailId":"smith.jones@zylker.com",
            "id":"596000000183025"
         },
         "id":"683000001585589"
      }
   ]

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.meta.CREATE scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to create

Resolution: The user does not have permission to create 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 create module details.

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

CONFLICTHTTP 409

ErrorCode: 2236

A Counterparty Type with the same name already exists.

Resolution: Create the counterparty type with a different name.

Sample Response

{

 "Errors":

 {

 "ErrorCode": 2236,

 "ErrorMessage": "A Counterparty Type with the same name already exists."

 }

}

 Zoho Contracts Developer Community