meta

Description

Updates the meta information of the document for all collaborative editors.

Request example

  1. {
  2.     "c": "meta",
  3.     "key": "Khirz6zTPdfd7",
  4.     "meta": {
  5.         "title": "Example Document Title.docx"
  6.     }
  7. }

Parameters

ParameterDescriptionTypePresence
cDefines the command type.stringrequired
keyDefines the document identifier used to unambiguously identify the document file.stringrequired
metaDefines the new meta information of the document:
  • title - the new document name.
    type: string
    presence: required
objectrequired

Response example

  1. {
  2.     "error": 0,
  3.     "key": "Khirz6zTPdfd7"
  4. }

Parameters

ParameterDescriptionTypePresence
errorDefines an error code.integerrequired
keyDefines the document identifier used to unambiguously identify the document file.stringrequired