Zoho: User Licenses Feature

Zoho features.getUserLicenseFeatureDetails: arguments, response, policy and SDK examples.

Operation zoho.getuserlicensefeaturedetails

Provider route: GET /crm/v8/__features/user_licenses. 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["features"]["getUserLicenseFeatureDetails"]>[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.features.getUserLicenseFeatureDetails(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.features.get_user_license_feature_details(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed

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
`$ (anyOf 1)`	object	Alternative	User licenses feature details for the current edition Additional keys: allowed
`$ (anyOf 1).__features`	array	Required within parent	User licenses feature details for the current edition Maximum items: 1
`$ (anyOf 1).__features[]`	object	Each item	User licenses feature details Additional keys: allowed
`$ (anyOf 1).__features[].api_name`	string	Required within parent	API name of the feature Maximum length: 255
`$ (anyOf 1).__features[].components`	null	Required within parent	Components of the feature
`$ (anyOf 1).__features[].details`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 1)`	object	Alternative	This object will have limits and usage details
`$ (anyOf 1).__features[].details (anyOf 1).available_count`	object	Optional	Available count details for the feature Additional keys: not allowed
`$ (anyOf 1).__features[].details (anyOf 1).available_count.total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 1).available_count.total (anyOf 1)`	integer	Alternative	Total available count Format: int32
`$ (anyOf 1).__features[].details (anyOf 1).available_count.total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 1).limits`	object	Required within parent	Limit details for the feature Additional keys: not allowed
`$ (anyOf 1).__features[].details (anyOf 1).limits.total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 1).limits.total (anyOf 1)`	integer	Alternative	Total limit Format: int32
`$ (anyOf 1).__features[].details (anyOf 1).limits.total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 1).used_count`	JSON	Optional	used count of the feature
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1)`	object	Alternative	used count of the feature Additional keys: allowed
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total (anyOf 1)`	integer	Alternative	total count Format: int32
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 1).total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2)`	JSON	Alternative
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2) (anyOf 1)`	integer	Alternative	used count of the feature Format: int32
`$ (anyOf 1).__features[].details (anyOf 1).used_count (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 2)`	null	Alternative	This object will have limits and usage details
`$ (anyOf 1).__features[].details (anyOf 2).available_count`	object	Optional	Available count details for the feature Additional keys: not allowed
`$ (anyOf 1).__features[].details (anyOf 2).available_count.total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 2).available_count.total (anyOf 1)`	integer	Alternative	Total available count Format: int32
`$ (anyOf 1).__features[].details (anyOf 2).available_count.total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 2).limits`	object	Required within parent	Limit details for the feature Additional keys: not allowed
`$ (anyOf 1).__features[].details (anyOf 2).limits.total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 2).limits.total (anyOf 1)`	integer	Alternative	Total limit Format: int32
`$ (anyOf 1).__features[].details (anyOf 2).limits.total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 2).used_count`	JSON	Optional	used count of the feature
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1)`	object	Alternative	used count of the feature Additional keys: allowed
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total`	JSON	Required within parent
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total (anyOf 1)`	integer	Alternative	total count Format: int32
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 1).total (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2)`	JSON	Alternative
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2) (anyOf 1)`	integer	Alternative	used count of the feature Format: int32
`$ (anyOf 1).__features[].details (anyOf 2).used_count (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).__features[].feature_label`	string	Required within parent	Label of the feature Maximum length: 255
`$ (anyOf 1).__features[].module_supported`	boolean	Required within parent	Module wise feature supported or not
`$ (anyOf 1).__features[].parent_feature`	JSON	Required within parent
`$ (anyOf 1).__features[].parent_feature (anyOf 1)`	object	Alternative	Parent feature details
`$ (anyOf 1).__features[].parent_feature (anyOf 2)`	null	Alternative	Parent feature details
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

No-content response statuses: [204]

Official provider source

Report an issue with this page