Update a custom field definition

patch

https://api.katanamrp.com/v1/custom_field_definitions/{id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

label

string

length ≤ 255

description

string | null

options

object | null

Keys you omit keep their current value, so send only what you are changing. null clears the whole object (rejected on a singleSelect, which must always keep its choices).

choices is only meaningful when the field is a singleSelect, and is the exception to the merge rule: send the full array, every existing choice 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 are sent without an id.

Responses

200Custom field definition updated

401Make sure you've entered your API token correctly.

404Make sure data is correct

422Check the details property for a specific error message.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support