API Reference
Knowledge Base

Update a custom field definition

patch
https://api.katanamrp.com/v1/custom_field_definitions/

Updates the label, description, or options of a custom field definition. Other properties (field_type, entity_type, source) are immutable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Custom field definition id (UUID).

Body Params

Custom field definition fields to update

Only label, description, and options may be updated. field_type, entity_type, and source are immutable.

string
length ≤ 255
string | null
options
object | null

Only meaningful when the field is a singleSelect. Send the full choices array — every existing choice must be included and identified by its server-assigned id. Omit a choice and it is removed from history (use deleted: true instead to soft-delete it and keep historical values resolvable). New choices in the array are created without an id.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago

Did this page help you?