Zoho: Get Unsubscribe Link Associations

← Unsubscribe links operations · Get started

Operation zoho.getassociations

Provider route: GET /crm/v8/settings/unsubscribe_link/actions/associations. 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["unsubscribeLinks"]["getAssociations"]>[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.unsubscribeLinks.getAssociations(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.unsubscribe_links.get_associations(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)	Model	Alternative	Expand Get Unsubscribe Link Associations — response body — associations
$ (anyOf 2)	null	Alternative

Referenced models: Get Unsubscribe Link Associations — response body — associations

Schemas

Get Unsubscribe Link Associations — response body — associations

Field	Type	Presence	Description and constraints
$	object	Root	Response containing the list of places where unsubscribe links are currently associated in the Zoho CRM organization. Additional keys: not allowed
associations	array	Required within parent	Array of association records showing where unsubscribe links are being used Maximum items: 1
associations[]	Model	Each item	Expand Get Unsubscribe Link Associations — response body — associations associations item

Referenced models: Get Unsubscribe Link Associations — response body — associations associations item

Get Unsubscribe Link Associations — response body — associations associations item

Field	Type	Presence	Description and constraints
$	object	Root	Association record that groups the associated places under a specific unsubscribe link ID. Additional keys: not allowed
associated_places	array	Required within parent	List of places where this unsubscribe link is being used Maximum items: 1
associated_places[]	Model	Each item	Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item
id	string	Required within parent	Represents the unique identifier for an unsubscribe link. The unique identifier of the unsubscribe link Maximum length: 19

Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item

Get Unsubscribe Link Associations — response body — associations associations item associated places item

Field	Type	Presence	Description and constraints
$	object	Root	A place where the unsubscribe link is associated, including the linked resource, module details, and association type. Additional keys: not allowed
details	Model	Required within parent	Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item details
resource	Model	Required within parent	Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item resource
type	string	Required within parent	The type of associated place (e.g., email_templates) Maximum length: 255

Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item details, Get Unsubscribe Link Associations — response body — associations associations item associated places item resource

Get Unsubscribe Link Associations — response body — associations associations item associated places item details

Field	Type	Presence	Description and constraints
$	object	Root	Additional details for an unsubscribe link association, including the associated module context. Additional keys: not allowed
module	Model	Required within parent	Expand Get Unsubscribe Link Associations — response body — associations associations item associated places item details module

Referenced models: Get Unsubscribe Link Associations — response body — associations associations item associated places item details module

Get Unsubscribe Link Associations — response body — associations associations item associated places item resource

Field	Type	Presence	Description and constraints
$	object	Root	Represents the resource associated with an unsubscribe link, including its name and unique identifier. Additional keys: not allowed
id	string	Required within parent	The unique identifier of the associated resource Maximum length: 19
name	string	Required within parent	The name of the associated resource Maximum length: 255

Get Unsubscribe Link Associations — response body — associations associations item associated places item details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module information associated with an unsubscribe link, including the module API name and ID. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM module associated with the unsubscribe link. Maximum length: 255
id	string	Required within parent	Represents the unique identifier of the CRM module associated with the unsubscribe link. Maximum length: 19

Policy, approvals and errors

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