---
title: "Create a custom schema"
method: POST
path: "/api/custom-schemas/v1"
tags: ["v1"]
---

# Create a custom schema

`POST /api/custom-schemas/v1`

Create custom schema with a set of typed keys. Schema keys can be referenced as inputs in user-configurable rules in the Rules
Engine, and key-value pairs can be attached to claims via the Encounters API.

## Headers

- `Authorization` string, required

## Request body

- object
  - `name` string, required
  - `description` string
  - `fields` V1SchemaField[], required — unresolved $ref

## Response `200`

Response with status 200

- V1Schema — unresolved $ref

## Other responses

- `422` — Error response with status 422

---

[API](https://skmtc.net/joincandidhealth/apis/api-reference.md) · [All operations](https://skmtc.net/joincandidhealth/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/joincandidhealth/api-reference/revisions/7cc5974e4128/schema)
