Clarify API
Schemas

Reorder object fields

Sets the display order of an object type’s fields. The `order` array lists every field name in the desired order. The change is applied asynchronously and the response body is empty.

PATCH
/workspaces/{workspace}/schemas/{entity}/fields-order

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.

entity*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

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.

Response Body

application/json

curl -X PATCH "https://example.com/workspaces/string/schemas/string/fields-order" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "schema-property-order",      "attributes": {        "order": [          "name",          "status",          "company_id"        ]      }    }  }'
{}

Replace an object schema

Replaces the full JSON Schema for an object type. The request body is the complete schema document, and its `$id` must match the object in the path. The change is applied asynchronously: the response returns a task you can poll to track progress.

Set object field visibility

Shows or hides an object type’s fields on the record detail view. The `hiddenInDetails` map keys each field name to a boolean, where `true` hides the field. The change is applied asynchronously and the response body is empty.