Nurama Developers
Workspaces

Update a single workspace setting.

Sets one key of the workspace's `settings` JSON column. The `name` path parameter selects the setting and determines the type `value` must have (booleans for the toggles, bounded integers for the credit budgets, strings for the pre-prompts, `{ toolName: boolean|null }` maps for `aiChatTools` / `aiAssistTools`). Requires `canManageWorkspaceSettings` on the workspace. Setting-specific behaviour: - `autoTopUpEnabled: true` is refused with `autoTopUpRequiresPriorTopUp` until the workspace has made at least one manual credit top-up. - Flipping `boardsEnabled` true→false schedules every board in the workspace for deletion after a 48h grace window; flipping it back within the window restores them.

PUT
/workspaces/{workspaceId}/settings/{name}

Sets one key of the workspace's settings JSON column. The name path parameter selects the setting and determines the type value must have (booleans for the toggles, bounded integers for the credit budgets, strings for the pre-prompts, { toolName: boolean|null } maps for aiChatTools / aiAssistTools). Requires canManageWorkspaceSettings on the workspace.

Setting-specific behaviour:

  • autoTopUpEnabled: true is refused with autoTopUpRequiresPriorTopUp until the workspace has made at least one manual credit top-up.

  • Flipping boardsEnabled true→false schedules every board in the workspace for deletion after a 48h grace window; flipping it back within the window restores them.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workspaceId*string

Unique identifier of the workspace.

Formatuuid
name*string

The setting to update.

Value in

  • "aiAddOnEnabled"
  • "allowAiFeatures"
  • "aiPolishEnabled"
  • "aiComposeEnabled"
  • "aiChatEnabled"
  • "aiAssistEnabled"
  • "aiAssistFollowUpWindow"
  • "aiTaskGenerationEnabled"
  • "aiImageRevisionEnabled"
  • "aiPolishAllowReviewer"
  • "aiComposeAllowReviewer"
  • "aiChatAllowReviewer"
  • "aiAssistAllowReviewer"
  • "aiTaskGenerationAllowReviewer"
  • "aiImageRevisionAllowReviewer"
  • "aiCustomPreprompt"
  • "aiTaskGenerationPreprompt"
  • "dailyUserAiSpendBudget"
  • "autoTopUpEnabled"
  • "autoTopUpThresholdCredits"
  • "autoTopUpAmountCredits"
  • "autoTopUpMonthlyLimitCredits"
  • "aiChatTools"
  • "aiAssistTools"
  • "boardsEnabled"
  • "convosEnabled"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings/aiAddOnEnabled" \  -H "Content-Type: application/json" \  -d '{    "value": null  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "description": "string",  "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85",  "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",  "color": "string",  "settings": {},  "roles": [    "string"  ],  "status": "active",  "createdAt": 1678886400000,  "updatedAt": 1678886400000}

Create or update workspace logo. PUT

Previous Page

Update details of a specific workspace PUT

Next Page