Update Knowledge Connector

Update connector source configuration, schedule, or active state. Replacing source configuration on a runnable connector queues an immediate synchronization; paused connectors retain the change without synchronizing until resumed. Source configuration cannot be replaced while synchronization is already in progress. Authentication material cannot be changed through this operation. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

PATCH/api/v2/knowledge/{knowledgeBaseId}/connectors/{connectorId}

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

connectorId*string

Connector selected for the operation.

Length1 <= length
knowledgeBaseId*string

Knowledge base that owns the connector.

Length1 <= length

Request Body

application/json

Workspace scope and at least one mutable connector field.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://www.sim.ai/api/v2/knowledge/string/connectors/string" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "status": "paused"  }'
{
  "data": {
    "id": "kc-9f8e7d6c",
    "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "connectorType": "notion",
    "credentialId": "cred-4b3a2c1d",
    "sourceConfig": {
      "pageIds": [
        "page-123"
      ]
    },
    "syncMode": "full",
    "syncIntervalMinutes": 1440,
    "status": "active",
    "lastSyncAt": "2026-06-20T14:02:11.000Z",
    "lastSyncError": null,
    "lastSyncDocCount": 42,
    "nextSyncAt": "2026-06-21T14:02:11.000Z",
    "consecutiveFailures": 0,
    "createdAt": "2026-06-01T09:14:00.000Z",
    "updatedAt": "2026-06-20T14:02:11.000Z"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "Upload has already been completed"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
PATCHUpdate ChunkPATCHUpdate Knowledge Connector Documents