Update Document

v1.0.0

Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

Input

{
  "type": "object",
  "properties": {
    "collectionId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "description": "Document data as JSON object."
    },
    "documentId": {
      "type": "string"
    },
    "read": {
      "type": "array",
      "description": "An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.",
      "items": {
        "type": "string"
      }
    },
    "write": {
      "type": "array",
      "description": "An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "collectionId",
    "data",
    "documentId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Document",
  "required": [
    "$collection",
    "$id",
    "$permissions"
  ],
  "properties": {
    "$collection": {
      "type": "string",
      "description": "Collection ID."
    },
    "$id": {
      "type": "string",
      "description": "Document ID."
    },
    "$permissions": {
      "type": "object",
      "description": "Document permissions.",
      "items": {
        "type": "object",
        "description": "Permissions",
        "required": [
          "read",
          "write"
        ],
        "properties": {
          "read": {
            "type": "array",
            "description": "Read permissions.",
            "items": {
              "type": "string"
            }
          },
          "write": {
            "type": "array",
            "description": "Write permissions.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}