Skip to main content

setPinnedAgent

client.application.setPinnedAgent(data: SetPinnedAgentRequest): Promise<void>

Sets the pinned agent for the application.

Pins a specific agent to the UI, making it the default or always-visible agent for quick access.

Parameters

ParameterTypeRequiredDescription
dataSetPinnedAgentRequestYesThe pinning configuration

Returns

Promise<void> — A promise that resolves when the agent has been pinned

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.application.setPinnedAgent(/* SetPinnedAgentRequest */);
console.log(result);