---
title: "Create a custom field definition"
method: POST
path: "/v1/workspaces/{workspaceUuid}/custom-fields"
tags: ["Custom Fields"]
---

# Create a custom field definition

`POST /v1/workspaces/{workspaceUuid}/custom-fields`

## Path parameters

- `workspaceUuid` string, uuid, required

## Request body

- StoreCustomFieldRequest — Request body for creating a custom field definition
  - `name` string, required — The human-readable name of the field
  - `type` string, required — The data type of the field
  - `key` string, nullable — The machine-readable key. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Generated from the name when omitted.
  - `description` string, nullable
  - `field_rules` object[], nullable
    - `type` string, required — The rule type
    - `config` object, nullable
  - `options` object[], nullable
    - `key` string, required
    - `label` string, required
    - `color` string, nullable

## Response `201`

The created custom field definition

- CustomField — A custom field definition for organisations
  - `identifier` string — The unique identifier of the field
  - `key` string — The machine-readable key of the field
  - `name` string — The human-readable name of the field
  - `entity_type` string — The entity type the field belongs to
  - `type` string — The data type of the field
  - `description` string, nullable
  - `group` string — The group the field belongs to
  - `is_visible` boolean
  - `source` string — The source of the field
  - `rules` object[]
  - `is_system` boolean
  - `options` object[]

---

[API](https://skmtc.net/snitcher/apis/snitcher-api.md) · [All operations](https://skmtc.net/snitcher/apis/snitcher-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/snitcher/snitcher-api/versions/cb6fa68e7c8e/schema)