Update Document Metadata

Updates a single metadata field or state attribute of a Zoho Writer document — its name, description, favourite flag, final/draft state, lock state, readiness, or track-changes setting.

Endpoints

post https://www.zohoapis.com/writer/api/v1/documents/{document_id}/meta

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALLCopied!

curl --request POST \
  --url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/meta \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"operations":{"name":"New Document Name","description":"Invoice Q1 2026","favourite":true,"mark_as_final":true,"lock":true,"state":"mark_as_complete","track_changes":"enable"}}'


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data_operations=Map();
    data_operations.put("name","New Document Name");
    data_operations.put("description","Invoice Q1 2026");
    data_operations.put("favourite",true);
    data_operations.put("mark_as_final",true);
    data_operations.put("lock",true);
    data_operations.put("state","mark_as_complete");
    data_operations.put("track_changes","enable");
    data.put("operations",data_operations);

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/documents/{document_id}/meta"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

Path Parameters

document_idstring(Required)

The unique identifier of the Zoho Writer document.

Request Body

application/json

operationsJSON Object(Required)

An object containing exactly one metadata field to update.

Hide Sub-Attributes

namestring(Optional)

The new name to assign to the document.

Maximum Length :255Copied!

descriptionstring(Optional)

The new description to set for the document.

Maximum Length :200Copied!

favouriteboolean(Optional)

When true, marks the document as a favourite. When false, removes the document from favourites.

mark_as_finalboolean(Optional)

When true, marks the document as final. When false, reverts the document from final back to an editable state.

lockboolean(Optional)

When true, locks the document. When false, unlocks the document.

statestring(Optional)

Marks the document as ready, moving it out of the draft state and making it accessible to everyone in the team folder.

Allowed Values :

Show Values ▾

track_changesstring(Optional)

Controls whether track changes is enabled for the document. If the document owner or co-owner enables track changes, the feature is enabled for all users accessing that document. If any other collaborator enables track changes while viewing the document, the feature applies only to that collaborator and not to other users accessing the same document.

Allowed Values :

Show Values ▾

  {
    "operations": {
      "name": "New Document Name",
      "description": "Invoice Q1 2026",
      "favourite": true,
      "mark_as_final": true,
      "lock": true,
      "state": "mark_as_complete",
      "track_changes": "enable"
    }
  }

▼ Show full

  {
    "result": "success",
    "message": "Document description has been updated successfully.",
    "description": "Invoice Q1 2026",
    "modified_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "The document has been added to your favorites.",
    "is_favourite": true,
    "modified_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "The document has been marked as final.",
    "final_info": {
      "zuid": "1308724",
      "status": true,
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "Document lock operation has been completed successfully.",
    "locked_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "The document has been unlocked successfully.",
    "unlocked_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "Document has been renamed successfully.",
    "name": "New Document Name",
    "modified_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "message": "Document marked as complete successfully",
    "state": "active",
    "modified_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

  {
    "result": "success",
    "message": "The trackchanges has been enabled in the document.",
    "modified_by": {
      "email_id": "zylker@zylker.com",
      "profile_photo": "https://contacts.zoho.com/file?t=user&ID=1308724&fs=thumb",
      "user_id": "1308724",
      "timezone": "Asia/Kolkata",
      "language": "en",
      "display_name": "Zylker"
    }
  }

▼ Show full