Sign in

v1

latestOpenAPI 3.0.02026-07-26392662.9 KB
Custom Fields

Create a custom field definition

post/v1/workspaces/{workspaceUuid}/custom-fields

Path parameters

workspaceUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the workspace

Request body

namestring required

The human-readable name of the field

typestring required

The data type of the field

keystring 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.

descriptionstring nullable

Example request

{
  "name": "Industry",
  "type": "text",
  "key": "industry",
  "description": "The primary industry of the company.",
  "options": [
    {
      "key": "technology",
      "label": "Technology",
      "color": "#FF0000"
    }
  ]
}

Response

The created custom field definition

identifierstring

The unique identifier of the field

keystring

The machine-readable key of the field

namestring

The human-readable name of the field

entity_typestring

The entity type the field belongs to

typestring

The data type of the field

descriptionstring nullable
groupstring

The group the field belongs to

is_visibleboolean
sourcestring

The source of the field

rulesobject[]
is_systemboolean
optionsobject[]

Example response

{
  "identifier": "industry",
  "key": "industry",
  "name": "Industry",
  "entity_type": "organisation",
  "type": "text",
  "description": "The primary industry of the company.",
  "group": "custom",
  "is_visible": true,
  "source": "manual"
}