Set Form Data in PDF

Purpose

This API allows you to fill the required fields in a PDF form.

Quick Reference

Property	Value
Method	POST
Request URL	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/formdata/set

Body Parameters

Parameter	Value	Mandatory/Optional	Description
file	File or String	Mandatory	Upload the PDF file from your local drive or desktop. If the PDF is available via a publicly accessible web URL, you can provide the URL using the same parameter.
input_options	String	Mandatory	Specify the field values which need to be filled in the PDF form. Provide the data as a JSON string containing the field name and the corresponding value to be filled.
password	String	Optional	If the input PDF is password protected, specify the password to unlock it.

Notes and Limits

The maximum file size allowed for the input PDF is 50 MB. It cannot be more than 150 pages.
To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL

Possible Errors

Refer to the following pages for the list of possible errors for this API:

Sample Request

Copiedcurl --location --request POST "https://www.zohoapis.com/pdfeditor/api/v1/pdf/formdata" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@/Users/username/Documents/Original.pdf' \
  --form 'password="abc123"' \
  --form 'input_options={"formData":"{\"Given Name\":\"Amelia\",\"Family Name\":\"TL\",\"Postcode\":\"123456\",\"Make_RadioButton\":\"Option1\",\"Box1_CheckBox\":\"Yes\",\"Box3_CheckBox\":\"No\",\"Country\":\"India\",\"City\":\"Chennai\"}"}'

Once the process begins, you will initially receive the 'status_url'. By invoking the 'status_url', you will be able to monitor the status of the scheduled job.

Sample Response

Copied{
	"status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/formdata/job/f931a01183b33",
	"status": "inprogress"
}

Success Response

Copied{
	"download_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/formdata/download/f931a01183b33",
	"status": "success"
}