Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Writer Merge API

Mail-merge operations: merge to bytes, link, store, invoke, or sign

Zoho Writer Merge API is one of 5 APIs that Zoho Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Merge. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 9 base URLs: https://www.zohoapis.com/writer/api/v1, https://www.zohoapis.eu/writer/api/v1, https://www.zohoapis.in/writer/api/v1, https://www.zohoapis.jp/writer/api/v1, https://www.zohoapis.com.au/writer/api/v1, https://www.zohoapis.ca/writer/api/v1, https://www.zohoapis.sa/writer/api/v1, https://www.zohoapis.com.cn/writer/api/v1, https://www.zohoapis.sg/writer/api/v1.

5 operations 5 paths 3 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://writer.zoho.com/api/v1
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Zoho Writer Merge API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 authentication. Refer to https://www.zoho.com/writer/help/api/v1/oauth-2.html for setup.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Merge 5

Mail-merge operations: merge to bytes, link, store, invoke, or sign

POST
/documents/{document_id}/merge
Merge document
mergeDocument 1 param body → 200
POST
/documents/{document_id}/merge/sign
Merge and sign
mergeAndSign 1 param body → 200
POST
/documents/{document_id}/merge/execute
Merge and invoke
mergeAndInvoke 1 param body → 200
POST
/documents/v2/{document_id}/merge/store
Merge and store (v2)
mergeAndStoreV2 1 param body → 200
POST
/templates/{template_id}/bulkmerge/sign
Bulk merge and sign
bulkMergeAndSign 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are MergeRecord (5 properties), MergeResponse (4 properties), OutputSettings (3 properties). Each schema is shown below with its type and property counts.

OutputSettings
object
3 properties 1 required
MergeRecord
object
5 properties
MergeResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-writer-merge-api-openapi.yml Raw ↑

Other APIs Zoho Writer publishes across the network.

Zoho Writer API
Zoho Writer Combine API
Zoho Writer Documents API
Zoho Writer Signatures API