Skip to main content
POST
Create a custom field

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new CustomField resource

tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string
fieldType
string
fieldOptions
(string | null)[] | null
position
integer | null
conditionedField
object | null
conditionedValue
string | null
isOnlyAdmin
boolean | null
default:false
visibility
string
default:public
isEncrypted
boolean
default:false
discriminator
string | null
default:profile
fileConfig
(string | null)[] | null
exampleMedia
string<iri-reference> | null
Example:

"/api/v1/media/1"

Response

CustomField resource created

id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string
fieldType
string
fieldOptions
(string | null)[] | null
position
integer | null
conditionedField
unknown
conditionedValue
string | null
isOnlyAdmin
boolean | null
default:false
visibility
string
default:public
isEncrypted
boolean
default:false
discriminator
string | null
default:profile
fileConfig
(string | null)[] | null
exampleMedia
object | null