---
title: "Update a field assignment on an entity kind"
method: PATCH
path: "/api/rest/v1/kind-field-assignments/{kindId}/{fieldId}"
tags: ["Kind Field Assignments"]
---

# Update a field assignment on an entity kind

`PATCH /api/rest/v1/kind-field-assignments/{kindId}/{fieldId}`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/kind-field-assignments/{kindId}/{fieldId}`
- Auth: none required

JSON merge patch: only the properties present in the body change. An explicit `null`
`category` clears it.

## Path parameters

- `kindId` string, uuid, required
- `fieldId` string, uuid, required

## Request body

- object: Partial update (JSON merge patch) body for a kind–field assignment. Documents the body schema only — the endpoint binds the raw JSON so it can tell an omitted property (left unchanged) from an explicit `null` (cleared).
  - `required` boolean, nullable: Whether entities of the kind must supply a value for the field when created.
  - `displayOrder` union: Position in the kind's field list; lower values come first.
    - integer
    - string, int32
  - `category` string, nullable: Grouping category for the field on this kind (max 250 characters). `null` clears it.

## Response `200`

OK

- RestApiResponseOfKindFieldAssignmentItem: Standard REST API response envelope for a single resource.
  - `data` KindFieldAssignmentItem, required: A field definition assigned to an entity kind.
    - `kindId` string, uuid, required: ID of the entity kind definition.
    - `fieldId` string, uuid, required: ID of the assigned field definition (see `/entity-field-definitions`).
    - `fieldKey` string, required: Key of the assigned field definition — the key its values use in an entity's `fieldValues`.
    - `required` boolean, required: Whether entities of the kind must supply a value for the field when created.
    - `displayOrder` union, required: Position in the kind's field list; lower values come first.
      - integer
      - string, int32
    - `category` string, nullable, required: Grouping category for the field on this kind. Null when not set.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `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)