ClarifyAPI
Schemas

Set object field visibility

Deprecated: accepts the request and changes nothing. Record pages take field visibility from their layout. Add or remove fields in the Details group with PATCH /workspaces/{workspace}/layouts/record-page__{entity} instead.

Deprecated

PATCH
/workspaces/{workspace}/schemas/{entity}/fields-visibility
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-visibility" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "schema-property-visibility",      "attributes": {        "hiddenInDetails": {          "status": true        }      }    }  }'
{  "meta": {    "deprecation": "This endpoint is deprecated and changed nothing. Record pages take field order and visibility from their layout. Edit its Details group with PATCH /workspaces/acme/layouts/record-page__project."  }}