Create document request with Zoho Sign API

Create document

This will create a new document

Arguments

Param	Datatype	Description
request_name *	String	name to be given to the signature request
request_type_id	String	Document Category Id
notes	String	Message to be sent to all recipients in common
expiration_days	Int	No of days after which the document will expire.
is_sequential *	Boolean	Sequential signing / Parallel Signing[true/false]
email_reminders	Boolean	Send automatic reminders
reminder_period	Int	Send automatic reminders once in [n] days
folder_id	String	Folder
signing_order	Int	Order in which recipient actions needs to be performed
actions	JSON array

Actions

Param	Datatype	Description
action_type *	String	Recipient Action [SIGN\|VIEW\|INPERSONSIGN\|APPROVER]
recipient_name *	String	Recipient name
recipient_email *	String	Recipient email
in_person_name *	String	Inperson recipient name
in_person_email	String	Inperson recipient email
verify_recipient *	Boolean	Authentication needs to be done or not
verification_type	String	Verification Mode [EMAIL\|SMS\|OFFLINE]
verification_code	String	Verification Code required on in case of OFFLINE Verification type
private_notes	String	Private notes for each recipient

API Root Endpoint

CopiedPOST https://sign.zoho.com/api/v1/requests

Request example

Copiedcurl --location 'https://sign.zoho.com/api/v1/requests' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form 'file=@Path to file'\
--form 'data="{
    "requests": {
        "request_name": "NDA",
        "description": "Details of document",
        "is_sequential": true,
        "actions": [
            {
                "action_type": "SIGN",
                "recipient_email": "abc@example.com",
                "recipient_name": "Alex James",
                "signing_order": 0,
                "verify_recipient": true,
                "verification_type": "EMAIL",
                "private_notes": "To be signed"
            },
            {
                "action_type": "INPERSONSIGN",
                "recipient_email": "alex.james@securesign24x7.com",
                "recipient_name": "Alex James",
                "in_person_name": "David",
                "in_person_email": "david@example.com",
                "signing_order": 1,
                "verify_recipient": false,
                "private_notes": "Sign as Inperson"
            }
        ],
        "expiration_days": 10,
        "email_reminders": true,
        "reminder_period": 2,
        "notes": "Note for all recipients"
    }
}"' \

Sample input

Copieddata={
    "requests": {
        "request_name": "NDA",
        "description": "Details of document",
        "is_sequential": true,
        "actions": [
            {
                "action_type": "SIGN",
                "recipient_email": "abc@example.com",
                "recipient_name": "Alex James",
                "signing_order": 0,
                "verify_recipient": true,
                "verification_type": "EMAIL",
                "private_notes": "To be signed"
            },
            {
                "action_type": "INPERSONSIGN",
                "recipient_email": "alex.james@securesign24x7.com",
                "recipient_name": "Alex James",
                "in_person_name": "David",
                "in_person_email": "david@example.com",
                "signing_order": 1,
                "verify_recipient": false,
                "private_notes": "Sign as Inperson"
            }
        ],
        "expiration_days": 10,
        "email_reminders": true,
        "reminder_period": 2,
        "notes": "Note for all recipients"
    }
}

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "code": 0,
    "requests": {
        "request_status": "draft",
        "notes": "Note for all recipients",
        "reminder_period": 2,
        "owner_id": "14197000000015003",
        "description": "Details of document",
        "request_name": "NDA",
        "modified_time": 1687251512156,
        "is_deleted": false,
        "expiration_days": 10,
        "is_sequential": true,
        "owner_first_name": "Alex James",
        "sign_percentage": 0,
        "owner_email": "bc@example.com",
        "created_time": 1687251512156,
        "email_reminders": true,
        "document_ids": [
            {
                "document_name": "RentalAgreement-MonthtoMonth",
                "pages": [
                    {
                        "page": 0,
                        "is_thumbnail": true
                    }
                ],
                "document_size": 15153,
                "document_order": "0",
                "is_editable": false,
                "total_pages": 2,
                "document_id": "14197000000767335"
            }
        ],
        "self_sign": false,
        "document_fields": [
            {
                "document_id": "14197000000767335",
                "fields": []
            }
        ],
        "in_process": false,
        "validity": -1,
        "request_type_name": "Others",
        "request_id": "14197000000767334",
        "request_type_id": "14197000000000187",
        "owner_last_name": "James",
        "actions": [
            {
                "verify_recipient": true,
                "recipient_countrycode_iso": "",
                "action_type": "SIGN",
                "private_notes": "To be signed",
                "cloud_provider_name": "Zoho Sign",
                "recipient_email": "abc@example.com",
                "send_completed_document": true,
                "verification_type": "EMAIL",
                "allow_signing": false,
                "recipient_phonenumber": "",
                "is_bulk": false,
                "action_id": "14197000000767351",
                "cloud_provider_id": 10,
                "signing_order": 0,
                "fields": [],
                "recipient_name": "Alex James",
                "delivery_mode": "EMAIL",
                "action_status": "NOACTION",
                "recipient_countrycode": ""
            },
            {
                "ishost": true,
                "verify_recipient": false,
                "recipient_countrycode_iso": "",
                "action_type": "INPERSONSIGN",
                "private_notes": "Sign as Inperson",
                "cloud_provider_name": "Zoho Sign",
                "recipient_email": "abc@example.com",
                "send_completed_document": true,
                "in_person_name": "David",
                "allow_signing": false,
                "recipient_phonenumber": "",
                "in_person_email": "david@example.com",
                "is_bulk": false,
                "action_id": "14197000000767356",
                "cloud_provider_id": 10,
                "signing_order": 1,
                "fields": [],
                "recipient_name": "Alex James",
                "delivery_mode": "EMAIL",
                "action_status": "NOACTION",
                "recipient_countrycode": ""
            }
        ]
    },
    "message": "Document has been added",
    "status": "success"
}