Send for Negotiation

Purpose

To add negotiators along with their permission, authentication type, and password, and to send the contract for negotiation.

Note:

  1. The negotiators list provided in this request will overwrite any existing negotiators.
  2. The first negotiator in the list is always considered as the primary negotiator who can edit and submit review.

Endpoints

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{contractApiName}/actions/send-for-negotiation

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.CREATE, contracts.contracts.ALL, ZohoWriter.documenteditor.all

Possible Operation Types

contracts.ALL - Full access to contract information
contracts.CREATE - Add negotiators information
documenteditor.ALL - Full access to document information

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/contracts/msa-with-zenith-dynamics/actions/send-for-negotiation"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Input JSON Keys

  • usersJSON Array

    The array represents the list of negotiators to be added to the contract where each item contains the details of each negotiators.

  • idstring

    Represents the unique ID of the negotiators. To get IDs of the negotiators, see Get Counterparty Contacts.

  • permissionsinteger

    Represents the negotiator's permission in the contract.

    ValuesDescription
    7Edit
    3Comment Only
    1View Only
  • messagestring

    Represents the message or note to send along with the negotiation request.

  • 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
  • passwordstring

    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{
  "message": "Kindly review the document",
  "users": [
    {
      "id": "3000000203329",
      "deliveryMode": 1
    },
    {
      "id": "3000000140127",
      "deliveryMode": 2,
      "permissions": 7,
	    "password":111111111,
    }
  ]
}

Response JSON Keys

  • actionJSON Array

    Represents the list of actions performed on the contract.

  • stagestring

    Represents the current stage of the contract after it has been sent for negotiation.

Sample Response

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

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect. Specify a valid request URL.

Resolution:  Provide a valid URL as mentioned in the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized. The client does not have contracts.contracts.CREATE scope.

Resolution:  Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to create. The user does not have permission to create records.

Resolution: Contact the organization administrator to request the required access.

INTERNAL_ERRORHTTP 500

Internal Server Error.

Resolution: Unexpected and unhandled exception in the server. Try again later or contact the support team for assistance.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution:  Specify a valid request method as specified in the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

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

Resolution: Contact the organization administrator to request the required access.

NO_PERMISSIONHTTP 5005

You cannot set permission for the primary contact.

Resolution: You must remove the permission key for the primary contact and then try again.