Settings.setSettings()

Settings.setSettings() updates a single workspace setting value programmatically. Pass null to clear a value. It is available from both attio/client and attio/server:

// In client code (extensions, dialogs, etc.)
import {Settings} from "attio/client"

// In server functions, webhook handlers, and event handlers
import {Settings} from "attio/server"

Parameters

WorkspaceSettingsSchema

required

The schema built with Settings.defineWorkspaceSchema, imported from your schema file.

string

required

The key of the setting to update. Must match a key defined in your schema; the key is fully typed, so TypeScript will only allow valid setting keys.

string | number | boolean | null

required

The new value for the setting. The type must match the setting type defined in your schema; TypeScript will enforce this. Pass null to clear the setting.

Returns

A promise that resolves when the setting has been updated.

Example

src/toggle-auto-sync.server.ts

import {Settings} from "attio/server"

import schema from "./app/settings/schema"

export default async function toggleAutoSync() {
  // Set a boolean setting
  await Settings.setSettings(schema, "auto_sync_enabled", true)

  // Set a number setting
  await Settings.setSettings(schema, "sync_interval_minutes", 30)

  // Clear a string setting
  await Settings.setSettings(schema, "team_name", null)

  return {success: true}
}

Type safety

The function enforces type safety for both keys and values:

// TypeScript enforces valid keys and matching value types
await Settings.setSettings(schema, "team_name", "Team A") // ✓ Valid
await Settings.setSettings(schema, "auto_sync_enabled", true) // ✓ Valid
await Settings.setSettings(schema, "sync_interval_minutes", 60) // ✓ Valid

await Settings.setSettings(schema, "nonexistent", "value") // ✗ TypeScript error!
await Settings.setSettings(schema, "auto_sync_enabled", "yes") // ✗ TypeScript error! (wrong type)

Settings.getSettings() - Read setting values
Settings.useSettings() - Read settings reactively in React components

Settings.getSettings()GraphQL

⌘I

Introduction

Guides

Extensions

Workflow blocks

Notifications

Dialogs

Components

Forms

Icons

Settings

GraphQL

Data fetching

Server

System

Legacy

Settings.setSettings()

Parameters

Returns

Example

Type safety

​Parameters

​Returns

​Example

​Type safety

​Related

Parameters

Returns

Example

Type safety

Related