Zoho: Mail merge schemas

← Mail merge operations · All 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 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 — 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 — 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

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 — 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 — 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

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 — 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 — 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,}$

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 — 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 — 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