API Reference
Knowledge Base

Create a custom field definition

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

Creates a new custom field definition for a given entity type. A factory may have at most 50 definitions.

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

New custom field definition details

string
required
length ≤ 255

Human-readable label of the custom field.

string
enum
required

Type of value the field stores. Immutable after creation.

  • shortText — string
  • number — number
  • singleSelect — integer choice id (requires options.choices)
  • date — YYYY-MM-DD string
  • boolean — true / false
  • url — string
Allowed:
string
enum
required

Entity the custom field applies to. Immutable after creation.

Allowed:
string
required
length ≤ 255

Caller-provided identifier of the integration that owns the field — for example your application slug. Used to namespace and audit field definitions.

string | null

Optional free-text description shown alongside the field in Katana.

options
object | null

Only meaningful when field_type is singleSelect. Omit (or send null) for other types.

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?