Skip to main content
POST
Create TB custom field

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

DTO for creating a new term base custom field

fieldName
string
required

Name of the custom field

Required string length: 1 - 100
Example:

"Usage notes"

level
enum<string>
required

Level of the custom field

Available options:
TERM,
CONCEPT
Example:

"TERM"

type
enum<string>
required

Type of the custom field

Available options:
STRING,
NUMBER,
DATE,
BOOLEAN,
SINGLE_SELECT,
MULTI_SELECT,
URL
Example:

"SINGLE_SELECT"

values
string[]

Possible values for select type fields. Required for type SINGLE_SELECT and MULTI_SELECT. Each value must be not blank and less then 100 characters length

Maximum array length: 100

Response

successful operation

DTO representing a term base custom field

fieldName
string

Name of the custom field

id
string

Unique identifier of the custom field

level
enum<string>

Level of the custom field

Available options:
TERM,
CONCEPT
Example:

"TERM"

type
enum<string>

Type of the custom field

Available options:
STRING,
NUMBER,
DATE,
BOOLEAN,
SINGLE_SELECT,
MULTI_SELECT,
URL
Example:

"SINGLE_SELECT"

values
string[]

List of possible values for select type fields