SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

Update an Agent

Rename or archive an Agent when the current user is allowed to manage it.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: agents:write.

PATCH /agents/{agent_id}

Rename or archive an Agent when the current user is allowed to manage it.

ParameterTypeDescription
agent_id
path · required
stringStable Agent ID.
Request
curl --fail-with-body -X PATCH "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Research\",\"archived\":false}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "agent": {
    "id": "research-agent",
    "name": "Research",
    "archived": false
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "agents:write",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
400The request body or parameters are invalid.
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.