---
title: "Create a new entity field definition"
method: POST
path: "/api/rest/v1/entity-field-definitions"
tags: ["Entity Field Definitions"]
---

# Create a new entity field definition

`POST /api/rest/v1/entity-field-definitions`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/entity-field-definitions`
- Auth: none required

## Request body

- CreateEntityFieldDefinitionRequest: Create entity field definition request body.
  - `key` string, required
  - `displayName` string, required
  - `description` string, nullable
  - `fieldType` string
  - `category` string
  - `options` string, nullable
  - `defaultValue` string, nullable
  - `isSearchable` boolean

## Response `201`

Created

- RestApiResponseOfEntityFieldDefinitionDetail: Standard REST API response envelope for a single resource.
  - `data` EntityFieldDefinitionDetail, required: Entity field definition detail view -- full fields for single-resource responses.
    - `id` string, uuid, required
    - `key` string, required
    - `displayName` string, required
    - `description` string, nullable, required
    - `fieldType` string, required
    - `category` string, required
    - `options` string, nullable, required
    - `defaultValue` string, nullable, required
    - `isSearchable` boolean, required
    - `schemaVersion` union, required
      - integer
      - string, int32
    - `schemaChangedAt` string, date-time, nullable, required
    - `organizationId` string, uuid, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `429`: Too Many Requests

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)