Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Create Custom Field

Create a custom field.

Category fields (CATEGORY, CATEGORIES) need value_range_type_id, the category type whose categories become the field’s options.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired<=255 characters
displaynamestringRequired<=255 characters
typestringRequired
locationintegerOptionalDefaults to 0
isconceptlevelbooleanOptionalDefaults to false
ismultilinebooleanOptionalDefaults to false
isnullablebooleanOptionalDefaults to true
value_range_type_idstring or nullOptionalformat: "uuid"

Response

Successful Response
field_idstringformat: "uuid"
field_uuidstring
namestring
displaynamestring
typestring
isconceptlevelboolean
ismultilineboolean
isnullableboolean
locationinteger
value_range_type_idstring or nullOptionalformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error