Reorder object fields
Deprecated: accepts the request and changes nothing. Record pages take field order from their layout. Reorder the Details group with PATCH /workspaces/{workspace}/layouts/record-page__{entity} instead.
Deprecated
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.
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
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/string/fields-order" \ -H "Content-Type: application/json" \ -d '{ "data": { "type": "schema-property-order", "attributes": { "order": [ "name", "status", "company_id" ] } } }'{ "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." }}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.
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.