Zoho: Get Unsubscribe Link by ID

← Unsubscribe links operations · Get started

Operation zoho.getunsubscribelinkbyid

Provider route: GET /crm/v8/settings/unsubscribe_links/{id}. 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"]["getUnsubscribeLinkById"]>[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.getUnsubscribeLinkById(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_unsubscribe_link_by_id(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.id	string	Required within parent	Maximum length: 255

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 by ID — response body — unsubscribe links
$ (anyOf 2)	null	Alternative

Referenced models: Get Unsubscribe Link by ID — response body — unsubscribe links

Schemas

Get Unsubscribe Link by ID — response body — unsubscribe links

Field	Type	Presence	Description and constraints
$	object	Root	Response payload containing the unsubscribe link records returned by the GET by ID endpoint. Additional keys: not allowed
unsubscribe_links	array	Required within parent	Array containing the requested unsubscribe link details Maximum items: 1
unsubscribe_links[]	Model	Each item	Expand Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item

Referenced models: Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item

Get Unsubscribe Link by ID — response body — unsubscribe links unsubscribe links item

Field	Type	Presence	Description and constraints
$	object	Root	Full unsubscribe link configuration including display messages, submission behavior, audit information, and creator or modifier details. Additional keys: not allowed
created_by	Model	Required within parent	Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by
created_time	string	Required within parent	The date and time when the unsubscribe link was created Maximum length: 255
custom_location_url	null	Required within parent	The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard.
id	string	Required within parent	Represents the unique identifier for an unsubscribe link. The unique identifier of the unsubscribe link Maximum length: 19
modified_by	Model	Required within parent	Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by
modified_time	string	Required within parent	The date and time when the unsubscribe link was last modified Maximum length: 255
name	string	Required within parent	The unique name of the unsubscribe link Maximum length: 255
page_type	string	Required within parent	Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255
standard_page_message	string	Required within parent	The message displayed on the standard unsubscribe page Maximum length: 2000
submission_action_type	string	Required within parent	The action performed after unsubscribe: display_message (show a message) or redirect (redirect to a URL) Maximum length: 255
submission_message	string	Required within parent	The message displayed when the user clicks the unsubscribe button (for display_message action type) Maximum length: 2000
submission_redirect_url	null	Required within parent	The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured.

Referenced models: Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by, Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by

Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item created by

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	User who created the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
$ (anyOf 1).id	string	Required within parent	Represents the unique identifier of the user who created the unsubscribe link unsubscribe link Maximum length: 19
$ (anyOf 1).name	string	Required within parent	Represents the name of the user who created the unsubscribe link Maximum length: 255
$ (anyOf 2)	null	Alternative	User who created the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
$ (anyOf 2).id	string	Required within parent	Represents the unique identifier of the user who created the unsubscribe link unsubscribe link Maximum length: 19
$ (anyOf 2).name	string	Required within parent	Represents the name of the user who created the unsubscribe link Maximum length: 255

Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item modified by

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	User who last modified the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
$ (anyOf 1).id	string	Required within parent	Represents the unique identifier of the user who last modified the unsubscribe link unsubscribe link Maximum length: 19
$ (anyOf 1).name	string	Required within parent	Represents the name of the user who last modified the unsubscribe link link Maximum length: 255
$ (anyOf 2)	null	Alternative	User who last modified the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
$ (anyOf 2).id	string	Required within parent	Represents the unique identifier of the user who last modified the unsubscribe link unsubscribe link Maximum length: 19
$ (anyOf 2).name	string	Required within parent	Represents the name of the user who last modified the unsubscribe link link Maximum length: 255

Policy, approvals and errors

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