Skip to main content

Create a custom field

Create a custom field.

Parameters​

color
string
Color of the custom field, in hexadecimal format (e.g., #FF00FF).
name
string
required
Name of the custom field.
options
object
Options of the custom field.
options.values
array (required if type is list/multi_list)
The options for the list/multi_list custom field.
options.values.*.color
string
required
Color of the option, in hexadecimal format (e.g., #FF00FF).
options.values.*.value
string
required
Value of the option.
options.number_format
enum (required if type is number)
Number format of the custom field. One of plain, separated, percentage, currency.
options.currency
enum (required if number format is currency)
Currency of the custom field.
show_icon
boolean
Whether to show the icon in the UI.
type
enum
required
Type of the custom field. One of text, number, list, multi_list, date, boolean, url, email, phone.
visible_to_clients
boolean
Whether custom field is visible to clients.

Returns​

Returns the created custom field object. Throws an error if some parameters are not valid.

post
/api/boards/{id}/custom-fields
curl -X POST https://{workspace}.kitchen.co/api/boards/{id}/custom-fields \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "id": "cf_b5fa830bd5d732626231ff89",
  "name": "Options",
  "type": "multi_list",
  "options": {
    "values": [
      {
        "id": "uL3haLfAeE258Lt6E8sjtyqg",
        "color": "#fec30c",
        "value": "Design"
      },
      {
        "id": "XN8Lb7veiE6w7qrEFuHMstnS",
        "color": "#8b7252",
        "value": "Development"
      }
    ],
    "number_format": null,
    "currency": null
  },
  "visible_to_clients": false,
  "show_icon": true,
  "color": null,
  "created_at": "2025-06-16T11:58:26+00:00",
  "updated_at": "2025-06-16T11:58:31+00:00"
}