Update Calls Preferences
Purpose
To enable or disable the Calls Preferences in the Calls module in your Zoho CRM organization.
Endpoints
- PUT /settings/call_preferences
Request Details
Request URL
{api-domain}/crm/{version}/settings/call_preferences
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.settings.modules.UPDATE
(or)
ZohoCRM.settings.modules.ALL
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/call_preferences"
-X PUT
-d "@updatepreferences.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Input JSON
- call_preferencesJSON object
Contains the Call Preference details in the Calls module.
- show_to_number Boolean
Enable or Disable the "To Number" field in the Calls module.
- show_from_number Boolean
Enable or Disable the "From Number" field in the Calls module.
Note
- Enabling the "From Number" or "To Number preferences will add the corresponding fields in the Calls module. Please note that if you enable the "Mark as Required" option for any of these fields, you will not be able to disable the Call Preferences options, either through the UI or via this API.
- You cannot disable the Call Preferences fields in the Calls module if they are configured in features such as Validation Rules, Layout Rules, or Telephony integrations.
- When a telephony extension is integrated, the system automatically enables the From Number and To Number fields in the Calls module.
Sample Input
Copied{
"call_preferences": {
"show_to_number": true,
"show_from_number": true
}
}Possible Errors
- INVALID_DATAHTTP 400
- Invalid data given in the input body
Resolution: Specify valid values along with the respective datatypes. Refer to the Input JSON section. - Input body should not be empty
Resolution: Specify valid values in the input body. Refer to the Input JSON section. - The data type for the given fields are invalid
Resolution: Both the "show_to_number" and "show_from_number" data types are Boolean.
- Invalid data given in the input body
- NOT_ALLOWEDHTTP 400
- Preferences cannot be disabled if the "From Number" or "To Number" fields are marked as required (mandatory fields).
Resolution: You can disable these fields only if they are not mandatory. - Preferences cannot be disabled because the "From Number" and "To Number" fields are being used in other configurations, such as Layout Rules, Validation Rules, and Telephony integration.
Resolution: Remove the From/To Number fields from configurations and try disabling them.
- Preferences cannot be disabled if the "From Number" or "To Number" fields are marked as required (mandatory fields).
- INVALID_REQUEST_METHODHTTP 400
The http request method type 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. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to update calls preferences fields in the Calls module. Create a new token with valid scope. Refer to the Scope section. - AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the Request URL section.Refer to the request URL section above. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.
Sample Response
Copied{
"call_preferences": {
"code": "SUCCESS",
"details": {},
"message": "Calls preferences updated successfully",
"status": "success"
}
}