TAtakeshape
Agent
BigCommerce

Sync BigCommerce agent with pattern

Syncs a specific BigCommerce agent with the latest pattern, preserving customizations.

post/bigcommerce/channels/{channelId}/agents/{agentId}/sync

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

Response

Agent synced with pattern

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.