Zoho: Get Unsubscribe Links

Zoho unsubscribeLinks.getUnsubscribeLinks: arguments, response, policy and SDK examples.

← Unsubscribe links operations · Get started

Operation zoho.getunsubscribelinks

Provider route: GET /crm/v8/settings/unsubscribe_links. 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"]["getUnsubscribeLinks"]>[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.getUnsubscribeLinks(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_links(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 Links — response body — unsubscribe links
`$ (anyOf 2)`	null	Alternative

Referenced models: Get Unsubscribe Links — response body — unsubscribe links

Schemas

Get Unsubscribe Links — response body — unsubscribe links

Field	Type	Presence	Description and constraints
`$`	object	Root	Response envelope containing a collection of unsubscribe link records returned by the settings listing endpoint. Additional keys: not allowed
`unsubscribe_links`	array	Required within parent	Array of unsubscribe link summary records Maximum items: 10
`unsubscribe_links[]`	Model	Each item	Expand Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item

Referenced models: Get Unsubscribe Links — response body — unsubscribe links unsubscribe links item

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator or modifier references as returned by the listing endpoint. 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`	JSON	Required within parent
`custom_location_url (anyOf 1)`	string	Alternative	The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard. Maximum length: 255
`custom_location_url (anyOf 2)`	null	Alternative	The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard. Maximum length: 255
`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	Represents the unique name of the unsubscribe link Maximum length: 255
`page_type`	JSON	Required within parent
`page_type (anyOf 1)`	string	Alternative	Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255
`page_type (anyOf 2)`	null	Alternative	Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom) Maximum length: 255
`standard_page_message`	JSON	Required within parent
`standard_page_message (anyOf 1)`	string	Alternative	Represents the message displayed on the standard unsubscribe page. Null if page_type is custom. Null if page_type is custom. Maximum length: 2000
`standard_page_message (anyOf 2)`	null	Alternative	Represents the message displayed on the standard unsubscribe page. Null if page_type is custom. Null if page_type is custom. Maximum length: 2000
`submission_action_type`	string	Required within parent	Represents the action performed after unsubscribe display_message (show a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL)" Maximum length: 255
`submission_message`	JSON	Required within parent
`submission_message (anyOf 1)`	string	Alternative	The message displayed when the user clicks the unsubscribe button (for display_message action type). Null if not configured. Maximum length: 2000
`submission_message (anyOf 2)`	null	Alternative	The message displayed when the user clicks the unsubscribe button (for display_message action type). Null if not configured. Maximum length: 2000
`submission_redirect_url`	JSON	Required within parent
`submission_redirect_url (anyOf 1)`	string	Alternative	The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured. Maximum length: 255
`submission_redirect_url (anyOf 2)`	null	Alternative	The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured. Maximum length: 255

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.getunsubscribelinks. Catalog operation: getUnsubscribeLinks. 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