Skip to content

UserSettingsGetResponse

Response for getting user settings

Contains profile and context information that is passed to the agent for all conversations to provide user context.

Example

const userSettings = await conversationalAgentService.user.getSettings();
console.log(userSettings.name, userSettings.email);

Extended by

Properties

Property Type Description
company null | string Company (max 100 chars)
country null | string Country (max 100 chars)
createdTime string UTC timestamp of creation
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)
updatedTime string UTC timestamp of last update
userId string Unique identifier of the user (UUID)