KOkobaltlabs
custom_fields

Set Custom Field Archived

Changed on

Retire a custom field, or bring a retired one back.

Deleting a field in use means clearing it off every record first, which throws the data away. Archiving keeps the definition and every value it holds — the field just stops being offered anywhere (editors, filters, exports, the trigger builder) until it's restored.

put/custom_fields/by-id/{custom_field_id}/archive

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/custom_fields/by-id/{custom_field_id}/archive
  • Auth
    none declared

Path parameters

custom_field_idstring uuid required

Request body

archivedboolean required

Response

Successful Response

OR
OR
OR
OR
OR
OR
OR

Changes