Skip to content

Update a Visible Agent

Change a visible agent name, team scope, role, or suspension state without recreating the binding.

Best for Workspace manager Updated April 3, 2026
API In this interface
4 steps Steps
3 interfaces Available in
Use this path when

The patch endpoint updates an existing visible agent binding without recreating the installation relationship.

What you'll finish here
  • Find the correct binding id.
  • Apply the smallest valid update.
  • Keep attribution stable while maintenance happens.

Where this happens

LabelValueNotes
EndpointPATCH /api/v1/workspaces/{workspaceId}/agents/{agentId}Updates a visible agent binding.

Same Task, Other Interfaces

Use the version that matches where you are working now. The subject matter stays the same; the delivery changes by surface.

Do the work

  1. 1. Resolve the workspace id and agent id first.
  2. 2. Send only the changed fields in the request body.
  3. 3. Use `suspended` when the change is about temporary access state rather than naming or teams.
  4. 4. Read the success response and relist agents if you want to verify the current inventory.

Keep Going in Automation and Agents

Stay in the same interface and move to the next closest task in this topic when needed.

Nearby Guides

These guides stay close to the current workflow so you can keep moving without restarting discovery.