Create Counterparty Contact

Purpose

To create a counterparty contact.

Endpoints

POST /counterparties/{organizationApiName}/counterpartyusers

Request Details

Request URL

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

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.CREATE, contracts.contracts.ALL

Possible Operation Types

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

Sample Request

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

Input JSON Keys

phoneNumberstring
Represents the phone number of the counterparty contact.

jobTitlestring
Represents the job title of the counterparty contact.

emailIdlong
Represents the email ID associated with the counterparty contact.

displayNamestring
Represents the name of the counterparty contact.

Sample Input

Copied{
  "phoneNumber": String,
  "jobTitle": String,
  "emailId": String,
  "displayName": String
}

Response JSON Keys

idstring
Represents the unique ID of the counterparty contact.

phoneNumberstring
Represents the phone number of the counterparty contact.

jobTitlestring
Represents the job title of the counterparty contact.

emailIdlong
Represents the email ID associated with the counterparty contact.

statusstring
Represents the status of the counterparty contact.
Value Description
active The counterparty contact is in use.
stopped-processing The counterparty contact is not in use.

Value	Description
active	The counterparty contact is in use.
stopped-processing	The counterparty contact is not in use.

counterPartystring
Represents the counterparty details.

displayNamestring
Represents the name of the counterparty contact.

Sample Response

Copied{
    "counterpartyusers": [
        {
            "phoneNumber": String,
            "displayName": String,
            "jobTitle": String,
            "emailId": String,
            "counterParty": {
                "organizationApiName": String
            },
            "id": String,
            "status": String
        }
    ]
}

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.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.