Objects
Update object
This endpoint updates an existing object in the specified space using a JSON payload. The update process is subject to rate limiting. The payload must include the details to be updated. The endpoint then returns the full object data, ready for further interactions.
patch/v1/spaces/{space_id}/objects/{object_id}
Path parameters
space_idstring required
The ID of the space in which the object exists; must be retrieved from ListSpaces endpoint
object_idstring required
The ID of the object to update; must be retrieved from ListObjects, SearchSpace or GlobalSearch endpoints or obtained from response context
Headers
Anytype-Versionstring required
The version of the API to use
Request body
Example request
{
"icon": {
"emoji": "📄"
},
"markdown": "This is the updated body of the object. Markdown syntax is supported here.",
"name": "My object",
"properties": [
{
"key": "description",
"text": "Some text..."
}
],
"type_key": "page"
}Response
The updated object
Example response
{
"object": {
"icon": {
"emoji": "📄"
},
"id": "bafyreie6n5l5nkbjal37su54cha4coy7qzuhrnajluzv5qd5jvtsrxkequ",
"layout": "basic",
"markdown": "# This is the title\n...",
"name": "My object",
"object": "object",
"properties": [
{
"id": "bafyreids36kpw5ppuwm3ce2p4ezb3ab7cihhkq6yfbwzwpp4mln7rcgw7a",
"key": "description",
"name": "Description",
"object": "property",
"text": "Some text..."
}
],
"snippet": "The beginning of the object body...",
"space_id": "bafyreigyfkt6rbv24sbv5aq2hko3bhmv5xxlf22b4bypdu6j7hnphm3psq.23me69r569oi1",
"type": {
"icon": {
"emoji": "📄"
},
"id": "bafyreigyb6l5szohs32ts26ku2j42yd65e6hqy2u3gtzgdwqv6hzftsetu",
"key": "page",
"name": "Page",
"object": "type",
"plural_name": "Pages",
"properties": [
{
"id": "bafyreids36kpw5ppuwm3ce2p4ezb3ab7cihhkq6yfbwzwpp4mln7rcgw7a",
"key": "last_modified_date",
"name": "Last modified date",
"object": "property"
}
]
}
}
}