Create Tags
Purpose
To create tags.
Request Details
Request URL
https://www.zohoapis.com/bigin/v1/settings/tags?module={module_api_name}
Supported modules
Accounts, Contacts, Deals, Tasks, Events, Calls, Products, Notes, and Activities
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoBigin.settings.ALL
(or)
scope=ZohoBigin.settings.tags.{operation_type}
Possible operation types
ALL - Full data access
WRITE - Edit tag data
CREATE - Create tag data
Sample Request
Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/tags?module=Contacts"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@createnewtag.json"
CopiedString moduleAPIName = "Leads";
//Get instance of TagsOperations Class
TagsOperations tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper request = new BodyWrapper();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(CreateTagsParam.MODULE, moduleAPIName);
//List of Tag instances
List <com.zoho.crm.api.tags.Tag> tagList = new ArrayList < com.zoho.crm.api.tags.Tag > ();
//Get instance of Tag Class
com.zoho.crm.api.tags.Tag tag1 = new com.zoho.crm.api.tags.Tag();
tag1.setName("tagName");
tagList.add(tag1);
request.setTags(tagList);
//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
APIResponse < ActionHandler > response = tagsOperations.createTags(request, paramInstance);
Copiedpackage com.zoho.crm.api.sample.restapi.tag;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class CreateNewTags
{
@SuppressWarnings("deprecation")
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/settings/tags");
uriBuilder.addParameter("module", "Leads");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONArray recordArray = new JSONArray();
JSONObject recordObject = new JSONObject();
recordObject.put("name", "Chems");
recordArray.put(recordObject);
recordObject = new JSONObject();
recordObject.put("name", "Agricultural");
recordArray.put(recordObject);
requestBody.put("tags", recordArray);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of TagsOperations Class
$tagsOperations = new TagsOperations();
//Get instance of BodyWrapper Class that will contain the request body
$request = new BodyWrapper();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(CreateTagsParam::module(), $moduleAPIName);
//List of Tag instances
$tagList = array();
$tagClass = 'com\zoho\crm\api\tags\Tag';
//Get instance of Tag Class
$tag1 = new $tagClass();
$tag1->setName("tagName");
array_push($tagList, $tag1);
$request->setTags($tagList);
//Call createTags method that takes BodyWrapper instance and paramInstance as parameter
$response = $tagsOperations->createTags($request, $paramInstance);
Copied<?php
class CreateTags
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/settings/tags?";
$parameters = array();
$parameters["module"]="Leads";
foreach ($parameters as $key=>$value){
$url =$url.$key."=".$value."&";
}
$curl_options[CURLOPT_URL] =$url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "POST";
$requestBody = array();
$tagArray = array();
$tagObject = array();
$tagObject["name"]="Chems";
$tagArray[] = $tagObject;
$requestBody["tags"] =$tagArray;
$curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new CreateTags())->execute();
Copieddef create_tags(self):
try:
record = ZCRMModule.get_instance("Leads")
tag1 = ZCRMTag.get_instance()
tag1.name = "Sample3"
tag2 = ZCRMTag.get_instance()
tag2.name = "Sample4"
tags = []
tags.append(tag1)
tags.append(tag2)
response = record.create_tags(tags)
print(response.status_code)
print(response.response_json)
except ZCRMModule as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMModule moduleIns = ZCRMModule.GetInstance("Leads"); //module api name
List<ZCRMTag> tags = new List<ZCRMTag>();
ZCRMTag tag1 = ZCRMTag.GetInstance();
tag1.Name = "Name1";
ZCRMTag tag2 = ZCRMTag.GetInstance();
tag2.Name = "Name2";
tags.Add(tag1);
tags.Add(tag2);
BulkAPIResponse<ZCRMTag> response = moduleIns.CreateTags(tags); //tags - list of ZCRMTag instances filled with required data for create.
List<ZCRMTag> insertedTags = response.BulkData; //insertedTags - list of ZCRMTag instances
List<EntityResponse> entityResponses = response.BulkEntitiesResponse; //entityResponses - list of EntityResponse instance
Copiedtag1 = Map();
tag1.put("name", "Chems");
tag2 = Map();
tag2.put("name", "Agriculture");
tags_list = List();
tags_list.add(tag1);
tags_list.add(tag2);
param = Map();
param.put("tags", tags_list);
res = invokeurl
[
url :"https://www.zohoapis.com/crm/v2/settings/tags?module=Leads"
type :POST
parameters: param.toString()
connection:"crm_oauth_connection"
];
info res;
In the input, @createnewtag.json contains the sample input data.
Parameters
- modulestring, mandatory
Specify the API name of the module such as Accounts, Deals, etc,.
Input JSON Keys
- namestring, mandatory
Specify the name of the tag that you want to create.
Sample Input
Copied{
"tags": [
{
"name": "Chems"
},
{
"name": "Agricultural"
}
]
}
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_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",
"message": "tags created successfully",
"status": "success",
"details": {
"created_by": {
"id": "2000000030444",
"name": "Chems"
},
"created_time": "2017-03-24T11:08:23+05:30",
"id": "2000000088041",
"modified_by": {
"id": "2000000030444",
"name": "Pharmaceutical"
},
"modified_time": "2017-03-24T11:08:23+05:30"
}
},
{
"code": "SUCCESS",
"message": "tags created successfully",
"status": "success",
"details": {
"created_by": {
"id": "2000000030564",
"name": "Agricultural"
},
"created_time": "2017-03-24T11:08:23+06:30",
"id": "2000000088041",
"modified_by": {
"id": "2000000030564",
"name": "Leather"
},
"modified_time": "2017-03-24T11:08:23+06:30"
}
}
]
}