---
title: "Create a custom field for customers"
method: POST
path: "/v2/customers/custom-fields"
tags: ["Custom Fields"]
---

# Create a custom field for customers

`POST /v2/customers/custom-fields`

Create a new custom field to be used in the customer schema.


You need the "Manage customer custom fields" permission to use this endpoint.

## Request body

- CustomerManagerCreateCustomFieldRequest
  - `customer_type` 'PERSON' | 'COMPANY' | 'UNDEFINED', required
  - `data_type` 'TEXT' | 'INTEGER' | 'DECIMAL' | 'DATE' | 'DATETIME', required — The type of data stored in a custom field.
  - `display_name` string, required
  - `key` string, required

## Response `201`

Custom field created successfully.

- CustomerManagerCustomField — List of custom fields.
  - `customer_type` 'PERSON' | 'COMPANY', required
  - `data_type` 'TEXT' | 'INTEGER' | 'DECIMAL' | 'DATE' | 'DATETIME', required — The type of data stored in a custom field.
  - `display_name` string, required
  - `identifier` string, uuid, required
  - `key` string, required

## Other responses

- `400` — Bad Request.
- `403` — Forbidden.
- `404` — Not Found

---

[API](https://skmtc.dev/complyadvantage/apis/mesh-api.md) · [All operations](https://skmtc.dev/complyadvantage/apis/mesh-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/complyadvantage/mesh-api/revisions/fdaac4351d85/schema)
