Zoho: Send mail merge document for signing

← Mail merge operations · Get started

Operation zoho.postsignmailmerge

Provider route: POST /crm/v8/{moduleApiName}/{recordId}/actions/sign_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"]["postSignMailMerge"]>[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.postSignMailMerge(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_sign_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 document for signing — request body — body

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

Referenced models: Send mail merge document for signing — response body

Schemas

Send mail merge document for signing — response body

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

Referenced models: Send mail merge document for signing — response body — sign mail merge item

Send mail merge document for signing — request body — body

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

Referenced models: Send mail merge document for signing — request body — body sign mail merge item

Send mail merge document for signing — response body — sign mail merge item

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

Referenced models: Send mail merge document for signing — response body — sign mail merge item details

Send mail merge document for signing — request body — body sign mail merge item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload for a sign mail merge operation, including the template reference, file name, signing order, and the list of signers. Additional keys: not allowed
file_name	string	Required within parent	Represents the name of the file to send for signing or approval. 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 details (Required)
sign_in_order	boolean	Optional	Indicates whether recipients must act on the document in a specified sequence. Possible values: **true** - The document first goes for approval, then for signing in the defined order. **false** - Zoho Sign sends the document to all recipients simultaneously.
signers	array	Optional	The details of the users you want to sign the document. - recipient_name **string, mandatory** - the name of the user who has to sign or approve the document. - **action_type** string, mandatory - the type of action you want the user to perform. The possible values are sign to **sign** the document, and **approve** to approve the document. - **recipient** JSON object, mandatory - **value** string, mandatory - the email ID of the user who has to sign or approve the document. > **Note** > The values for the fields **recipient_name** and **recipient.value** will be taken from the mail merge template. If you want to override the values in the template, you must specify the values of these fields in the input body. Maximum items: 3
signers[]	Model	Each item	Expand Send mail merge document for signing — request body — body sign mail merge item signers item

Referenced models: Send mail merge email — request body — body send mail merge item mail merge template, Send mail merge document for signing — request body — body sign mail merge item signers item

Send mail merge document for signing — response body — sign mail merge item details

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

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 document for signing — request body — body sign mail merge item signers item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a signer entry for a sign mail merge operation, including the recipient details, the recipient name, and the required action type. Additional keys: not allowed
action_type	string	Required within parent	Represents the action the recipient must perform on the mail merge document. Possible values: **sign** - The recipient must sign the document. **approve** - The recipient must approve the document. One of: sign, approve Maximum length: 7
recipient	Model	Required within parent	Expand Send mail merge document for signing — request body — body sign mail merge item signers item recipient Recipient Object (Required)
recipient_name	string	Required within parent	Represents the name of the recipient who must sign or approve the document. Maximum length: 255

Referenced models: Send mail merge document for signing — request body — body sign mail merge item signers item recipient

Send mail merge document for signing — request body — body sign mail merge item signers item recipient

Field	Type	Presence	Description and constraints
$	object	Root	Represents the recipient details for a signing or approval action, including the identifier type and value. Additional keys: not allowed
type	string	Required within parent	Represents the type of recipient identifier. Possible values: **email** - The recipient is identified by a direct email address. **merge_field** - The recipient is identified by a mail merge field reference. One of: email, merge_field Maximum length: 11
value	string	Required within parent	Represents the email address or mail merge field reference for the recipient. When **type** is **email**, provide a valid email address. When **type** is **merge_field**, provide a merge field reference such as **${!Leads.Email}**. Maximum length: 255

Policy, approvals and errors

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