Mark As Ready Document
Purpose
Using this API, you can mark the document as ready from the draft state and make it accessible to everyone available in your team folder.
Quick Reference
| Property | Value |
|---|---|
| Method | POST |
| Request URL | https://{zohoapis_domain}/writer/api/v1/documents/{document_id}/meta |
| Scopes | ZohoWriter.documentEditor.ALL |
| Rate Limit | See Writer API throttle limits |
Parameters
Path Parameters
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| document_id | String | Mandatory | Specify the unique id for the Writer document. |
Body Parameters
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| operations | JSONObject | Mandatory | Pass "mark_as_complete" String value through 'state' key inside the JSON Object. |
Notes
- Note: You can also mark the document as ready using this deluge task.
- For possible errors, refer to error codes.
Sample Request
Copiedcurl -X POST \
https://www.zohoapis.com/writer/api/v1/documents/h36bc2a6c50b2754a405880c1d1679a5*****/meta \
-H 'Authorization: Zoho-oauthtoken xxx.yyy.zzz' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F 'operations={"state": "mark_as_complete"}'Sample Response
Copied{
"modified_by": {
"email_id": "amelia@zylker.com",
"profile_photo": "https://contacts.zoho.com/file?t=user&ID=1234&fs=thumb",
"user_id": "456215787",
"timezone": "Asia/Kolkata",
"language": "en",
"display_name": "Amelia"
},
"state": "active",
"message": "Document marked as complete successfully"
}