Write a workspace setting
Sets the value of a workspace setting by key. Only a workspace admin can change settings. API keys cannot change settings. Read-only settings are rejected.
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 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/settings" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "key": "orgDescription", "value": "Acme Corp builds industrial hardware and software." }'{}Get a workspace setting
Returns the value of a single workspace setting; the default value when the workspace has not overridden it.
Create a workspace
Creates a workspace owned by the signed-in user and returns it as a JSON:API resource once it is ready to use. Requires a user access token sent as `Authorization: Bearer <token>`. Retrying after a failure resumes the unfinished workspace instead of creating a second one, and repeating a create with the same name within ten minutes returns that workspace with status 200 and `meta.existing` set.