Add object fields
Adds one or more non-relationship fields to an object type. Each key in attributes is a new field name mapped to its JSON Schema, and every type except boolean must include "null" — declare ["string", "null"] rather than "string", because the column behind such a field is nullable and a non-nullable declaration would reject its own stored values. Fields that already exist are rejected — this endpoint never overwrites. The change is applied asynchronously and the response body is empty.
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 and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
The API version for this request. Send 2026-11 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/workspaces/string/schemas/string/properties" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "data": { "type": "schema-properties", "attributes": { "budget": { "type": [ "number", "null" ], "title": "Budget" } } } }'{}Create a custom object
Creates a new custom object type in the workspace and returns its generated JSON Schema. The name is normalized to a `c_`-prefixed identifier (for example "Sales Order" becomes `c_sales_order`).
Add object relationships
Creates relationship fields between object types. The `attributes` map is keyed first by object type, then by field name, and both sides of each relationship must be supplied together so the pairing is consistent. On `one-to-many` and `many-to-many` sides, the field must declare `"oneOf": [{ "$ref": "https://getclarify.ai/schemas/core/collectionOfIds" }, { "type": "null" }]`, and the exact `$ref` string is required. Both sides exist when the response returns, and the response body is empty.