---
title: "POST /custom_fields"
method: POST
path: "/custom_fields"
tags: ["custom_fields"]
---

# POST /custom_fields

`POST /custom_fields`

Create a custom field

## Request body

- PostCustomFields — Create a custom field
  - `custom_field_group_id` integer, required
  - `name` string, required
  - `pretty_name` string
  - `field_type` 'String' | 'Text' | 'Dropdown' | 'Multiselect' | 'Boolean' | 'Number' | 'Date' | 'DateTime' | 'CountrySelect' | 'CountrySelect' | 'Broker' | 'Tags' | 'TagsByCategory'
  - `entity` 'for_clients' | 'for_properties' | 'for_projects' | 'for_brokers' | 'for_tasks' | 'for_deals'
  - `unit` string
  - `export_to_openimmo` boolean
  - `use_in_search_profile` boolean
  - `formula` string
  - `bequest` boolean

## Response `201`

Create a custom field

- CustomFieldEntity — CustomFieldEntity model
  - `id` integer
  - `custom_field_group_id` integer
  - `name` string
  - `pretty_name` string
  - `field_type` string
  - `entity` integer
  - `unit` string
  - `export_to_openimmo` boolean
  - `use_in_search_profile` boolean
  - `formula` string
  - `bequest` boolean
  - `custom_options` CustomOptionEntity[]
    - `id` integer
    - `name` string

## Other responses

- `400` — validation_error
- `401` — authentication_error
- `403` — authorization_error
- `404` — not_found_error
- `422` — validation_error
- `500` — internal_server_error

---

[API](https://skmtc.net/propstack/apis/propstack-api-v2-beta.md) · [All operations](https://skmtc.net/propstack/apis/propstack-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/propstack/propstack-api-v2-beta/revisions/ae1e0fe6da1a/schema)