Replace a database's schema and views

PUT/v1/databases/{id}/definition

Applies a whole definition (what fromBase reads from a .base file): properties and views with a known id are updated, new ones created, live ones missing from it deleted. Row values are not touched.

docs:writeUndoableCannot be undone

Request

curl -X PUT "https://api.lydie.co/v1/databases/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/definition" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "definition": {
      "config": {},
      "properties": [
        {
          "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
          "name": "Notes",
          "type": "title",
          "key": "string"
        }
      ],
      "views": [
        {
          "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
          "name": "Notes",
          "type": "table",
          "config": {}
        }
      ]
    }
  }'

Path parameters

idULIDrequired

Body

definitionobjectrequired
Show 3 fieldsHide fields
- configDatabaseConfigInputrequired
  Show 3 fieldsHide fields
  filterFilterNodeor null
  Default null
  templateIdsULID[]
  Default []
  extraobject
  Default {}
- propertiesobject[]required
  Show 5 fieldsHide fields
  idULIDrequired
  namestringrequired· 1–200 chars
  typestringrequired
  One oftitletextnumberselectmultiSelectstatusdatecheckboxurlemailphonepersonfilesrelationrollupformulauniqueIdcreatedTimeupdatedTimecreatedByupdatedBy
  keystringrequired· 1–128 chars
  configPropertyConfigInput
  Default {}
  Show 11 fieldsHide fields
  optionsSelectOptionInput[]
  select, multiSelect, status
  Show 4 fieldsHide fields
  idULIDrequired
  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
- viewsobject[]required
  Show 4 fieldsHide fields
  idULIDrequired
  namestringrequired· 1–200 chars
  typestringrequired
  One oftableboardlistcalendargallery
  configViewConfigInputrequired
  Show 9 fieldsHide fields
  filterFilterNodeor null
  Default null
  sortsobject[]
  Default []
  Show 2 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  groupByGroupByInputor null
  Default null
  Show 6 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]
  hideEmptyboolean
  Hide groups with no rows (board columns).
  dateBucketstring
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]
  subGroupByGroupByInputor null
  Board swimlanes.
  Default null
  Show 6 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]
  hideEmptyboolean
  Hide groups with no rows (board columns).
  dateBucketstring
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]
  columnsViewColumnInput[]
  Default []
  Show 3 fieldsHide fields
  propertyIdULIDrequired
  visibleboolean
  Default true
  widthinteger· 20–2000
  limitintegeror null· ≥ 1
  Default null
  summariesobject
  propertyId → summary name
  Default {}
  layoutViewLayoutInput
  Default {}
  Show 11 fieldsHide fields
  rowHeightstring
  table
  One ofshortmediumtallextra
  wrapCellsboolean
  table
  cardSizeinteger· 50–1000
  board, gallery: px
  coverobjector null
  board, gallery: the card image
  coverFitstring
  One ofcovercontain
  coverAspectRationumber· 0.1–10
  markersstring
  list
  One ofbulletnumbernone
  calendarPropertyIdULID
  calendar: the date property placing rows
  calendarModestring
  One ofmonthweek
  showWeekendsboolean
  colorColumnsboolean
  board
  extraobject
  Default {}

Response

databaseDatabase
Show 8 fieldsHide fields
- idULID
- workspaceIdstring· 1–64 chars
- configDatabaseConfig
  Show 3 fieldsHide fields
  filterFilterNodeor null
  Default null
  templateIdsULID[]
  Default []
  extraobject
  Default {}
- createdAttimestamp
- updatedAttimestamp
- deletedAttimestampor null
- createdBystringor nulloptional· ≥ 1 chars
- updatedBystringor nulloptional· ≥ 1 chars
propertiesDatabaseProperty[]
Show 13 fieldsHide fields
- 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
viewsDatabaseView[]
Show 12 fieldsHide fields
- idULID
- workspaceIdstring· 1–64 chars
- databaseIdULID
- namestring· 1–200 chars
- typestring
  One oftableboardlistcalendargallery
- configViewConfig
  Show 9 fieldsHide fields
  filterFilterNodeor null
  Default null
  sortsobject[]
  Default []
  Show 2 fieldsHide fields
  propertyIdULID
  directionstring
  One ofascdesc
  Default "asc"
  groupByGroupByor null
  Default null
  Show 6 fieldsHide fields
  propertyIdULID
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]optional
  hideEmptybooleanoptional
  Hide groups with no rows (board columns).
  dateBucketstringoptional
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]optional
  subGroupByGroupByor null
  Board swimlanes.
  Default null
  Show 6 fieldsHide fields
  propertyIdULID
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]optional
  hideEmptybooleanoptional
  Hide groups with no rows (board columns).
  dateBucketstringoptional
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]optional
  columnsViewColumn[]
  Default []
  Show 3 fieldsHide fields
  propertyIdULID
  visibleboolean
  Default true
  widthintegeroptional· 20–2000
  limitintegeror null· ≥ 1
  Default null
  summariesobject
  propertyId → summary name
  Default {}
  layoutViewLayout
  Default {}
  Show 11 fieldsHide fields
  rowHeightstringoptional
  table
  One ofshortmediumtallextra
  wrapCellsbooleanoptional
  table
  cardSizeintegeroptional· 50–1000
  board, gallery: px
  coverobjector nulloptional
  board, gallery: the card image
  coverFitstringoptional
  One ofcovercontain
  coverAspectRationumberoptional· 0.1–10
  markersstringoptional
  list
  One ofbulletnumbernone
  calendarPropertyIdULIDoptional
  calendar: the date property placing rows
  calendarModestringoptional
  One ofmonthweek
  showWeekendsbooleanoptional
  colorColumnsbooleanoptional
  board
  extraobject
  Default {}
- sortKeystring· 1–256 chars
- createdAttimestamp
- updatedAttimestamp
- deletedAttimestampor null
- createdBystringor nulloptional· ≥ 1 chars
- updatedBystringor nulloptional· ≥ 1 chars

200

{
  "database": {
    "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
    "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
    "config": {
      "filter": null,
      "templateIds": [],
      "extra": {}
    },
    "createdAt": "2026-11-12T09:30:00.000Z",
    "updatedAt": "2026-11-12T09:30:00.000Z",
    "deletedAt": null,
    "createdBy": null,
    "updatedBy": null
  },
  "properties": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "name": "Notes",
      "type": "title",
      "key": "string",
      "config": {
        "options": [
          null
        ],
        "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
    }
  ],
  "views": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
      "databaseId": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "name": "Notes",
      "type": "table",
      "config": {
        "filter": null,
        "sorts": [],
        "groupBy": null,
        "subGroupBy": null,
        "columns": [],
        "limit": null,
        "summaries": {},
        "layout": {},
        "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.