Territories API
Territory management helps you segregate your organization's records based on customer attributes such as geography, company size, or industry. This makes it easy to share the relevant records with the right members of your sales team. Territory management allows you to automatically associate Accounts, Contacts, and Deals with territories to maximize revenue.
Users with Administrator profile can enable this feature in set up.
Key Benefits
- Avoid complex data-sharing structure - Organizations with complex sales structures can use territories to easily share records with users in different teams. It is also convenient to group records based on the account's characteristics rather than the individual ownership of the records. 
- Provide a focused work environment - Distribution of customer accounts by using territories help in creating focused work environments that ensures better sales force engagement. It also increases the sales teams' efficiency by reducing the travel time and increasing the industry expertise. 
- Get an accurate evaluation of the sales team's performance - Generate sales reports based on territories to evaluate and measure the efficiency of sales teams by territory. Also, get a better insight into the sales contribution of each territory. 
- Forecast sales for each territory and set clear goals - Create separate forecast targets for each territory a user belongs to. This will give a clear picture of the goals set for the different territories for users to stay focused. 
Territories API
Purpose
To get the list of territories enabled for your organization.
Endpoints
Request Details
Request URL
{api-domain}/crm/v2/settings/territories
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.territories.{operation_type}
Possible operation types
ALL - Full access to territories data
READ - Read territories data
To fetch records from a territory-supported module, use the parameters "territory_id" and "include_child" in the request. Refer to Get List of Records for more details.
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/settings/territories"
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GETCopied//Get instance of TerritoriesOperations Class
let territoriesOperations = new ZCRM.Territory.Operations();
//Call getTerritories method
let response = await territoriesOperations.getTerritories();Copiedvar listener = 0;
class TerritoriesAPI {
	async getTerritories() {
		var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/territories"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new TerritoriesAPI().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "GET"
        var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new TerritoriesAPI().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}
    async getToken(token) {
        if(listener == 0) {
            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){
                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }
        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://zylkercorp.zohoplatform.com/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }
            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }
    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}Copiedresponse = invokeurl
[
	url: "https://zylkercorp.zohoplatform.com/crm/v2/settings/territories"
	type: GET
	connection:"crm_oauth_connection"
];
info response;Response JSON Keys
- created_timestringRepresents the date and time at which the current territory was created. 
- modified_timestringRepresents the date and time at which the current territory was last modified. 
- managerJSON objectRepresents the name and ID of the current territory's manager. 
- parent_idstringRepresents the unique ID of the parent territory, if any. 
- criteriaJSON objectRepresents the territory criteria details. 
- namestringRepresents the name of the territory. 
- modified_byJSON objectRepresents the name and ID of the user who last modified the current territory. 
- descriptionstringRepresents the description of the territory, if any. 
- idstringRepresents the unique ID of the territory. 
- created_byJSON objectRepresents the name and ID of the user who created the current territory. 
Possible Errors
- INVALID_URL_PATTERNHTTP 404Please 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 401Unauthorized 
 Resolution: Client does not have ZohoCRM.settings.territories.READ scope. Create a new client with valid scope. Refer to scope section above.
- NO_PERMISSIONHTTP 403Permission denied to read 
 Resolution: The user does not have permission to read territories data. Contact your system administrator.
- INTERNAL_ERRORHTTP 500Internal Server Error 
 Resolution: Unexpected and unhandled exception in Server. Contact support team.
- INVALID_REQUEST_METHODHTTP 400The 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 400User does not have sufficient privilege to read territories 
 Resolution: The user does not have the permission to retrieve territories data. Contact your system administrator.
Sample Response
Copied{
    "territories": [
        {
            "created_time": "2019-08-20T14:30:27+05:30",
            "modified_time": "2019-08-20T14:30:27+05:30",
            "manager": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "parent_id": null,
            "criteria": null,
            "name": "Zylker",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "description": "Organization Parent Territory",
            "id": "4150868000000236307",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            }
        },
        {
            "created_time": "2019-08-27T15:12:47+05:30",
            "modified_time": "2019-12-19T14:35:59+05:30",
            "manager": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "parent_id": "4150868000000236307",
            "criteria": {
                "comparator": "equal",
                "field": "Created_By",
                "value": [
                    "4150868000000225013",
                    "4150868000000252644",
                    "${CURRENTUSER}",
                    "4150868000000743001",
                    "4150868000000342001"
                ]
            },
            "name": "South Zone",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "description": null,
            "id": "4150868000000264087",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            }
        },
        {
            "created_time": "2019-10-24T11:54:12+05:30",
            "modified_time": "2019-10-24T11:54:12+05:30",
            "manager": {
                "name": "Patricia Boyle",
                "id": "4150868000000342001"
            },
            "parent_id": "4150868000000236307",
            "criteria": {
                "comparator": "starts_with",
                "field": "Account_Name",
                "value": "T"
            },
            "name": "East Zone",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "description": "This is a sample territory",
            "id": "4150868000000707008",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            }
        },
        {
            "created_time": "2020-02-20T12:52:52+05:30",
            "modified_time": "2020-02-20T12:52:52+05:30",
            "manager": {
                "name": "Patricia Boyle",
                "id": "4150868000001248015"
            },
            "parent_id": "4150868000000236307",
            "criteria": {
                "comparator": "equal",
                "field": "Owner",
                "value": [
                    "4150868000000225013"
                ]
            },
            "name": "West Zone",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            },
            "description": null,
            "id": "4150868000001390007",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4150868000000225013"
            }
        }
    ]
}