Update BigCommerce agent

Updates a specific BigCommerce agent configuration.

put/bigcommerce/channels/{channelId}/agents/{agentId}

Request

Base URL
https://api.takeshape.io
Auth
HTTP bearer

Path parameters

channelIdnumber required

Example:1

The unique identifier for a channel

agentIdstring required

Example:purchaseOrderAgent

The name of the AI agent

Request body

systemPromptstring nullable

Custom system prompt for the agent. Pass null to clear.

disabledboolean nullable

Whether the agent is disabled. Pass true to disable, false to enable.

targetSelectorstring nullable

CSS selector for where the agent should be active. Pass null to clear.

Response

Updated agent with configuration

idstring required

The encoded ID of the agent

namestring required

The name of the agent

titlestring required

The title of the agent

descriptionstring required

The description of the agent

status'active' | 'disabled' required

The status of the agent

systemPromptstring

Custom system prompt for the agent

systemPromptDefaultstring required

Default system prompt for the agent

inputNamestring required

The name of the BigCommerce API input associated with the agent

targetSelectorstring

CSS selector for where the agent should be active

targetSelectorDefaultstring required

Default CSS selector for where the agent should be active

Changes

No recorded changes to this operation across all 1 revision of this API.