Zoho: Get from addresses

← From addresses operations · Get started

Operation zoho.getfromaddresses

Provider route: GET /crm/v8/settings/emails/actions/from_addresses. 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["fromAddresses"]["getFromAddresses"]>[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.fromAddresses.getFromAddresses(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.from_addresses.get_from_addresses(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
$	object	Root	Represents the successful response body, containing the list of configured from-address entries. Additional keys: not allowed
from_addresses	array	Required within parent	Represents the list of from-address entries configured for the user. Maximum items: 200
from_addresses[]	object	Each item	Represents a single from-address entry, including the email address, type, display name, unique identifier, and default status. Additional keys: not allowed
from_addresses[].default	boolean	Optional	Indicates whether this is the user’s default from address. Possible values: true - This is the default sender address. false - This is not the default sender address.
from_addresses[].email	string	Required within parent	Represents the email address of the from-address entry. Maximum length: 254 Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}
from_addresses[].id	JSON	Optional
from_addresses[].id (anyOf 1)	string	Alternative	Represents the unique identifier of the from-address entry. Format: int64
from_addresses[].id (anyOf 2)	null	Alternative	Represents the unique identifier of the from-address entry. Format: int64
from_addresses[].type	string	Required within parent	Represents the type of the from-address entry. Maximum length: 32
from_addresses[].user_name	string	Required within parent	Represents the display name of the user associated with the from-address entry. Maximum length: 256

Policy, approvals and errors

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