Update Obligation Status
Purpose
To update an obligation's status.
Request Details
Request URL
https://contracts.zoho.com/api/v1/actions/updatestatus/contracts/{contractApiName}/obligations/{apiName}
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.UPDATE, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to obligations
UPDATE - Update obligation status
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/actions/updatestatus/contracts/NDA/obligations/DataReview"
-X UPDATE
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Input JSON Keys
- instanceIDnumber(long)
Represents the unique ID of the instance of a task in an obligation.
- statusinteger
Represents the status of an obligation.
Value Description 0 Deleted 1 Active 13 Paused 14 Completed 16 Yet to start 17 Scheduled
Sample Input
Copied{
"instanceId": Number(Long),
"status": Number,
}Response JSON Keys
- Typestring
Represents the success response to the request.
- obligationsstring(apiName)
Represents the API name of the obligation that has been updated.
Sample Response
Copied{
"Type": String,
"obligations": String (apiName)
}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.UPDATE scope. Create a new client with valid scope. Refer to the Scope section above.
NO_PERMISSIONHTTP 403
Permission denied to update
Resolution: The user does not have permission to update 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 update module details.
Resolution: The user does not have permission to update module details. Contact your organization administrator.