Zoho: Download mail merge document

← Mail merge operations · Get started

Operation zoho.postdownloadmailmerge

Provider route: POST /crm/v8/{moduleApiName}/{recordId}/actions/download_mail_merge. 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["mailMerge"]["postDownloadMailMerge"]>[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.mailMerge.postDownloadMailMerge(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.mail_merge.post_download_mail_merge(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.moduleApiName	string	Required within parent	Maximum length: 255
path.recordId	integer	Required within parent	Format: int64
body	Model	Optional	Expand Download mail merge document — request body — body

Referenced models: Download mail merge document — 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
$	object	Root	Represents the response body for a successful download mail merge request. Additional keys: not allowed
download_mail_merge	array	Optional	Represents the list of download mail merge response objects. Maximum items: 1
download_mail_merge[]	object	Each item	Each object represents an individual response item for the download mail merge operation. Additional keys: not allowed
download_mail_merge[].code	string	Optional	Represents the response code indicating the result of the download mail merge operation. Maximum length: 255
download_mail_merge[].message	string	Optional	Represents the message describing the result of the download mail merge operation. Maximum length: 255
download_mail_merge[].status	string	Optional	Represents the status of the download mail merge operation. Maximum length: 255

Schemas

Download mail merge document — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for the download mail merge operation. Additional keys: not allowed
download_mail_merge	array	Required within parent	Represents the list of download mail merge request objects. Contains one object per request. Maximum items: 1
download_mail_merge[]	Model	Each item	Expand Download mail merge document — request body — body download mail merge item

Referenced models: Download mail merge document — request body — body download mail merge item

Download mail merge document — request body — body download mail merge item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload for a download mail merge operation, including the template reference, output format, and optional file settings. Additional keys: not allowed
file_name	string	Optional	Represents the file name for the downloaded mail merge document. Maximum length: 255
mail_merge_template	Model	Required within parent	Expand Send mail merge email — request body — body send mail merge item mail merge template To pass template name (Required)
output_format	string	Optional	Represents the output format for the downloaded document. Possible values: **pdf** - Downloads the document in PDF format. **html** - Downloads the document in HTML format. **docx** - Downloads the document in DOCX format. One of: pdf, html, docx Maximum length: 4

Referenced models: Send mail merge email — request body — body send mail merge item mail merge template

Send mail merge email — request body — body send mail merge item mail merge template

Field	Type	Presence	Description and constraints
$	object	Root	Represents the mail merge template reference, identified by the template name. Additional keys: not allowed
name	string	Required within parent	Represents the name of the mail merge template to use for the operation. Maximum length: 255

Policy, approvals and errors

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