Zoho: Send mail merge email

← Mail merge operations · Get started

Operation zoho.postsendmailmerge

Provider route: POST /crm/v8/{moduleApiName}/{recordId}/actions/send_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"]["postSendMailMerge"]>[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.postSendMailMerge(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_send_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 Send mail merge email — request body — body

Referenced models: Send mail merge email — 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 Send mail merge email — response body

Referenced models: Send mail merge email — response body

Schemas

Send mail merge email — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body returned upon successful initiation of the send mail merge operation. Additional keys: not allowed
send_mail_merge	array	Optional	Represents the list of send mail merge response objects. Maximum items: 1
send_mail_merge[]	Model	Each item	Expand Send mail merge email — response body — send mail merge item

Referenced models: Send mail merge email — response body — send mail merge item

Send mail merge email — request body — body

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

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

Send mail merge email — response body — send mail merge item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response payload for a send mail merge operation. Additional keys: not allowed
code	string	Optional	Represents the response code indicating the result of the send mail merge operation. Maximum length: 255
details	Model	Optional	Expand Send mail merge email — response body — send mail merge item details
message	string	Optional	Represents the message describing the result of the send mail merge operation. Maximum length: 255
status	string	Optional	Represents the status of the send mail merge operation. Possible values: **success** - The mail merge email was initiated successfully. **error** - The mail merge email failed to initiate. Known values: success, error Maximum length: 255

Referenced models: Send mail merge email — response body — send mail merge item details

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload for a send mail merge operation, including the template, recipient addresses, subject, message body, and optional attachment settings. Additional keys: not allowed
attachment_name	string	Optional	Represents the name of the attachment to include in the mail merge email. Maximum length: 255
bcc_email	array	Optional	Represents the list of email addresses to include in the BCC field of the mail merge email. Maximum items: 1
bcc_email[]	Model	Each item	Expand Send mail merge email — request body — body send mail merge item bcc email item
cc_email	array	Optional	Represents the list of email addresses to include in the CC field of the mail merge email. Maximum items: 1
cc_email[]	Model	Each item	Expand Send mail merge email — request body — body send mail merge item cc email item
from_address	Model	Optional	Expand Send mail merge email — request body — body send mail merge item from address The email ID you want to use to send emails from. This email address must be the one of the org-verified email addresses or the current user's email ID.
mail_merge_template	Model	Required within parent	Expand Send mail merge email — request body — body send mail merge item mail merge template Mailmerge Object to pass Template details (Required)
message	string	Optional	Represents the body or content of the email you want to send. It can include up to **100,000 characters**. Maximum length: 100000
subject	string	Optional	Represents the subject line of the mail merge email. Maximum length: 255
to_address	array	Optional	Represents the list of email addresses to send the mail merge email to. Maximum items: 2
to_address[]	Model	Each item	Expand Send mail merge email — request body — body send mail merge item to address item
type	string	Optional	Represents the attachment type for the mail merge email. Possible values: **inline** - Includes the mail merge document as an inline image in the email. **attachment** - Attaches the mail merge document as a separate file in the email. One of: inline, attachment Maximum length: 10

Referenced models: Send mail merge email — request body — body send mail merge item bcc email item, Send mail merge email — request body — body send mail merge item cc email item, Send mail merge email — request body — body send mail merge item from address, 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 to address item

Send mail merge email — response body — send mail merge item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response details returned upon successful initiation of the send mail merge operation. Additional keys: not allowed
report_link	string	Optional	Represents the URL of the mail merge job report. Format: uri Maximum length: 255

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents a BCC recipient entry for a mail merge email, containing the address type and email value. Additional keys: not allowed
type	string	Required within parent	Represents the type of the address. Possible values: **email** - Indicates that the value is an email address. One of: email Maximum length: 5
value	string	Required within parent	Represents the email address to include in the BCC list for the mail merge email. Format: email Maximum length: 255 Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CC recipient entry for a mail merge email, containing the address type and email value. Additional keys: not allowed
type	string	Required within parent	Represents the type of the address. Possible values: **email** - Indicates that the value is an email address. One of: email Maximum length: 5
value	string	Required within parent	Represents the email address to include in the CC list for the mail merge email. Format: email Maximum length: 255 Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Send mail merge email — request body — body send mail merge item from address

Field	Type	Presence	Description and constraints
$	object	Root	Represents the sender address for a mail merge email, containing the address type and an org-verified or current user's email address. Additional keys: not allowed
type	string	Required within parent	Represents the type of the address. Possible values: **email** - Indicates the value is an email address. One of: email Maximum length: 5
value	string	Required within parent	Represents the sender email address used to send the mail merge email. Format: email Maximum length: 255 Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

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

Send mail merge email — request body — body send mail merge item to address item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a recipient address entry for a mail merge email, containing the address type and email value. Additional keys: not allowed
type	string	Required within parent	Represents the type of the address. Possible values: **email** - Indicates the value is an email address. One of: email Maximum length: 5
value	string	Required within parent	Represents the recipient email address for the mail merge email. Format: email Maximum length: 255 Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Policy, approvals and errors

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