---
title: "Create custom property"
method: POST
path: "/v1/custom-properties"
tags: ["Custom properties"]
---

# Create custom property

`POST /v1/custom-properties`

Create a new custom property.

## Request body

- object
  - `name` string, required
  - `type` 'date' | 'boolean' | 'number' | 'text' | 'select' | 'multi_select', required
  - `slug` string, required
  - `entities` string[], required
  - `api_only` boolean, nullable
  - `required` boolean, nullable
  - `authorized_values` string[], nullable

## Response `201`

- CustomProperty
  - `id` string, required — Custom property ID.
  - `name` string, required — Custom property name.
  - `slug` string, required — Custom property unique slug.
  - `type` 'date' | 'boolean' | 'number' | 'text' | 'select' | 'multi_select', required — Custom property type.
  - `entities` string[], required — Entities on which the custom property is available.
  - `authorized_values` string[], nullable, required — If the custom property is of type `select` this is the list of available values.
  - `api_only` boolean — If true the custom property will not be displayed in the interface.
  - `required` boolean — If true the custom property must be filled for every configured entity.
  - `created_at` string, date-time, required — Creation date of the custom property.
  - `updated_at` string, date-time, required — Update date of the custom property.

---

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