Update Service Preferences
Purpose
To update the service preferences in your organization.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/settings/service_preferences
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.modules.{operation_type}
Possible operation types
ALL - Full access to service preferences data
UPDATE - Update service preferences
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v5/settings/service_preferences"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Request JSON Keys
- job_sheet_enabledBoolean, mandatory
Denotes whether you want to enable the job sheet for your organization.
Possible Values:
true - Job Sheet is enabled. This is the default value.
false - Job sheet is disabled.
Sample Input
Copied{
"service_preferences": {
"job_sheet_enabled": false
}
}
Possible Errors
- API_NOT_SUPPORTEDHTTP 400
The API is not supported in this version.
Solution: This API is supported only from Version 3. - INVALID_DATAHTTP 400
You have specified an invalid value for the job_sheet_enabled key.
Solution: The datatype of job_sheet_enabled key is Boolean and the only possible values are true and false. - INVALID_REQUEST_METHODHTTP 400
You have given an invalid http request method type.
Solution: Use only PUT method in the request input to access this API. - INVALID_TOKENHTTP 401
You have used an invalid oauth token.
Solution: The access token you used has expired. Kindly refresh your token and retry. - OAUTH_SCOPE_MISMATCHHTTP 401
You created the grant token using the wrong oauth scope.
Solution: Use either ZohoCRM.settings.modules.UPDATE or ZohoCRM.settings.modules.ALL scope to create a new valid grant token. - NO_PERMISSIONHTTP 403
You do not have permission to update service preferences.
Solution: Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Solution: Unexpected and unhandled exception in the server. Please contact our support team.
Sample Response
Copied{
"service_preferences": {
"code": "SUCCESS",
"details": {},
"message": "Services preferences updated successfully",
"status": "success"
}
}