Skip to content

UserSettingsUpdateOptions

Options for updating user settings

All fields are optional - only send the fields you want to change. Set fields to null to explicitly clear them. Omitting fields means no change.

Example

// Update specific fields
await conversationalAgentService.user.updateSettings({
  name: 'John Doe',
  timezone: 'America/New_York'
});

// Clear a field by setting to null
await conversationalAgentService.user.updateSettings({
  department: null
});

Properties

Property Type Description
company? null | string Company (max 100 chars)
country? null | string Country (max 100 chars)
department? null | string Department (max 100 chars)
email? null | string Email address (max 255 chars, must be valid email)
name? null | string Name of the user (max 100 chars)
role? null | string Role of the user (max 100 chars)
timezone? null | string Timezone (max 50 chars)