Create a custom field

POST /api/custom-fields

Required permissions:

settings.company: allows creating custom field resources.

warning

Requires "Custom Fields" feature to be enabled.

Request

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

application/json

Body

name stringrequired

Possible values: <= 30 characters

The custom field name

description string

The custom field description

type stringrequired

Possible values: [single_option]

The custom field type

domain stringrequired

Possible values: [project_plan]

The domain the custom field is bound to

required boolean

Whether a value is required for this custom field

sort integer

The sort position of the custom field

Responses

Returns the custom field created.

application/json

Schema
Example (from schema)

Schema

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

Possible values: <= 255 characters

The custom field name

description string

The custom field description

type stringrequired

The custom field type

domain stringrequired

The domain the custom field is bound to

required booleanrequired

Whether a value is required for this custom field

sort integerrequired

The sort position of the custom field

options

object[]

The list of options of this custom field. Only available when type is single_option, status or multi_select.

Array [

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

Possible values: <= 255 characters

The custom field option name

color string

The hex color code of the option

sort integerrequired

The sort position of the option

custom_field_id integerrequired

The id of the custom field this option belongs to

deleted_at date-time

The date and time when the resource was deleted

]

archived_at date-time

The date and time when the resource was archived

deleted_at date-time

The date and time when the resource was deleted

{
  "id": 1,
  "created_at": "2026-06-12T11:36:10.254Z",
  "updated_at": "2026-06-12T11:36:10.254Z",
  "name": "Priority",
  "description": "The task priority",
  "type": "single_option",
  "domain": "project_plan",
  "required": false,
  "sort": 1,
  "options": [
    {
      "id": 1,
      "created_at": "2026-06-12T11:36:10.254Z",
      "updated_at": "2026-06-12T11:36:10.254Z",
      "name": "High",
      "color": "#224455",
      "sort": 1,
      "custom_field_id": 1,
      "deleted_at": "2026-06-12T11:36:10.254Z"
    }
  ],
  "archived_at": "2026-06-12T11:36:10.254Z",
  "deleted_at": "2026-06-12T11:36:10.254Z"
}

Validation failed

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

Precondition failed

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "precondition_failure",
  "message": "string"
}

Create a custom field

/api/custom-fields

Request​

Header Parameters

Body

Responses​

Request

Responses