---
title: "Create Custom Field"
method: POST
path: "/custom_field"
tags: ["Custom Field"]
---

# Create Custom Field

`POST /custom_field`

Create a new custom field

## Query parameters

- `select` string

## Request body

- CustomField
  - `id` string, uuid — Custom field ID
  - `created_at` string, timestamp with time zone — Custom field creation date
  - `updated_at` string, timestamp with time zone — Latest update
  - `organisation_id` string, uuid, nullable — Organisation ID
  - `name` string, text — Name of custom field
  - `description` string, text, nullable — Custom field description
  - `type` 'string' | 'datetime' | 'boolean' | 'number' | 'date' | 'string_list', public.field_type — Typ of custom field
  - `key` string, text — Custom field key
  - `entity` 'contact' | 'deal' | 'appointment', public.custom_field_entity

## Response `200`

The updated Custom Field object

- CustomField
  - `id` string, uuid — Custom field ID
  - `created_at` string, timestamp with time zone — Custom field creation date
  - `updated_at` string, timestamp with time zone — Latest update
  - `organisation_id` string, uuid, nullable — Organisation ID
  - `name` string, text — Name of custom field
  - `description` string, text, nullable — Custom field description
  - `type` 'string' | 'datetime' | 'boolean' | 'number' | 'date' | 'string_list', public.field_type — Typ of custom field
  - `key` string, text — Custom field key
  - `entity` 'contact' | 'deal' | 'appointment', public.custom_field_entity

## Other responses

- `201` — The Custom Field was created
- `204` — No Content

---

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