Zoho: Create Unsubscribe Link

← Unsubscribe links operations · Get started

Operation zoho.postunsubscribelinks

Provider route: POST /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"]["postUnsubscribeLinks"]>[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.postUnsubscribeLinks(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.post_unsubscribe_links(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Create Unsubscribe Link — request body — body

Referenced models: Create Unsubscribe Link — request body — body

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
$	Model	Root	Expand Create Unsubscribe Link — response body

Referenced models: Create Unsubscribe Link — response body

Schemas

Create Unsubscribe Link — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response for a POST request that returns the action status of each newly created unsubscribe link. Additional keys: not allowed
unsubscribe_links	array	Optional	Array containing the status of the creation operation for each link Maximum items: 1
unsubscribe_links[]	Model	Each item	Expand Create Unsubscribe Link — response body — unsubscribe links item

Referenced models: Create Unsubscribe Link — response body — unsubscribe links item

Create Unsubscribe Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request payload to create one or more unsubscribe links. Additional keys: not allowed
unsubscribe_links	array	Required within parent	Array containing the unsubscribe link configuration to create (required) Maximum items: 1
unsubscribe_links[]	Model	Each item	Expand Create Unsubscribe Link — request body — body unsubscribe links item

Referenced models: Create Unsubscribe Link — request body — body unsubscribe links item

Create Unsubscribe Link — response body — unsubscribe links item

Field	Type	Presence	Description and constraints
$	object	Root	Status of an unsubscribe link operation, including the outcome code, message, status, and the affected entity reference. Additional keys: not allowed
code	string	Optional	The result code (SUCCESS or error code) Maximum length: 255
details	Model	Optional	Expand Create Unsubscribe Link — response body — unsubscribe links item details
message	string	Optional	Represents the message describing the operation result. Maximum length: 255
status	string	Optional	The status of the operation (success or error) Maximum length: 255

Referenced models: Create Unsubscribe Link — response body — unsubscribe links item details

Create Unsubscribe Link — request body — body unsubscribe links item

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the fields required to create an unsubscribe link. The **name**, **page_type**, and **submission_action_type** fields are mandatory.
$ (allOf 1)	Model	All variants apply	Expand Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url
$ (allOf 2)	object	All variants apply	Required fields for creating an unsubscribe link Additional keys: allowed

Referenced models: Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url

Create Unsubscribe Link — response body — unsubscribe links item details

Field	Type	Presence	Description and constraints
$	object	Root	Reference to the entity affected by an operation, containing its unique identifier. Additional keys: not allowed
id	string	Optional	Represents the unique identifier for an unsubscribe link. The unique identifier of the affected unsubscribe link Maximum length: 19

Create Unsubscribe Link — request body — body unsubscribe links item custom location url, id, name, page type, standard page message, submission action type, submission message, submission redirect url

Field	Type	Presence	Description and constraints
$	object	Root	Represents the base fields for unsubscribe link configuration Additional keys: allowed
custom_location_url	string	Optional	Represents the custom webpage URL for hosting the unsubscribe link. Required when page_type is custom. Required when page_type is custom. Required when page_type is custom. Maximum length: 255
id	string	Optional	Represents the unique identifier of the unsubscribe link Maximum length: 19
name	string	Optional	Represents the unique name for the unsubscribe link Maximum length: 255
page_type	string	Optional	Specifies where the unsubscribe page is hosted: standard (Zoho CRM page) or custom (your own webpage) Maximum length: 255
standard_page_message	string	Optional	The message displayed on the standard unsubscribe page. Can be rich text (HTML) or plain text. Maximum length: 2000
submission_action_type	string	Optional	The action after unsubscribe: display_message (show a message) or redirect (redirect to a URL) Maximum length: 255
submission_message	string	Optional	Represents the message displayed when the user clicks the unsubscribe button. Required when submission_action_type is display_message. unsubscribe button. Required when submission_action_type is display_message. Maximum length: 2000
submission_redirect_url	string	Optional	Represents the URL to redirect users to after unsubscribing. Required when submission_action_type is redirect. Required when submission_action_type is redirect. Maximum length: 255

Policy, approvals and errors

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