Update Tags
Purpose
To update tags and their color codes.
Request Details
Request URL
{api-domain}/crm/{version}/settings/tags?module={module_api_name}
To update a specific tag: {api-domain}/crm/{version}/settings/tags/{tag_id}?module={module_api_name}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Notes, and Activities
Header
Authorization: Zoho-oauthtoken 100xx.92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.ALL
(or)
scope=ZohoCRM.settings.tags.{operation_type}
Possible operation types
ALL - Full data access
WRITE - Edit tag data
UPDATE - Update tag data
Parameters
- modulestring, mandatory
Specify the API name of the module such as Leads, Contacts, Accounts, Deals, etc,.
Input JSON Keys
- idstring, mandatory for updating multiple tags
Specify the unique ID of the tag that you want to update.
- color_codestring, optional
Specify the hex value of the color you want to add to the tag. The allowed color codes are "#F17574","#F48435","#E7A826","#A8C026","#63C57E","#1DB9B4","#57B1FD","#879BFC","#D297EE","#FD87BD","#969696","#658BA8","#B88562". If you do not include this key in the input, the color code will be set as null.
Sample Input
Copied
Possible Errors
- INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - 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 endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to update tags
Resolution: The user does not have the permission to update tags. Contact your system administrator. - INVALID_DATAHTTP 400
The color is not supported.
The tag's name has exceeded 25 characters in length.
The tag's name has one or more special characters <, >, or a comma.
The tag's name has emojis.
The ID of the tag is invalid.
Resolutions:
You can add only one of the colors specified in the list of allowed colors.
The tag's name must not exceed 25 characters in length.
The tag's name must not contain these special characters: <, >, or a comma.
You cannot have emojis in the tag name.
Specify a valid tag ID to update it.
- DUPLICATE_DATAHTTP 400
duplicate data
Resolution: You have specified a duplicate value for one or more unique fields. Refer to Fields Metadata API to know the unique fields. - MANDATORY_NOT_FOUNDHTTP 400
required field not found
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields. - REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameter is missing
Resolution: 'module' parameter is missing in the request. Please specify the API name of the module. Refer to Modules API to get valid module API names. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.tags.UPDATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to update tag details
Resolution: The user does not have permission to update tags. Contact your system administrator. - 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 request URL section above. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
Sample Response
Copied