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

Update workspace instructions

Replace workspace instruction markdown with optimistic revision checking and rematerialize authorized Agent instructions. Workspace admin permission is required.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: instructions:write.

PUT /workspace/instructions

Replace workspace instruction markdown with optimistic revision checking and rematerialize authorized Agent instructions. Workspace admin permission is required.

Request
curl --fail-with-body -X PUT "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/workspace/instructions" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"markdown\":\"Use workspace evidence and cite durable resources.\",\"expected_revision\":7,\"reason\":\"Clarify evidence policy\"}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "scope_type": "workspace",
    "scope_id": "workspace_example",
    "markdown": "Use workspace evidence and cite durable resources.",
    "revision": 8,
    "content_hash": "d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0123",
    "can_manage": true,
    "applies_to": "new_conversations"
  },
  "rendered_profiles": [
    "agent_example"
  ],
  "applies_to": "new_conversations",
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "instructions: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.
409The supplied expected_revision is stale.
429The key exceeded its current rate limit.