Skip to main content

ArchiveCustomFieldDefinition sets `is_active = false` on a field.

POST 
/api/v1/crm/custom-fields/:id:archive

Archived fields are hidden from forms but existing stored values are preserved. Archived definitions are excluded from ListCustomFieldDefinitions unless include_archived = true.

Errors:

  • NOT_FOUND: definition does not exist.

Request​

Responses​

A successful response.