Background Agents

Update Background Agent

Updates an existing background agent by ID.

Only the fields provided in the request body will be updated. When capabilities is provided it replaces the agent's capabilities as a whole. After changing capabilities or platform configuration for a synced agent, call the sync endpoint to push the changes to the external platform.

patch/api/background-agents/{id}

Request

  • Base URL: https://app.withwillow.ai
  • URL: https://app.withwillow.ai/api/background-agents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the background agent to update

Request body

namestring
slugstring
descriptionstring
iconstring
status'active' | 'disabled'
owner_idsstring[]
platform'custom' | 'custom-managed' | 'willow-agents' | 'claude-managed-agents' | 'claude-tag' | 'aws-agentcore' | 'cursor-agents' | 'kagent' | 'snowflake-cortex-agents' | 'codex' | 'langgraph'
platform_configobject

Response

Background agent updated successfully

Example response

{
  "data": {
    "id": "agent_abc123",
    "name": "Support Triage Agent",
    "slug": "support-triage-agent",
    "access_key": "ba_x1y2z3...",
    "sync_state": {
      "credential_id": "vcrd_01ABCDEfghijKLMNopqrSTUv",
      "vault_id": "vlt_01ABCDEfghijKLMNopqrSTUv"
    },
    "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Changes

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