Zoho: Territory User — territory Users associate User To Specific Territory

← Territory users operations · Get started

Operation zoho.associateusertospecificterritory

Provider route: PUT /crm/v8/settings/territories/{territory}/users/{user}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["territoryUsers"]["associateUserToSpecificTerritory"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.territoryUsers.associateUserToSpecificTerritory(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.territory_users.associate_user_to_specific_territory(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	Model	Required within parent	Expand Specific Territory User — request body — path

Referenced models: Specific Territory User — request body — path

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the success response body returned after associating the user with the territory.
$ (anyOf 1)	object	Alternative	Represents the response body containing the list of user-territory association results. Additional keys: not allowed
$ (anyOf 1).users	array	Required within parent	Represents the list of user-territory association results. Maximum items: 100
$ (anyOf 1).users[]	JSON	Each item	Represents a user entry in the territory user list.
$ (anyOf 1).users[] (anyOf 1)	array	Alternative	Represents an array of error details associated with the user entry. Maximum items: 100
$ (anyOf 1).users[] (anyOf 1)[]	object	Each item	Represents an error detail for an invalid user ID in the request. Additional keys: not allowed
$ (anyOf 1).users[] (anyOf 1)[].code	string	Required within parent	Represents the status code of the association operation for the user. Known values: SUCCESS
$ (anyOf 1).users[] (anyOf 1)[].details	object	Required within parent	Represents additional details about the association operation. Additional keys: not allowed
$ (anyOf 1).users[] (anyOf 1)[].details.id	string	Required within parent	Represents the unique ID of the user. Maximum length: 100
$ (anyOf 1).users[] (anyOf 1)[].message	string	Required within parent	Represents the status message of the association operation. Maximum length: 250
$ (anyOf 1).users[] (anyOf 1)[].status	string	Required within parent	Represents the status of the association operation for the user. Known values: success

Schemas

Specific Territory User — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
territory	string	Required within parent	Territory Id Param in URL. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID. Maximum length: 100
user	string	Required within parent	Represents the unique ID of the user as a string, with a maximum length of 100 characters. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve the user ID. Maximum length: 100

Policy, approvals and errors

SDK function policy ID: zoho.associateusertospecificterritory. Catalog operation: associateUserToSpecificTerritory. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source