Create With Web Url
Purpose
To create a document via Web URL.
Quick Reference
| Property | Value |
|---|---|
| Method | POST |
| Request URL | https://{zohoapis_domain}/writer/api/v1/documents |
| Scopes | ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALL |
| Rate Limit | See Writer API throttle limits |
Parameters
Body Parameters
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| url | String | Mandatory | Specify the Web URL (which is publicly accessible) through which the document needs to be created. |
| filename | String | Optional | Specify a unique name for the document. |
| folder_id | String | Optional | Specify a folder name, if you would like the document to be created in a particular folder or location. |
| resource_type | String | Optional | Specify the type of document which needs to be created. Possible values: fillable/merge/sign |
Notes
- For possible errors, refer to error codes.
Sample Request
Copiedcurl -X POST "https://www.zohoapis.com/writer/api/v1/documents" \
-H "Authorization: Zoho-oauthtoken <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/sample.docx","filename":"webdoc"}'Copiedparam = Map();
param.put("url","https://example.com/document.docx");
response = invokeurl
[
url :"https://www.zohoapis.com/writer/api/v1/documents"
type :POST
parameters:param
connection:"<connection_name>"
];
info response;Sample Response
Copied{
"created_time": "2018-05-08T14:04:31Z",
"role": "OWNER",
"owner_id": "4579020",
"parent_folder_id": "ponaz1ba3eac63b1242848a24c7561c5ed9fe",
"open_url": "https://writer.zoho.com/writer/open/ponazaad72ae3cb0143aca0763ecd5acb87e1",
"is_favourite": false,
"document_id": "ponazaad72ae3cb0143aca0763ecd5acb87e1",
"created_by": "Amelia",
"version": "1.0",
"document_name": "Invoice template",
"modified_time": "2018-05-08T14:04:32Z",
"preview_url": "https://writer.zoho.com/writer/preview/ponazaad72ae3cb0143aca0763ecd5acb87e1",
"creator_id": "4579020",
"download_url": "https://writer.zoho.com/api/v1/download/ponazaad72ae3cb0143aca0763ecd5acb87e1",
"document_properties": "https://writer.zoho.com/api/v1/documents/ponazaad72ae3cb0143aca0763ecd5acb87e1",
"lastmodified_by": [
{
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=4579020&fs=thumb",
"user_id": "4579020",
"display_name": "Amelia"
}
]
}