Zoho: Unblock email for a single record

← Unblock email operations · Get started

Operation zoho.unblockemailbyid

Provider route: POST /crm/v8/{module}/{id}/actions/unblock_email. 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["unblockEmail"]["unblockEmailById"]>[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.unblockEmail.unblockEmailById(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.unblock_email.unblock_email_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.module	string	Required within parent	One of: Leads
path.id	string	Required within parent	Maximum length: 50
body	object	Required within parent	Specify the email fields to unblock for the record. Additional keys: not allowed
body.unblock_fields	array	Required within parent	To unblock emails, specify one or both of the system-defined fields : Email and Secondary_Email. > Note > - The permanently blocked emails cannot be unblocked. > - A temporarily blocked email can be unblocked up to 5 times. > - A custom email field cannot be unblocked. > - You cannot merge records that are locked or in an Approval Process/Review Process. Maximum items: 1
body.unblock_fields[]	string	Each item	Each string represents an email address to unblock. One of: Email

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	Contains the result of the email unblock operation for the specified record. Additional keys: not allowed
code	string	Required within parent	Represents the status code of the unblock operation. Known values: SUCCESS
details	object	Required within parent	Contains the details of the record for which the email was unblocked. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the record for which the email was unblocked. Maximum length: 50
message	string	Required within parent	Represents the descriptive message returned by the server for the unblock operation. Maximum length: 255
status	string	Required within parent	Represents the overall status of the unblock operation for the record. Maximum length: 255

Policy, approvals and errors

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