Combine PDFs

Purpose

Using this API, you will be able to combine PDF documents.

HTTP Request URL

https://{zohoapis_domain}/writer/api/v1/documents/pdf/combine

Body Parameters

Parameter	Data Type	Description
Mandatory Parameters
files or urls	File or String	Method of providing the input file depending on its location. files - If the input files are from your local drive or desktop. urls - If the input files are publicly accessible Web URLs. You will have to pass them as a comma separated list. Note: Up to 20 input pdf files can be combined at once. A minimum of 2 files must be provided to perform the combine operation. Total file size limit for the input files will be 10 MB each.
Optional Parameters
output_settings	{ "name": <filename>, "page_number_settings": { "sections": [ { "range": "1-10", "format": { "font": { "name": "Helvetica", "size": 10, "style": "Bold" } }, "numbering_config": { "type": "1", "start": 1 }, "header": { "left": { "text": "Page <<page_number>> of <<total_pages>>", "offsets": { "top": 20, "left": 40 } } }, "footer": { "center": { "text": "Page <<page_number>> of <<total_pages>>", "offsets": { "bottom": 20 } } } } ] } }	name - Specify a unique name for the merged or combined output file. By default, the output file name will be "output.pdf". page_number_settings - Contains the page number configuration as a JSON Object. sections (mandatory) - List of configuration blocks, each defining how page numbers should be inserted for a specific page range. Sample: For adding page number in header at center. { "sections": [ { "header": { "center": { "text": "Page <<page_number>> of <<total_pages>>", } } } ] }
input_options	{ 1: { page_ranges : "3,5,7" , }, 2 : { page_ranges : "1-3, 5" } }	It is possible to combine selected pages or a specific range pages in a document. To combine selectedpages, you will have to pass the respective page numbers with comma separated (say 3,5,7,etc.,). To combine a specific range of pages, you will have to pass the page ranges with a hypen (say 1-3).
team_id	String	If the user has multiple WorkDrive teams and wants to use a specific team for credit usage, use this parameter. By default, the user's preferred team will be used for credit calculation.

sections

Parameter

Type

Possible Values

Default Value

range

(optional)

string

"1-9"

Specify the page ranges from where the page number needs to be inserted.

By default, page numbers will be added in all pages.

format

(optional)

JSON Object

{

"font":{

"name":"Roboto",

"size": 12,

"style": "Normal"

}

Defines the formatting for the page numbers.

font (optional) - Contains font styling details.

name (optional) -Web-safe fonts.

size (optional) - Specify font size.

style (optional) - Specify the font styles.

Allowed values: Normal, Bold, Italic, Bold Italic.

By default,

font -Roboto

size -12

style - Normal

numbering_config

(optional)

JSONObject

{

"type":"1|a|A|i|I",

"start": 5

}

type (optional) - Defines the numbering style. Allowed values: 1/a/A/i/I

By default: 1,2,3

start (optional) - Defines the starting number for the page numbers.

For example: If type is "a" and start is 5 then the numbering will start from 'e'.

header / footer

(atleast one is mandatory)

JSONObject

{

"left": {

"text": "Page <<page_number>> of <<total_pages>>",

"offsets": {

"top": "20px",

"left": "40px"

}

"center": {

"right": {

}

Contains layout sections where page numbers or text can be added in header/footer.

left/center/right - (atleast one mandatory in either header or footer) - Specify the placement and content of text in the left, center or right position.

text (mandatory) - Specify the text content to be displayed. You may use placeholders like <<page_number>> and <<total_pages>>.

offsets (optional) - Specify the positioning offsets for the text, with top, bottom, left, and right values in pixels. Defaults to header/footer position if not provided.

Note:

This API will be available only for users who have Zoho WorkDrive Account.
To use this API, an OAuth token should be generated with the following scopes; ZohoWriter.documentEditor.ALL,ZohoWriter.merge.ALL,WorkDrive.organization.ALL
This API is subject to throttle limits. For details on the applicable rate limits, please refer to this help link.

Sample Request

Curl Deluge

Copiedcurl --location --request POST "https://www.zohoapis.com/writer/api/v1/documents/pdf/combine" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'output_settings="{\"name\":\"CombinedFile.pdf\"}"' \ 
  --form 'files=@"/Users/username/Documents/Sample1.pdf"' \ 
  --form 'files=@"/Users/username/Documents/Sample2.pdf"' \ 
  --form 'input_options="{\"1\":{\"page_ranges\":\"3,5,6\"},\"2\":{\"page_ranges\":\"1-3,6\"}}"'

Copiedfileobj1 = invokeurl
[
	url :"https://www.africau.edu/images/default/sample.pdf"
	type :GET
];
info fileobj1;
fileobj2 = invokeurl
[
	url :"https://icseindia.org/document/sample.pdf"
	type :GET
];
info fileobj2;
fileobj2.setParamName("files");
output_settings = Map();
output_settings.put("name", "combined-document"); // name for the combined document
input_options = Map();
document_1 = Map();
document_1.put("page_ranges", "1");   //page_ranges for document 1
document_2 = Map();
document_2.put("page_ranges", "1,5");   //page_ranges for document 2
input_options.put("1", document_1);
input_options.put("2", document_2);
paramList = list();
paramList.add({"paramName":"files","content":fileobj1});
paramList.add({"paramName":"files1","content":fileobj2});
paramList.add({"paramName":"output_settings","content":output_settings.toString(),"Content-Type":"application/json","stringPart":"true"});
paramList.add({"paramName":"input_options","content":input_options.toString(),"Content-Type":"application/json","stringPart":"true"});
combinepdf_response = invokeurl
[
	url :"https://www.zohoapis.com/writer/api/v1/documents/pdf/combine"
	type :POST
	files:paramList
	connection:”<connection_name>”
];
info combinepdf_response;

Once the process is initiated, you will be provided with the 'status_url' initially. By invoking the 'status_url', you will be able to check the status of the scheduled job.

Sample Response

Copied{
    "status_url": "https://writer.zoho.com/writer/api/v1/documents/pdf/combine/job/f931a01183b33
}

Job completion status can be checked using the 'status' key. Once the status is changed to 'completed', you will be provided with a 'download_url'. Using which, you can download the combined file as bytes.

Copied{
"status": "completed/inprogress/failed"
"download_link":"https://writer.zoho.com/writer/api/v1/documents/pdf/combine/download/e8447fe5069440a15042f5a92d4f29404e26d9b43cd324d8816e46ba869c45ffa4ea798cc574a41281f257cc0c7a74cb937398933f9307f03e018ac4fb9d19640be41a77fc506a6ff4fef7632f12e6744ef0780637a3bcb047204642170ada40"
}