Add new tags

Add new tags to a module and receive their tag IDs upon a successful API call. Additionally, you can further add these tags to records within a module.

Endpoints

POST /settings/tags

Request URL

{api-domain}/bigin/v2/settings/tags?module={module_api_name}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.settings.ALL
ZohoBigin.settings.tags.ALL
ZohoBigin.settings.tags.WRITE
ZohoBigin.settings.tags.CREATE

Request parameters

The available request parameters are given below:

Query parameters

module stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products
Tasks	Tasks
Events	Events
Calls	Calls

Body parameters

name stringRequired

The name of the tag you want to add to a module. For example, Important.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/tags?module=Calls" \
-X POST \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@createnewtag.json"

Copiedtag1 = Map();
tag1.put("name", "Important");

tag2 = Map();
tag2.put("name", "Scheduled");

tags_list = List();
tags_list.add(tag1);
tags_list.add(tag2);

param = Map();
param.put("tags", tags_list);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v2/settings/tags?module=Calls"
	type :POST
	parameters: param.toString()
	connection:"connection_link_name"
];
info response;

Sample request body

Copied{
    "tags": [
        {
            "name": "Important"
        },
        {
            "name": "Scheduled"
        }
    ]
}

Response object

The response object provides information regarding the success message or status along with the following details:

id string

The unique identification (tag ID) of the newly added tag.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

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_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.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoBigin.settings.tags.CREATE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to create tags
Resolution: The user does not have permission to create tags. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
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 create tags
Resolution: The user does not have the permission to create tags. Contact your system administrator.
DUPLICATE_DATAHTTP 200
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 200
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.
INVALID_DATAHTTP 400
Invalid Data
Resolution: One of the input keys is specified in the wrong format. Refer to Input JSON keys section above and specify valid input.

Sample response

Copied{
    "tags": [
        {
            "code": "SUCCESS",
            "details": {
                "created_time": "2023-06-22T16:31:56+05:30",
                "modified_time": "2023-06-22T16:31:56+05:30",
                "modified_by": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "id": "2034020000000630002",
                "created_by": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "color_code": null
            },
            "message": "tags created successfully",
            "status": "success"
        },
	{
            "code": "SUCCESS",
            "details": {
                "created_time": "2023-06-22T16:31:56+05:30",
                "modified_time": "2023-06-22T16:31:56+05:30",
                "modified_by": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "id": "2034020000000630003",
                "created_by": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "color_code": null
            },
            "message": "tags created successfully",
            "status": "success"
        }
    ]
}