drop

Description

Disconnects the users with the identifiers specified in the users parameter from the document editing service. These users will be able to view the document, but will not be allowed to make changes to it.

Request example

  1. {
  2.     "c": "drop",
  3.     "key": "Khirz6zTPdfd7",
  4.     "users": [ "6d5a81d0" ]
  5. }

Parameters

ParameterDescriptionTypePresence
cDefines the command type.stringrequired
keyDefines the document identifier used to unambiguously identify the document file.stringrequired
usersDefines the list of the user identifiers.array of stringsoptional

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