Send Document for Signing
Sends a Zoho Writer document to the specified recipients for signing, approval, or viewing through the selected sign service, and tracks the status of the request.
Endpoints
OAuth Scope
curl --request POST \
--url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/sign \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: multipart/form-data' \
-F 'recipients=[
{
"recipient_1": "john@zylker.com",
"recipient_name": "John",
"action_type": "sign"
}
]' \
-F 'signed_document_name=SignedDoc' \
-F 'service_name=zohosign' \
-F 'subject=Please sign this document' \
-F 'message=Kindly review and sign the attached document.' \
-F 'attachments=@file_path' \
-F 'is_sequential=true' \
-F 'prefill_data={
"name": "Amelia"
}' \
-F 'reminder_period=3' \
-F 'expire_in=15' \
-F 'sign_org_id=string' \
-F 'sign_request_type_id=string' \
-F 'allowed_cloud_provider_ids=[
10,
25
]' \
-F 'callback_url=https://zylker.com/webhook/sign-complete'Path Parameters
The unique identifier of the Zoho Writer document.
Request Body
multipart/form-dataAn array of recipient objects specifying who receives the document and their role. Each object must include a dynamic key recipient_n (e.g. recipient_1, recipient_2) containing the recipient's email address. Up to 25 recipients are supported.
Hide Sub-Attributes
The action the recipient is required to perform.
The display name of the recipient.
The position of this recipient in the signing sequence. When set, the recipient's email address must be supplied under the matching recipient_n key — a signing_order of 2 requires a recipient_2 key. When omitted, the recipient's position in the array is used.
The language code for the notification email sent to the recipient.
Additional channels used to deliver the signing notification, beyond email. Supported values for type: sms, whatsapp.
Hide Sub-Attributes
The channel used to deliver the signing notification, in addition to email.
The country code for the recipient's phone number. Required when type is specified. When verification_info.type is also sms or whatsapp, this must match the country code given there.
The recipient's phone number without the country code. Required when type is specified. When verification_info.type is also sms or whatsapp, this must match the phone number given there.
A private note visible only to this recipient.
The identifier of a signer group to address instead of an individual recipient. Supply either this or the recipient_n email key for a given recipient, never both. Only sign is a valid action_type for a signer group, and the same group cannot appear twice in recipients.
Details of the host who signs on the recipient's behalf. Applicable when action_type is in_person_sign.
Hide Sub-Attributes
The name of the in-person signer. Required when action_type is in_person_sign.
The email address of the in-person signer, which must belong to the sender's organization. Required when verification_info.type is email.
Identity verification settings for the recipient. Supported values for type: email, sms, offline, whatsapp.
Hide Sub-Attributes
The identity verification method required before the recipient can sign.
The country code for the recipient's phone number. Required when type is sms or whatsapp.
The recipient's phone number without the country code. Required when type is sms or whatsapp.
The verification code the recipient must enter. Required when type is offline.
A name for the signed document.
The sign service through which the document is sent for signing.
The subject line of the notification email sent to recipients. If omitted, the value configured in the document's saved Sign settings is used.
The body content of the notification email sent to recipients. If omitted, the value configured in the document's saved Sign settings is used.
One or more files to attach to the notification email. Maximum 20 files, up to 10 MB each, with a combined total of 10 MB; files beyond that total are not attached. Supported formats: docx, doc, pdf, rtf, odt, xml, xhtml, html, txt, epub, zip, png, jpg, jpeg, gif, ics.
When true, recipients must sign or approve the document in the order they are listed in recipients. If omitted, the value configured in the document's saved Sign settings is used.
Data to pre-fill in the document's form fields, keyed by field name. Supports text, checkbox, radio, and dropdown field types. Up to 100 fields can be supplied, each value up to 10000 characters. Values cannot contain any of the characters @ _ ! # $ % ^ & * ( ) < > ? / | } { ~ :.
The interval, in days, at which reminder emails are sent to the recipients. If omitted, the value configured in the document's saved Sign settings is used.
The number of days after which the signing request expires. If omitted, the value configured in the document's saved Sign settings is used.
The Zoho Sign organization ID from which the document is sent for signing.
The Zoho Sign document type ID.
The IDs of the digital signature providers permitted for this signing request. Cannot be an empty array. Supported values: 10, 20, 25, 40, 50, 60, 70, 71, 80, 90, 100, 110, 120, 130, 140, 150.
A URL that receives a notification when the document is signed.
// Note: payload contains multiple type attributes
// type: array
recipients = [
{
"recipient_1": "john@zylker.com",
"recipient_name": "John",
"action_type": "sign"
}
]
// type: string
signed_document_name = SignedDoc
// type: string
service_name = zohosign
// type: string
subject = Please sign this document
// type: string
message = Kindly review and sign the attached document.
// type: file
attachments = <file>
// type: boolean
is_sequential = true
// type: object
prefill_data = {
"name": "Amelia"
}
// type: integer
reminder_period = 3
// type: integer
expire_in = 15
// type: string
sign_org_id = string
// type: string
sign_request_type_id = string
// type: array
allowed_cloud_provider_ids = [
10,
25
]
// type: string(uri)
callback_url = https://zylker.com/webhook/sign-complete {
"status": "success",
"sign_status_url": "https://sign.zoho.com/zs#/request/details/1234567000000012345"
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.