Disable a custom property
DELETE/custom-properties/:id
Disables the property: it leaves the forms and the API's custom_properties blocks, but
nothing is deleted — every object keeps its value, and PUT with enabled: true brings
it back. Properties are never deleted through the API, because deleting one deletes its
values on every object. Answers the property, now enabled: false. Administrators only.
Since 4.3.1.
Request
Responses
- 200
- 401
- 403
- 404
The disabled property
Missing, invalid or expired token, or no contact matches it.
Authenticated, but not allowed.
Unknown route, or the resource is missing or in the trash; message names what was
looked for (task, note, payment_receipt, expense…). On an expenses route,
message: "expenses" means the plugin is not active.