Prefill API

Purpose

This API is used to generate pre-filled fillable link for Fillable Templates.

HTTP Request URL

https://{zohoapis_domain}/writer/api/v1/documents/{resource_id}/generateprefilledurl

Query Parameters

Parameter

Data Type

Description

Optional Parameters

submit_settings

{
"callback_info": {
"url": <Your Callback Url>
}
}

Using this param, you will be able to specify the following;

url -> Specify the location where the data filled in the form needs to be pushed when the 'Submit' is performed.

submit_settings

Parameter	Type	Possible Values	Default Value
Optional Keys
url	string	URL - Maximum length -> 65535	If this key is not passed, the value configured in the template settings will be used by default.

Note: To use this API, you must add a data source and map the fillable fields to be pre-filled with values from the data source. For detailed instructions, please refer to the steps outlined in this help link.

Sample Request

Copiedcurl --location --request POST "https://www.zohoapis.com/writer/api/v1/documents/ponazfea04477109f4681a831e7177d96bc40/generateprefilledurl" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form "submit_settings={\"callback_info\":[{\"ur\":\"https://example.com\"}]}"

Sample Response

Copied{
"prefilled_urls": ["https://domain.com/writer/published/8vp6977390ad17c34416eb636c26c617f616a/fill/prefill/1d142e4e63790c98f573325a3c455ce25752cef1a0c6b2189ce55d738"],
"status": "success"
}