Add Users

Add users to the specified organization.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/users

Post

oauthscope: ZohoAnalytics.usermanagement.create

QUERY PARAMETERS

Parameter Name	Description
CONFIG^*	*JSONObject* Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

Key	Description
emailIds^*	*JSONArray* The email address of the users to be added. `Sample: ["emailId1", "emailId2"]`
role	*String* To specify the role for the new users. Supported roles: USER VIEWER ORGADMIN `Default Value`: USER
domainName	*String* Name of the domain. To add users to the specified domain.

POSSIBLE ERROR CODES

7301, 8060, 8078, 8079, 8083, 8504, 8509, 8518, 8535

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl https://analyticsapi.zoho.com/restapi/v2/users?CONFIG=<encoded_json_value> 
-X 'POST' 
-H 'ZANALYTICS-ORGID: <org-id>' 
-H 'Authorization: Zoho-oauthtoken <access_token>'

Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;

        public void AddUsers(IAnalyticsClient ac)
        {
            IOrgAPI org = ac.GetOrgInstance(orgId);
            List<string> emailIds = new List<string>();
            emailIds.Add("user+1@zoho.com");
            org.AddUsers(emailIds, null);
            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.AddUsers(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"
)

func AddUsers(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    emailids := [1]string{}
    emailids[0] = "user+1@zoho.com"
    org := ZAnalytics.GetOrgInstance(&ac, orgId)
    exception := org.AddUsers(emailids, config)

    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    AddUsers(ac)

}

Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;

    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.addUsers(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 addUsers(AnalyticsClient ac) throws Exception {
        OrgAPI org = ac.getOrgInstance(orgId);
        JSONArray emailIds = new JSONArray();
        emailIds.put("user+101@zoho.com");
        org.addUsers(emailIds, null);
        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";

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

        function addUsers() {
            $email_ids = array("user+2@zoho.com");
            $org = $this->ac->getOrgInstance($this->org_id);
            $org->addUsers($email_ids, NULL);
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->addUsers();
    }
    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";

class sample:

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

    def add_users(self, ac):
        email_ids = []
        email_ids.append("user+1@zoho.com")
        org = ac.get_org_instance(Config.ORGID)
        org.add_users(email_ids)
        print("success")

try:
    obj = sample()
    obj.add_users(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 ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var config = {};
var emailIds = [];
emailIds.push('');
emailIds.push('');
var org = ac.getOrgInstance(orgId);
org.addUsers(emailIds, config).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

CopiedorgId = "55522777";

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

emailIds = {};
emailIds.add("user+1@zoho.com");
emailIds.add("user+2@zoho.com");
config = Map();
config.put("emailIds",emailIds);
paramsMap = Map();
paramsMap.put("CONFIG",config.toString());
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/users"
  type :POST
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Sample value for CONFIG parameter:

Copied{
  "emailIds": ["<email-id1>", "<email-id2>"]
}

Sample Response:

CopiedHTTP/1.1 204 No Content