updateDisplaySettings()

Patches branding and UI display fields handled by /settings/display.

Usage

The following example shows a basic usage of the backend client from @wacht/nextjs/server.

import { wachtClient } from '@wacht/nextjs/server';export async function updateDisplay() {  const client = await wachtClient();  await client.settings.updateDisplaySettings({    primary_color: '#111827',    logo_url: 'https://cdn.example.com/logo.png',  });}

Signature

function updateDisplaySettings(  request: {    display_name?: string;    primary_color?: string;    logo_url?: string;    favicon_url?: string;    custom_css?: string;    theme?: 'light' | 'dark' | 'auto';    locale?: string;    timezone?: string;  },): Promise<void>

UpdateDisplaySettingsRequest

›

display_name?: string | undefined;

Display name shown in UI.

›

primary_color?: string | undefined;

Primary brand color.

›

logo_url?: string | undefined;

Logo image URL.

›

favicon_url?: string | undefined;

Favicon image URL.

›

custom_css?: string | undefined;

Custom stylesheet content.

›

theme?: 'light' | 'dark' | 'auto' | undefined;

Default theme mode.

›

locale?: string | undefined;

Default locale.

›

timezone?: string | undefined;

Default timezone identifier.

Patch semantics

This method sends a partial patch to /settings/display.

Only provided fields are changed; all other display settings remain as-is.

Return value

The method resolves with no value when the display settings update is accepted.

Examples

Update brand identity assets

import { wachtClient } from '@wacht/nextjs/server';export async function updateBrandAssets() {  const client = await wachtClient();  await client.settings.updateDisplaySettings({    display_name: 'Acme Console',    logo_url: 'https://cdn.example.com/acme/logo.svg',    favicon_url: 'https://cdn.example.com/acme/favicon.ico',  });}

Set theme and localization defaults

import { wachtClient } from '@wacht/nextjs/server';export async function setDisplayDefaults() {  const client = await wachtClient();  await client.settings.updateDisplaySettings({    theme: 'auto',    locale: 'en-US',    timezone: 'America/New_York',    primary_color: '#0f172a',  });}