---
title: "Create custom field"
method: POST
path: "/custom_fields"
tags: ["Custom Fields"]
---

# Create custom field

`POST /custom_fields`

Create a custom field to categorize your objects in Numeral.

## Request body

- CustomFieldCreation
  - `key` string, required — The key of the custom field. Must be unique and `snake_case`.
  - `name` string, required — The name of the custom field, which is an understandable description of the data it holds.
  - `type` 'select' | 'text', required — The type of the custom field. Can be either `select` or `text`.
  - `object_types` string[], required — The types of object this custom field can be applied to. Can be a combination of `payment_order`, `expected_payment`, `transaction`, `direct_debit_mandate`, `internal_account`, `external_account` and `connected_account`.
  - `values` CustomFieldValuesCreation[] — List of values the custom field can take. Only applicable to custom fields with `select` type.
    - `key` string, required — The key of the value. Must be unique in the custom field and `snake_case`.
    - `name` string, required — The name of the value.

## Response `200`

200

- CustomFieldDetails
  - `key` string, required — The key of the custom field.
  - `name` string, required — The name of the custom field.
  - `type` 'select' | 'text', required — The type of the custom field.
  - `object_types` string[], required — The types of object this custom field can be applied to.
  - `values` CustomFieldValuesCreation[], required — List of values the custom field can take. Only applicable to custom fields with `select` type.
    - `key` string, required — The key of the value. Must be unique in the custom field and `snake_case`.
    - `name` string, required — The name of the value.
  - `created_at` string, date-time, required — The UTC timestamp of the creation of the custom field.

## Other responses

- `400` — Validation error.
- `409` — Conflict.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)