Remove Share

With the Zoho Analytics Workspace Admin API, you can add / remove the Workspace Admins. It is recommended that you go through the documentation on Multiple Workspace Admins, before using the API for better understanding.

REQUEST URI

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

Post

oauthscope:

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	REMOVESHARE	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_FORMAT	XML/JSON	This parameter specifies the output format for the response.
ZOHO_ERROR_FORMAT	XML/JSON	Specifies the output format for the response in case an error occurs when trying to process the request.
ZOHO_API_VERSION	1.0	The 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 Name	Value	Description
Authorization	Zoho-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.

Note: It is recommended to use Zoho Analytics Login Email Address in the API URL instead of Zoho Username.

ACTION SPECIFIC PARAMETERS

Parameter	Possible Values	Default Value	Description	Remarks
ZOHO_VIEWS	Table1,View1,View2,My View		Views whose sharing need to be removed. Multiple views can be passed using comma separator. Note: ZOHO_VIEWS is encoded in URL encoding format. Value without encoding is given below: ZOHO_VIEWS=Table1,View1,View2,My View	Any one of the parameter (ZOHO_VIEWS or ZOHO_ALLVIEWS) is a mandatory Parameter.
ZOHO_ALLVIEWS	true or false	false	If true passed to this parameter it will remove the sharing for all the views which are shared to the corresponding users (users identified by the email addresses passed in the parameter ZOHO_EMAILS)	Any one of the parameter (ZOHO_VIEWS or ZOHO_ALLVIEWS) is a mandatory Parameter.
ZOHO_EMAILS (mandatory)	user1@finepick.com, user2@finepick.com		User email addresses as comma separated values to whom the sharing need to be removed for the specified views Note: ZOHO_EMAILS is encoded in URL encoding format. Value without encoding is given below: ZOHO_EMAILS=user1@finepick.com,user2@finepick.com	Mandatory Parameter
ZOHO_DOMAINNAME (Only For White Label Customers)	Domain name		It’s used to remove shared views from the whitelabel domain.	Optional

POSSIBLE ERROR CODES

7003 , 7103 , 8027 , 8509 , 8504 , 8506 , 8516 , 8533

Sample Request:

Copiedcurl 
-d "ZOHO_ACTION=REMOVESHARE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_EMAILS=user1@zoho.com&ZOHO_ALLVIEWS=true" 
-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 removeshare(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME);
            string emails = "user1@zoho.com";
            Dictionary<string, string> dic = new Dictionary<string, string>();
            dic.Add("ZOHO_VIEWS", "Employee");
            rc.RemoveShare(uri, emails, dic);
        }

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

Copiedpackage main

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

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

func removeshare() {
	url := reportclient.GetDbUri(email, dbname)
	emailids := "user1@zoho.com"
	params := map[string]string{}
	params["ZOHO_ALLVIEWS"] = "true"
	err := reportclient.RemoveShare(url, emailids, params)
	if err != nil {
		fmt.Println(err.ErrorMessage)
		fmt.Println(err.ErrorCode)
		fmt.Println(err.Action)
		fmt.Println(err.HttpStatusCode)
	} else {
		fmt.Println("Success")
	}
}

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

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

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

    public void removeshare() throws Exception {
        String uri = rc.getURI(email, dbname);
        config.put("ZOHO_ALLVIEWS", true);
        rc.removeShare(uri, emails, config);
    }

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

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$DB_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, $DB_NAME);
$emails = "Email Address";
$permissions = array('ZOHO_ALLVIEWS' => "true");
$report_client_request->removeShare($uri, $emails, $permissions);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

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

    def removeshare(self, rc):
        uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
        params = {"ZOHO_ALLVIEWS": "true"}
        rc.removeShare(uri, "Email Address", params)

obj = Sample()
obj.removeshare(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 params = {};
    params['ZOHO_VIEWS'] = '';
    var uripath = nodelib.getUri(emailId, workspaceName);
    var emailIds = '';
    nodelib.removeShare(emailIds, uripath, params).then((response) => {
        console.log(response);
    }).catch((error) => {
        console.log('Error : ' + error.message);
    });
}).catch((error) => {
    console.log('Authentication Error : ' + 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;
}

// COMMON PARAMS
paramsMap.put("ZOHO_ACTION", "REMOVESHARE");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");

// ACTION SPECIFIC PARAMS
paramsMap.put("ZOHO_VIEWS", "");
paramsMap.put("ZOHO_EMAILS", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;

Show full

Show less

Sample Response:

XML Json

Copied<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName"action="REMOVESHARE">
    <result>success</result>
</response>

Copied{"response":
    {"uri": "/api/EmailAddress/WorkspaceName",
        "action": "REMOVESHARE",
        "result": "success"}}

Products

Platform

By Function

By Industry

By Business Size

By Usecase

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo