Update Document

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

curl --location --request PATCH 'https://appwrite.io/v1/database/collections//documents/' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": {}, "read": [ "string" ], "write": [ "string" ] }'

Request

Path Params

collectionId

string

required

Collection unique ID. You can create a new collection with validation rules using the Database service server integration.

documentId

string

required

Document unique ID.

Body Params application/json

data

object

required

Document data as JSON object.

read

array[string]

optional

An array of strings with read permissions. By default inherits the existing read permissions. learn more about permissions and get a full list of available permissions.

write

array[string]

optional

An array of strings with write permissions. By default inherits the existing write permissions. learn more about permissions and get a full list of available permissions.

Examples

application/json

Body

Document

$collection

string

required

Collection ID.

$id

string

required

Document ID.

$permissions

object

required

Document permissions.

Additional properties

integer | number | string | boolean

optional

Request

Responses