Update Tag

Updates the `name` and / or `colorCode` of an existing tag. At least one of the two attributes must be supplied.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/tags/<tag-id>

Put

oauthscope: ZohoAnalytics.modeling.update

QUERY PARAMETERS

 

Parameter Name		Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
nameString

New display name of the tag.

No (at least one of the two). 1 – 100 characters. Must be unique within the workspace.
colorCodeString

New color for the tag.

6-digit hex color (e.g. #FF0000) 

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDelugeRuby
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/tags/<tag-id> --data-urlencode 'CONFIG={"name":"Critical Priority","colorCode":"#CC0000"}'
-X 'PUT'
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 10000000000000;
        long viewId = 20000000000000;

        public void UpdateTag(IAnalyticsClient ac)
        {
            long tagId = 30000000000000L;
            Dictionary<string, object> config = new Dictionary<string, object>
            {
                { "name", "Critical Priority" },
                { "colorCode", "#CC0000" }
            };
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            workspace.UpdateTag(tagId, config);
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.UpdateTag(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}
Copiedpackage main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var (
    clientId     = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId       = "55522777"
    workspaceId = "10000000000000"
    viewId      = "20000000000000"
)


func UpdateTag(ac ZAnalytics.Client) {
    tagId := "30000000000000"
    config := map[string]interface{}{
        "name":      "Critical Priority",
        "colorCode": "#CC0000",
    }
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    exception := workspace.UpdateTag(tagId, config)
    if exception != nil {
        fmt.Println("Error:", exception)
        return
    }
    fmt.Println("success")
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    UpdateTag(ac)
}
Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 10000000000000l;
    private long viewId = 20000000000000l;

    public static void main(String args[]) {

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.updateTag(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : " + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : " + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void updateTag(AnalyticsClient ac) throws Exception {
        long tagId = 30000000000000l;
        JSONObject config = new JSONObject();
        config.put("name", "Critical Priority");
        config.put("colorCode", "#CC0000");
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        workspace.updateTag(tagId, config);
        System.out.println("success");
    }

}
Copied<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "10000000000000";
        public $view_id = "20000000000000";

        function __construct() {
            $this->ac = new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function updateTag() {
            $tag_id = "30000000000000";
            $config = array(
                "name" => "Critical Priority",
                "colorCode" => "#CC0000"
            );
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $workspace->updateTag($tag_id, $config);
            echo "success\n";
        }

    }

    $test_obj = new Test();

    try {
        $test_obj->updateTag();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>
Copiedfrom __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx"
    CLIENTSECRET = "xxxxxxx"
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx"

    ORGID = "55522777"
    WORKSPACEID = "10000000000000"
    VIEWID = "20000000000000"

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def update_tag(self, ac):
        tag_id = "30000000000000"
        config = {"name": "Critical Priority", "colorCode": "#CC0000"}
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        workspace.update_tag(tag_id, config)
        print("success")

try:
    obj = sample()
    obj.update_tag(obj.ac)

except Exception as e:
    print(str(e))
Copiedvar analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '10000000000000';
var viewId = '20000000000000';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var tagId = '30000000000000';
var config = {
    "name": "Critical Priority",
    "colorCode": "#CC0000"
};
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.updateTag(tagId, config).then(() => {
    console.log('success');
}).catch((error) => {
    console.log('errorCode : ' + error.errorCode);
    console.log('errorMessage : ' + error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "10000000000000";
tagId = "30000000000000";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID", orgId);

config = Map();
config.put("name", "Critical Priority");
config.put("colorCode", "#CC0000");

paramsMap = Map();
paramsMap.put("CONFIG", config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/tags/" + tagId
  type :PUT
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;
Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "10000000000000"
  VIEWID = "20000000000000"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId" => "1000.xxxxxxx",
             "clientSecret" => "xxxxxxx",
             "refreshToken" => "1000.xxxxxxx.xxxxxxx"
           })
           #.with_token_store_path("/home/admin/analytics_ruby_sdk/tokens") # Optional – specify a directory path to securely store the encrypted access token
           .build
  end

  def update_tag
    tag_id = "30000000000000"
    config = { "name" => "Critical Priority", "colorCode" => "#CC0000" }
    workspace = @ac.get_workspace_instance(Config::ORGID, Config::WORKSPACEID)
    workspace.update_tag(tag_id, config)
    puts "success"
  end

end

begin
  obj = Sample.new
  obj.update_tag
rescue ServerError => e
  puts "Server Error: #{e.response_content}"
rescue StandardError => e
  puts e.message
  puts e.backtrace.join("\n")
end

Download SDKs:  C# | GO | JAVA | PHP | PYTHON | NodeJS | Ruby

Sample value for CONFIG parameter:

Copied{
  "name":      "Critical Priority",
  "colorCode": "#CC0000"
}

Sample Response:

CopiedHTTP/1.1 204 No Content