Create Document

Create a new Document. Before using this route, you should create a new collection resource using either a server integration API or directly from your database console.

curl --location --request POST 'https://appwrite.io/v1/database/collections//documents' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": {}, "parentDocument": "string", "parentProperty": "string", "parentPropertyType": "string", "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.

Body Params application/json

data

object

required

Document data as JSON object.

parentDocument

string

optional

Parent document unique ID. Use when you want your new document to be a child of a parent document.

parentProperty

string

optional

Parent document property name. Use when you want your new document to be a child of a parent document.

parentPropertyType

string

optional

Parent document property connection type. You can set this value to assign, append or prepend, default value is assign. Use when you want your new document to be a child of a parent document.

read

array[string]

optional

An array of strings with read permissions. By default only the current user is granted with 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 only the current user is granted with 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