Sign in
Dataset Management

Deleting a Property

(introduced: version 2026.1)

Deletes a published Property from a Dataset. The deletion is permanent, but a new property with the same name can easily be re-added.

A Property cannot be deleted if either of the following is true:

  • Any published or draft Forms are currently writing to it (i.e. they have a save_to mapping to this Property). Those Forms must be updated or deleted first.
  • Any Entities have a non-empty value for it. Those Entity values must be cleared first by updating each Entity to have an empty string for that Property.

If deletion is blocked, the 409 response includes a details.prerequisites object describing what needs to be resolved. For blocked Forms, it includes a list of the dependent Form IDs and names. For blocked Entities, it includes a totalCount and up to 3 example Entity UUIDs and labels.

A Form that reads a Dataset Property via an attachment may break after deleting the Property, so check any Forms that consume this Dataset as well.

delete/v1/projects/{projectId}/datasets/{name}/properties/{propertyName}

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

propertyNamestring required

The name of the Property to delete

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes

Changed in 2 of the 55 revisions of this API.11