Sign in

v1

latestOpenAPI 3.1.0Any Source Available License 1.02026-07-1736102200.0 KB
Properties

Update property

This endpoint updates an existing property in the specified space using a JSON payload. The update process is subject to rate limiting. The payload must include the name to be updated. The endpoint then returns the full property data, ready for further interactions.

patch/v1/spaces/{space_id}/properties/{property_id}

Path parameters

space_idstring required

The ID of the space to which the property belongs; must be retrieved from ListSpaces endpoint

property_idstring required

The ID of the property to update; must be retrieved from ListProperties endpoint or obtained from response context

Headers

Anytype-Versionstring required

The version of the API to use

Request body

keystring

The key to set for the property; ; should always be snake_case, otherwise it will be converted to snake_case

namestring required

The name to set for the property

Example request

{
  "key": "some_user_defined_property_key",
  "name": "Last modified date"
}

Response

The updated property

Example response

{
  "property": {
    "id": "bafyreids36kpw5ppuwm3ce2p4ezb3ab7cihhkq6yfbwzwpp4mln7rcgw7a",
    "key": "last_modified_date",
    "name": "Last modified date",
    "object": "property"
  }
}