Add or remove enum field values

Adds or removes options on enum (single- and multi-select) fields for one object type. The request carries exactly one item in `data`; each field in `meta` names an `append` or `remove` operation. To modify several object types, send separate requests.

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*array<>

A single-element array holding the enum-field patch to apply.

Response Body

`application/json`

curl -X PATCH "https://example.com/workspaces/string/schemas" \  -H "Content-Type: application/json" \  -d '{    "data": [      {        "type": "schema-properties",        "id": "https://getclarify.ai/schemas/entities/c_project",        "attributes": {          "status": {            "enum": [              "Planning",              "In progress",              "Complete",              "On hold"            ],            "xClarifyEnumMetadata": {              "Planning": {                "id": "planning",                "rank": 0,                "color": "blue"              },              "In progress": {                "id": "in_progress",                "rank": 1,                "color": "amber"              },              "Complete": {                "id": "complete",                "rank": 2,                "color": "green"              },              "On hold": {                "id": "on_hold",                "rank": 3,                "color": "red"              }            }          }        },        "meta": {          "status": {            "enum": "append"          }        }      }    ]  }'

{
  "data": [
    {
      "id": "https://getclarify.ai/schemas/entities/c_project",
      "type": "schema-validation-result",
      "attributes": {
        "isValid": true
      }
    }
  ]
}