Skip to main content

Add Tags

Description

To add or associate tags to the supported modules. 

Supported modules: conversations, visitors, contacts, companies

Requested Payload:

  • ids (Mandatory): The IDs of the tags to be added or associated. 

OAuth Scope:

  • ​SalesIQ.conversations.UPDATE
  • ​SalesIQ.visitors.UPDATE
  • ​SalesIQ.companies.UPDATE

Method: 

PUT

Note: Archived tags cannot be associated or added to any module. 

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/{module_name}/{module_record_id}/tags

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/conversations/54000000007003/tags

Payload

Copied{
    "ids" : ["7000000004001","7000000000080"]
}

Success Response

Copied{
    "url": "/api/v2/zylker/conversations/54000000007003/tags",
    "object": "tag_ids_list",
    "data":{
        "failed_tag_ids":[
        "7000000004001"
        ],
        "associated_tags":[
            {
                "color": "#fF7609",
                "module": "conversations",
                "name": "Canada",
                "id": "7000000000080",
                "archived" : false,
                "status" : "unarchived",
                "modified_time": "1633353825877",
                "modifier":{
                    "name": "james",
                    "modified_time": "1633353825877",
                    "id": "11000000002001"
                }
            },
            {
                "color": "#fF7610",
                "module": "conversations",
                "name": "France",
                "id": "7000000000082",
                "archived" : false,
                "status" : "unarchived",
                "modified_time": "1633353825877",
                "modifier":{
                    "name": "james",
                    "modified_time": "1633353825877",
                    "id": "11000000002001"
                }
            }
        ]
    }
}