Create Group

This API creates a new group in the workspace identified by the URI.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>

Post

oauthscope: ZohoAnalytics.share.create

COMMON PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONCREATEGROUP

This parameter specifies the action to be performed by the API request.

Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.

ZOHO_OUTPUT_FORMATJSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
ZOHO_API_VERSION1.0The API version of Zoho Analytics based on which the application(/service) has been written. This parameter allows the Zoho Analytics to handle applications based on the older versions.The current API version is 1.0

AUTHORIZATION

To make authenticated API request, append the access token in Authorization request header.

Header NameValueDescription
AuthorizationZoho-oauthtoken<space><access_token>The Access token provides a secure and temporary access to Zoho Analytics API's. Each access token will be valid only for an hour, and can be used only for the set of operations that is described in the scope.

ACTION SPECIFIC PARAMETERS

KeyTypeDescription
groupName*StringName of the group to be created.
groupDescStringDescription of the group.
emailIds*JSONArrayList of user email addresses to be added in the group.
inviteMailBooleanIf set as true, invitation mail will be sent to the specified email addresses.
mailSubjectStringSubject of the invitation mail.
mailMessageStringInvitation mail messasge.
domainName
(Only For White Label Customers)		StringCreated group will be mapped for the specified domain.
Note: Fields with * are mandatory.

POSSIBLE ERROR CODES

7003 , 7103 , 8027 , 8509 , 8504 , 8506 , 8516 , 8533 , 7282 , 6028 , 8060

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDeluge
Copiedcurl 
-d 'ZOHO_ACTION=CREATEGROUP&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0' 

--data-urlencode 'CONFIG={"groupName":"","groupDesc":"","emailIds":["","","inviteMail":"","mailSubject":"","mailMessage":""}' 

-X POST 
-H 'Authorization:Zoho-oauthtoken <access_token>' 
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName
Copiedusing ZReports;

namespace Test
{
    CLIENT_ID = "************";
    CLIENT_SECRET = "************";
    REFRESH_TOKEN = "************";
    EMAIL = "Email Address";
    DBNAME = "Workspace Name";

    class Program
    {
        public IReportClient getClient()
        {
            IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
            return RepClient;
        }

        public void createGroup(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME);
            Dictionary<string, object> config = new Dictionary<string, object>();
            config.Add("groupName", "");
            config.Add("groupDesc", "");
            List<string> emailIds = new List<string>();
            emailIds.Add("");
            emailIds.Add("");
            config.Add("emailIds", emailIds);
            config.Add("inviteMail", "");
            config.Add("mailSubject", "");
            config.Add("mailMessage", "");
            config.Add("domainName", "");  // Only for client portal admin
            string result = rc.CreateGroup(uri, config);
            Console.WriteLine(result);
        }

        static void Main(string[] args)
        {
            Program obj = new Program();
            IReportClient rc = obj.getClient();
            obj.createGroup(rc);
        }
    }
}

Copiedpackage main

import (
	"fmt"
	"zoho/pkg/reportclient"
	"encoding/json"
)

var (
	email        = "Email Address"
	dbname       = "Workspace Name"
	clientid     = "************"
	clientsecret = "************"
	refreshtoken = "************"
)

func creategroup() {
	type groupconfig struct {
		GROUPNAME     string `json:"groupName"`
		GROUPDESC     string `json:"groupDesc"`
		EMAILIDS      []string `json:"emailIds"`
		INVITEMAIL    bool `json:"inviteMail"`
		DOMAINNAME    string `json:"domainName"`
		MAILSUBJECT   string `json:"mailSubject"`
		MAILMESSAGE   string `json:"mailMessage"`
	}

	config := groupconfig{
		GROUPNAME:   "",
		GROUPDESC:   "",
		EMAILIDS:    []string{"", ""},
		INVITEMAIL:  true,
		MAILSUBJECT: "",
		MAILMESSAGE: "",
	}

	url := reportclient.GetDbUri(email, dbname)
	conf, _ := json.Marshal(config)
	result, err := reportclient.CreateGroup(url, string(conf))
	if err != nil {
		fmt.Println(err.ErrorMessage)
		fmt.Println(err.ErrorCode)
		fmt.Println(err.Action)
		fmt.Println(err.HttpStatusCode)
	} else {
		fmt.Println(result)
	}
}

func main() {
	reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
	creategroup()
}

Copiedimport com.adventnet.zoho.client.report.*;

public class Sample {
    String email = "Email Address";
    String dbname = "Workspace Name";
    String clientId = "************";
    String clientSecret = "************";
    String refreshToken = "************";
    Map config = new HashMap();
    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void createGroup() throws Exception {
        String uri = rc.getURI(email, dbname);
        JSONObject groupInfo = new JSONObject();
        groupInfo.put("groupName", "");
        groupInfo.put("groupDesc", "");
        JSONArray emailIds = new JSONArray();
        emailIds.put("");
        emailIds.put("");
        groupInfo.put("emailIds", emailIds);
        groupInfo.put("inviteMail", "");
        groupInfo.put("mailSubject", "");
        groupInfo.put("mailMessage", "");
        String result = rc.createGroup(uri, groupInfo);
        System.out.println(result);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.createGroup();
    }
}

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$WORKSPACE_NAME = "Workspace Name";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";

$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getDbURI($EMAIL_ID, $WORKSPACE_NAME);
$groupInfo = new stdClass();
$groupInfo->groupName = "";
$groupInfo->groupDesc = "";
$groupInfo->emailIds = array();
$groupInfo->inviteMail = true;
$groupInfo->mailSubject = "";
$groupInfo->mailMessage = "";
$result = $report_client_request->createGroup($uri, $groupInfo);
print_r($result);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGIN_EMAIL_ID = "Email Address"
    DATABASE_NAME = "Workspace Name"
    CLIENT_ID = "************"
    CLIENT_SECRET = "************"
    REFRESH_TOKEN = "************"
    rc = None

    def createGroup(self, rc):
        uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
        try:
            groupInfo = {}
            groupInfo['groupName'] = ''
            groupInfo['groupDesc'] = ''
            groupInfo['emailIds'] = ['', '']
            groupInfo['inviteMail'] = ''
            groupInfo['mailSubject'] = ''
            groupInfo['mailMessage'] = ''
            result = rc.createGroup(uri, groupInfo)
            print(result)
        except Exception, e:
            print str(e)

obj = Sample()
obj.createGroup(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';

nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var uripath = nodelib.getUri(emailId, workspaceName);
    var config = {};
    config.groupName = "";
    config.groupDesc = "";
    config.emailIds = ["", ""];
    config.inviteMail = "";
    config.mailSubject = "";
    config.mailMessage = "";
    nodelib.createGroup(uripath, config).then((response) => {
        console.log(response);
    }).catch((error) => {
        console.log("Error : " + error.message);
    });
}).catch((error) => {
    console.log("Authentication Issue : " + error);
});

Copiedemail = zoho.encryption.urlEncode("");
workspaceName = zoho.encryption.urlEncode("");
paramsMap = Map();
oauthParams = Map();
headers = Map();

// AUTHENTICATION PARAMS
oauthParams.put("client_id", "********");
oauthParams.put("client_secret", "********");
oauthParams.put("refresh_token", "********");
oauthParams.put("grant_type", "refresh_token");
tokenInfo = invokeurl[url: "https://accounts.zoho.com/oauth/v2/token" type: POST parameters: oauthParams];
if (tokenInfo.containKey("access_token")) {
    accessToken = tokenInfo.get("access_token");
    headers.put("Authorization", "Zoho-oauthtoken ".concat(accessToken));
} else {
    info tokenInfo;
    return;
}

config = Map();
emailIds = List();
emailIds.add("");
emailIds.add("");
config.put("groupName", "");
config.put("groupDesc", "");
config.put("emailIds", emailIds);
config.put("inviteMail", "");
config.put("mailSubject", "");
config.put("mailMessage", "");

// COMMON PARAMS
paramsMap.put("ZOHO_ACTION", "CREATEGROUP");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
paramsMap.put("CONFIG", config.toString());

response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName type: POST parameters: paramsMap headers: headers];
info response;

Download SDK : C# | GO | JAVA | PHP | PYTHON | NodeJS

Sample Response:

Copied{"response": {"uri": "/api/EmailAddress/WorkspaceName",
    "action": "CREATEGROUP",
    "result": {"message": "Group created successfully.",
      "groupId": "11111111111111111"}}}