Create Collaborators
Purpose
To add collaborators to a contract.
Request Details
Request URL
https://contracts.zoho.com/api/v1/contracts/{contractApiName}/collaborators
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.CREATE, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to collaborator details
CREATE - Post collaborator details
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/contracts/{contractApiName}/collaborators"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Input JSON Keys
- usersJSON Array
Represents the list of collaborators to be added to the contract where each item contains the details of each collaborator.
- idstring
Represents the unique ID of the collaborator.
- permissionsinteger
Represents the collaborator's permission in the contract document.
Value Description 7 Write 11 Comment and Fill Fields 9 Fill Fields Only 3 Comment Only 1 View Only
- messagestring
Represents the message to be included in the notification email sent to the collaborator.
- notifyBoolean
Represents whether to send an email notification upon addition.
Sample Input
Copied"users": [
{
"id":"4420000000166067",
"permissions":7,
"message":"Please go through the contract and share your comments",
"notify":true
}
]Response JSON Keys
- collaboratorsJSON Array
Represents the list of all collaborators in the contract where each item contains the details of a collaborator.
- modifiedTimestring
Represents the last modified time of the collaborator.
- displayNamestring
Represents the name of the collaborator.
- permissionsinteger
Represents the collaborator's permission in the contract document.
Value Description 7 Write 11 Comment and Fill Fields 9 Fill Fields Only 3 Comment Only 1 View Only
- addedByJSON Object
Represents the details of the user who added the collaborator.
- addedTimestring
Represents the time the collaborator was added.
- emailIdJSON Object
Represents the email ID of the collaborator.
- modifiedByJSON Object
Represents the details of the user who last modified the collaborator.
- idstring
Represents the unique ID of the collaborator.
- zuidLong
Represents the Zoho User ID of the collaborator.
Sample Response
Copied{
"collaborators": [
{
"modifiedTime": "Jul 18, 2023 12:24 PM",
"displayName": "Anna Hilla",
"permissions": 7,
"addedBy": {
"displayName": "Smith Jones",
"emailId": "smith.jones@zylker.com",
"id": "596000000183025"
},
"addedTime": "Jun 29, 2023 09:10 AM",
"emailId": "anna.hilla@zylker.com",
"modifiedBy": {
"displayName": "Smith Jones",
"emailId": "smith.jones@zylker.com",
"id": "596000000183025"
},
"id": "4420000000166067",
"zuid": 77190576
}
]
}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.