Get Fields

Purpose 

To get the list of available merge fields present in the document.

HTTP Request URL

https://writer.zoho.com/writer/officeapi/v1/fields

Request Parameters

ParameterData TypeDescription
Mandatory Parameters
apikey423s*****Uniquely identifies the web application in which the Writer editor is integrated.

Body Parameters

ParameterData TypeDescription
Mandatory Parameters

file_content

or

file_url

File

or

String

Below are the methods to provide the input file that needs to merged with the data depending on its location.

file_content  - if the input file is from your local drive or desktop.

file_url - if the input file is from a publicly accessible Web URL.

 

Sample Request


				curl --location --request POST "https://writer.zoho.com/writer/officeapi/v1/fields" \
  --form "apikey=423s*****" \
  --form "file_content=@"			

Sample Response


				{
  merge : [
	{'id':'Name','display_name':'Name','type':'String'},
	{'id':'Email','display_name':'Email','type':'String'},
	{'id':'Mobile','display_name':'Mobile','type':'Number'},
	.....
    ]
}