Zoho: Territory Users — territory Users associate Users To Territory

← Territory users operations · Get started

Operation zoho.associateuserstoterritory

Provider route: PUT /crm/v8/settings/territories/{territory}/users. 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"]["associateUsersToTerritory"]>[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.associateUsersToTerritory(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_users_to_territory(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.territory	string	Required within parent	Specify the unique ID of the territory for which you want to add users. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID. Maximum length: 100
body	object	Required within parent	Represents the request body for associating users with a territory. Additional keys: not allowed
body.users	array	Required within parent	Specify the list of users to associate with the territory. Maximum items: 100
body.users[]	object	Each item	Represents a user to associate with the territory. Additional keys: not allowed
body.users[].id	string	Required within parent	Specify the unique ID of the user to associate with the territory. Maximum length: 100

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
$	object	Root	Represents the success response body returned after associating users with the territory. Additional keys: not allowed
users	array	Required within parent	Represents the list of user-territory association results. Maximum items: 100
users[]	object	Each item	Represents the result of a user-territory association operation. Additional keys: not allowed
users[].code	string	Required within parent	Represents the status code of the association operation for the user. Known values: SUCCESS
users[].details	object	Required within parent	Represents additional details about the association operation. Additional keys: not allowed
users[].details.id	string	Required within parent	Represents the unique ID of the user. Maximum length: 100
users[].message	string	Required within parent	Represents the status message of the association operation. Maximum length: 250
users[].status	string	Required within parent	Represents the status of the association operation for the user. Known values: success

Policy, approvals and errors

SDK function policy ID: zoho.associateuserstoterritory. Catalog operation: associateUsersToTerritory. 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