Docmost Octri Preview
POST/bases/properties/update

Update a base property

Updates an existing property on a base, including its name, type, or type-specific options. Supply pageId and propertyId, and include any fields you want to change; system property types cannot be assigned through type. Changing type converts existing cell values, and large conversions may run asynchronously with a jobId while the property has a pendingType.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

The base property to update. Supply pageId and propertyId, then include any fields to change.

namestringoptional
The new name for the property.
pageIdstringrequired
Id of the base. A base *is* a page, so this is the base's page id - the same id you would pass to the page endpoints.
propertyIdstringrequired
The property's identifier, matching `^prp[0-9a-z]{9}$`.
typestringoptional
System types (`createdAt`, `lastEditedAt`, `lastEditedBy`, `formula`) cannot be assigned here.
Allowed:textnumberselectstatusmultiSelectdatepersonfilepagecheckboxurlemail
typeOptionsobjectoptional
Configuration for a property, keyed off the property's `type`. Unknown keys are preserved rather than rejected. | type | schema | | --- | --- | | `text` | TextTypeOptions | | `longText` | LongTextTypeOptions | | `number` | NumberTypeOptions | | `date` | DateTypeOptions | | `checkbox` | CheckboxTypeOptions | | `url` | UrlTypeOptions | | `email` | EmailTypeOptions | | `select`, `status`, `multiSelect` | SelectTypeOptions | | `person` | PersonTypeOptions | | `formula` | FormulaTypeOptions | | `file`, `page`, `createdAt`, `lastEditedAt`, `lastEditedBy` | EmptyTypeOptions |

5 status codes
200Returns the updated property. For a large type conversion, the response includes a `jobId` and the property has a `pendingType` until the conversion finishes.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the request fails validation, including when `propertyId` has an invalid format or `type` is a system type.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when modifying the base is forbidden or bases are not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the base is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
503Returned when the type-conversion queue is unavailable; the property update is rolled back.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the request fails validation, including when propertyId does not match the required pattern or type is a system type. A 403 is returned when the authenticated user is forbidden from modifying the base or bases are not included in the current licence. A 404 is returned when the base is not found. A 503 is returned when the type-conversion queue is unavailable, and the property update is rolled back. pageId must be a UUID, and propertyId must match ^prp[0-9a-z]{9}$; changing type converts existing cell values.