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

Update a chat

Rename, archive, unarchive, or mark an accessible chat as read.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: chats:write.

PATCH /agents/{agent_id}/chats/{chat_id}

Rename, archive, unarchive, or mark an accessible chat as read.

ParameterTypeDescription
agent_id
path · required
stringRequired agent_id path identifier.
chat_id
path · required
stringDurable chat ID.
Request
curl --fail-with-body -X PATCH "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/chats/$CHAT_ID" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"title\":\"Australian competitor research\",\"archived\":false,\"read\":true}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "chat": {
    "id": "chat_01J8",
    "title": "Australian competitor research",
    "archived": false,
    "unread": false
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "chats: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.