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. Removing an option also clears it from every record that holds it, and the response returns once the records are updated. To modify several object types, send separate requests.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
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 } } ]}List object schemas
Returns every object schema in the workspace as a cursor-paginated list of JSON:API resources. Each resource holds the full JSON Schema for one object type, including its fields, relationships, and presentation metadata.
Replace an object schema
Replaces the full JSON Schema for an object type with the request body, whose `$id` must match the object in the path. Only Text and Multiline text, or Number and Currency convert into each other. Any other field type change, or adding or removing a number field's tier bands, is rejected with a 422. A read-only object, such as the Lead Finder people and companies, rejects any change with a 422. The change is applied asynchronously: the response returns a task you can poll to track progress.