Convert Documents With Web URL
Purpose
To convert any document's existing file format (say HTML) to another file format (say DOCX or TXT) with web URL.
Quick Reference
| Property | Value |
|---|---|
| Method | POST |
| Request URL | https://{zohoapis_domain}/writer/api/v1/documents/convert |
| Scopes | ZohoWriter.documentEditor.ALL |
| Rate Limit | See Writer API throttle limits |
Parameters
Body Parameters
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| url | String | Mandatory | Specify the web URL, through which the document will be converted. |
| format | String | Mandatory | Specify the format of the document to be converted. Supported file formats: docx, odt, rtf, txt, html, pdf |
| filename | String | Mandatory | Specify a name to the document to be converted. |
| Password | String | Mandatory | Specify a unique password for the document to be converted. |
Notes
- Note: This API is subject to throttle limits. For details on the applicable rate limits, please refer to this help link.
- For possible errors, refer to error codes.
Curl Snippet
Copiedcurl --location --request POST "https://www.zohoapis.com/writer/api/v1/documents/convert" \
--header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
--form "url=https://calibre-ebook.com/downloads/demos/demo.docx" \
--form "format=docx" \
--form "filename=Output filename"Deluge Snippet
Copiedurl = "https://example.com/download/publicdocument";
filedata = invokeurl
[
url : url
type :GET
];
filesList = List();
filesList.add({"paramName":"content", "content":filedata});
filesList.add({"paramName":"format", "content":"pdf","stringPart":"true"});
filesList.add({"paramName":"filename", "content":"Converted_doc","stringPart":"true"});
response = invokeurl
[
url: "https://zohoapis.com/writer/api/v1/documents/convert"
type: POST
files: filesList
connection:""
];
return response;