Create a new custom field definition

post/custom-field-definitions
SecuritybearerAuth
Request
Request Body schema: application/json

New custom field definition

label
required
string [ 1 .. 100 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Display label for the custom field

entityLevel
required
string (CustomFieldEntityLevel)

Indicates the entity level the custom field applies to

Enum: "USAGE_PRODUCT" "RENTAL_PRODUCT" "RENTAL_PRODUCT_INVENTORY" "SITE" "CUSTOMER"
Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

Request samples
application/json
{
  • "label": "Additional field definition label",
  • "entityLevel": "USAGE_PRODUCT"
}
Response samples
application/json
{
  • "id": 1,
  • "label": "Additional field definition label",
  • "entityLevel": "USAGE_PRODUCT"
}