Write a workspace setting

Sets the value of a workspace setting by key. Read-only settings are rejected, and some settings require admin permissions.

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.

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.

key*string

The setting key, e.g. orgDescription. Read-only settings cannot be mutated.

value?unknown

The setting value; its type depends on the setting key.

Response Body

`application/json`

curl -X POST "https://example.com/workspaces/string/settings" \  -H "Content-Type: application/json" \  -d '{    "key": "orgDescription",    "value": "Acme Corp builds industrial hardware and software."  }'

{}