Update Negotiators

Purpose

To update negotiators in a contract.

Note: 

  • You can update negotiators only when the contract is in the Negotiation Review Pending status.
  • You should only add the IDs of the negotiators that need to be updated. 
     

Endpoints

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{contractApiName}/negotiators

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.UPDATE, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to contract information
UPDATE - Update negotiators information

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/contracts/msa-with-zenith-dynamics/negotiators"
-X UPDATE
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Input JSON Keys

  • usersJSON Array

    Represents the list of users to whom the contract is sent for negotiation.

  • idstring

    Represents the unique ID of the user to whom the contract is being sent. To get IDs of the negotiators, see Get Counterparty Contacts.

  • deliveryModeinteger

    Represents the delivery mode selected to send the contract for negotiation, either via email or offline. 

    Note: When the offline delivery mode is selected, a password must be included. 

    ValueDescription
    1Email
    2Offline
  • permissionsinteger

    Represents the level of access permissions granted to the user during negotiation.

    ValuesDescription
    7Write
    3Comment Only
    1View Only

  • Represents the password used for the offline authentication (e.g, "@467fg89o2"). 

    Note: When the Offline delivery mode is selected, the password must contain a minimum of 8 characters.

Sample Input

Copied{
  "users": [
    {
      "id": "3000000255757",
      "deliveryMode": 1,
      "password": 111111111,
      "permissions": 1
    },
    {
      "id": "3000000203329",
      "deliveryMode": 2,
      "password": 111111111
    }
  ]
}

Response JSON Keys

  • Typestring

    Represents the success response to the request through the value "Success."

  • idstring

    Represents the record is updated.

Sample Response

Copied{
    "action": [
        {
           "stage": "negotiation-review-pending"
        }
    ]
}

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.

NO_PERMISSIONHTTP 5005

You do not have permission to perform this action. Please contact your administrator for further details.

Resolution: The user does not have permission to read records. Contact your system administrator.