Add Tags

Purpose

To add tags to a specific record.

Request URL

https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}/actions/add_tags?tag_names={tag_name}

To add tags to multiple records

https://recruit.zoho.com/recruit/v2/{module_api_name}/actions/add_tags?tag_names={tag_name1},{tag_name2}&ids={record_id1},{record_id2}

module_api_name - The API name of the module
record_id - The unique Id of the record
tag_name - The name of the tag

Request Method

POST

Scope

scope=ZohoRECRUIT.settings.all
(or)
scope=ZohoRECRUIT.settings.tags.{operation_type}

Possible module names	Possible operation types
candidate, jobopening, submission, offers, interview, client, contact, department, vendors, application and custommodule.	ALL - Full data access WRITE - Edit tag data CREATE - Create tag data

Parameters

Parameter Name	Data Type	Description
module (mandatory)	String	Specify the API name of the module such as Candidates, Contacts, Job Openings, Interviews, etc.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates/486812000001660091/actions/add_tags?tag_names=New" -
    X POST -
    H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    --data - raw '{
"data": [{
    "name": "Campaign",
    "color_code": "#969696"
}]
}

Sample Response

Copied{
    "data": [{
        "code": "SUCCESS",
        "details": {
            "id": 486812000001660091,
            "tags": [
                "Campaign"
            ]
        },
        "message": "tags updated successfully",
        "status": "success"
    }]
}