Add a database property

POST/v1/databases/{databaseId}/properties

Adds a property. key defaults to the name (the frontmatter key in a folder). A two-way relation also adds the synced property on the related database (config.relation.reversePropertyId is its id). A uniqueId (config.prefix, e.g. LYD) numbers the existing rows in creation order; its key may not be "id".

docs:writeUndoable

Request

curl -X POST "https://api.lydie.co/v1/databases/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/properties" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Notes",
    "type": "title"
  }'

Path parameters

databaseIdULIDrequired

Body

idULID
namestringrequired· 1–200 chars
typestringrequired
One oftitletextnumberselectmultiSelectstatusdatecheckboxurlemailphonepersonfilesrelationrollupformulauniqueIdcreatedTimeupdatedTimecreatedByupdatedBy
keystring· 1–128 chars
configPropertyConfigSpecInput
Default {}
Show 11 fieldsHide fields
- optionsobject[]
  select, multiSelect, status
  Show 4 fieldsHide fields
  idULID
  namestringrequired· 1–200 chars
  colorstring
  One ofdefaultgraybrownorangeyellowgreenbluepurplepinkred
  Default "default"
  groupstring
  One oftodoinProgresscomplete
- numberFormatstring
  One ofnumberintegercommaspercentcurrency
- decimalsinteger· 0–10
- currencystring· 3–3 chars
  ISO 4217 code, with numberFormat currency
- includeTimeboolean
  date: values carry a time
- rangeboolean
  date: values may carry an end (start/end)
- relationRelationConfigInput
  Show 4 fieldsHide fields
  databaseIdULIDrequired
  The database whose rows this relation points at.
  twoWayboolean
  Default false
  reversePropertyIdULIDor null
  The synced property on the other database (two-way relations).
  Default null
  limitstring
  One ofonemany
  Default "many"
- rollupRollupConfigInput
  Show 3 fieldsHide fields
  relationPropertyIdULIDrequired
  targetPropertyIdULIDrequired
  A property of the related database.
  functionstringrequired
  One ofshowOriginalshowUniquecountcountValuescountUniquecountEmptycountNotEmptypercentEmptypercentNotEmptysumaveragemedianminmaxrangeearliestlatestcheckeduncheckedpercentCheckedpercentUnchecked
- expressionstring
  formula: an Obsidian Bases expression
- prefixstring· ≤ 16 chars
  uniqueId: shown before the number ("LYD" → LYD-12)
- extraobject
reverseNamestring· 1–200 chars
Two-way relations.
afterIdULID
Place directly after this sibling.
beforeIdULID
Place directly before this sibling.
sortKeystring· 1–256 chars
Explicit fractional key (recorded so replays converge).

Response

idULID
workspaceIdstring· 1–64 chars
databaseIdULID
namestring· 1–200 chars
Display name (Bases displayName).
typestring
One oftitletextnumberselectmultiSelectstatusdatecheckboxurlemailphonepersonfilesrelationrollupformulauniqueIdcreatedTimeupdatedTimecreatedByupdatedBy
keystring· 1–128 chars
Stored types: the frontmatter key holding the value. Formulas, rollups, createdBy and updatedBy: the formula name in the .base file. Unused for title and created/updated time.
configPropertyConfig
Show 11 fieldsHide fields
- optionsSelectOption[]optional
  select, multiSelect, status
  Show 4 fieldsHide fields
  idULID
  namestring· 1–200 chars
  colorstring
  One ofdefaultgraybrownorangeyellowgreenbluepurplepinkred
  Default "default"
  groupstringoptional
  One oftodoinProgresscomplete
- numberFormatstringoptional
  One ofnumberintegercommaspercentcurrency
- decimalsintegeroptional· 0–10
- currencystringoptional· 3–3 chars
  ISO 4217 code, with numberFormat currency
- includeTimebooleanoptional
  date: values carry a time
- rangebooleanoptional
  date: values may carry an end (start/end)
- relationRelationConfigoptional
  Show 4 fieldsHide fields
  databaseIdULID
  The database whose rows this relation points at.
  twoWayboolean
  Default false
  reversePropertyIdULIDor null
  The synced property on the other database (two-way relations).
  Default null
  limitstring
  One ofonemany
  Default "many"
- rollupRollupConfigoptional
  Show 3 fieldsHide fields
  relationPropertyIdULID
  targetPropertyIdULID
  A property of the related database.
  functionstring
  One ofshowOriginalshowUniquecountcountValuescountUniquecountEmptycountNotEmptypercentEmptypercentNotEmptysumaveragemedianminmaxrangeearliestlatestcheckeduncheckedpercentCheckedpercentUnchecked
- expressionstringoptional
  formula: an Obsidian Bases expression
- prefixstringoptional· ≤ 16 chars
  uniqueId: shown before the number ("LYD" → LYD-12)
- extraobjectoptional
sortKeystring· 1–256 chars
createdAttimestamp
updatedAttimestamp
deletedAttimestampor null
createdBystringor nulloptional· ≥ 1 chars
updatedBystringor nulloptional· ≥ 1 chars

200

{
  "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
  "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
  "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
  "name": "Notes",
  "type": "title",
  "key": "string",
  "config": {
    "options": [
      {
        "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
        "name": "Notes",
        "color": "default",
        "group": "todo"
      }
    ],
    "numberFormat": "number",
    "decimals": 0,
    "currency": "string",
    "includeTime": false,
    "range": false,
    "relation": {
      "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "twoWay": false,
      "reversePropertyId": null,
      "limit": "one"
    },
    "rollup": {
      "relationPropertyId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "targetPropertyId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "function": "showOriginal"
    },
    "expression": "string",
    "prefix": "string",
    "extra": {}
  },
  "sortKey": "a0",
  "createdAt": "2026-11-12T09:30:00.000Z",
  "updatedAt": "2026-11-12T09:30:00.000Z",
  "deletedAt": null,
  "createdBy": null,
  "updatedBy": null
}

Errors use one envelope for every endpoint. See Errors and versions.