---
title: "Update custom schema"
method: PATCH
path: "/api/custom-schemas/v1/{schema_id}"
tags: ["v1"]
---

# Update custom schema

`PATCH /api/custom-schemas/v1/{schema_id}`

Update the name, description, or keys on a preexisting schema.

## Path parameters

- `schema_id` string, uuid, required

## Headers

- `Authorization` string, required

## Request body

- object
  - `name` string
  - `description` string
  - `fields_to_add` V1SchemaField[] — A list of typed entries to add to schema. Only additive modifications are permitted. — unresolved $ref

## Response `200`

Response with status 200

- V1Schema — unresolved $ref

## Other responses

- `403` — Error response with status 403
- `404` — Error response with status 404
- `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)