Update a connector

Change a connector's capabilities, config, or status (active or paused). A paused connector keeps its settings but neither syncs nor takes part in eligibility or lead handoff. Only the fields sent change; config is replaced whole, so send every field. A topolo_engage campaignId and seatId are checked in Engage as the caller. Use connectors.disconnect to disconnect.

Outcome

Before you start

Verify identity and pin the intended organization and environment before discovering the action.
Discover a granted Nurture workspace. The application permission is workspace:write; required workspace access is admin. A permission alone does not supply a workspace grant.
Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.connectors.update --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.connectors.list --detail --json

id: connectors record id in the selected workspace.

Request

PATCH /api/connectors/{id}

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Field	Required	Type	Constraints
`id`	Required	string	connectors record id in the selected workspace. {"minLength":1,"maxLength":64}
`capabilities`	Optional	array	{"minItems":1,"maxItems":5}
`config`	Optional	object	{}
`status`	Optional	string	{"enum":["active","paused"]}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "capabilities": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "contact_source",
          "suppression_sync",
          "interaction_writeback",
          "consent",
          "lead_handoff"
        ]
      }
    },
    "config": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Updates the named fields of one connector; enabling or removing suppression_sync changes whether eligibility.reserve delegates from the next call.

Interpret the response

The returned identifier path is $.connector.id for connector. Empty lists do not discover a target.

Call app_topolo_nurture.connectors.list and confirm the changed fields.

Exact success schema:

{
  "type": "object",
  "required": [
    "connector"
  ],
  "properties": {
    "connector": {
      "type": "object",
      "required": [
        "id",
        "provider",
        "capabilities",
        "status"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "provider": {
          "type": "string"
        },
        "capabilities": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "contact_source",
              "suppression_sync",
              "interaction_writeback",
              "consent",
              "lead_handoff"
            ]
          }
        },
        "config": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused",
            "disconnected"
          ]
        },
        "lastSyncAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastSyncCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastError": {
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "con_22aa9b969cca481a962fed38b53f41c8",
  "capabilities": [
    "suppression_sync"
  ],
  "status": "paused"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.update --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.connectors.update",
    "input": {
      "id": "con_22aa9b969cca481a962fed38b53f41c8",
      "capabilities": [
        "suppression_sync"
      ],
      "status": "paused"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "connector": {
    "id": "con_22aa9b969cca481a962fed38b53f41c8",
    "provider": "topolo_crm",
    "capabilities": [
      "suppression_sync"
    ],
    "config": {
      "crmWorkspaceId": "crm_ws"
    },
    "status": "paused",
    "lastSyncAt": null,
    "lastSyncCursor": null,
    "lastError": null,
    "createdAt": "2026-10-04T00:32:36.268Z",
    "updatedAt": "2026-10-04T00:32:36.270Z"
  }
}

HTTP 200. Call app_topolo_nurture.connectors.list and confirm the changed fields.

Another supported request

Input · payload.json:

{
  "id": "con_22aa9b969cca481a962fed38b53f41c8",
  "config": {
    "crmWorkspaceId": "crm_2"
  }
}

CLI:

topolo actions validate app_topolo_nurture.connectors.update --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.connectors.update",
    "input": {
      "id": "con_22aa9b969cca481a962fed38b53f41c8",
      "config": {
        "crmWorkspaceId": "crm_2"
      }
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "connector": {
    "id": "con_22aa9b969cca481a962fed38b53f41c8",
    "provider": "topolo_crm",
    "capabilities": [
      "suppression_sync"
    ],
    "config": {
      "crmWorkspaceId": "crm_2"
    },
    "status": "paused",
    "lastSyncAt": null,
    "lastSyncCursor": null,
    "lastError": null,
    "createdAt": "2026-10-04T00:32:36.268Z",
    "updatedAt": "2026-10-04T00:32:36.272Z"
  }
}

HTTP 200. Call app_topolo_nurture.connectors.list and confirm the changed fields.

Refused request · unsupported_capability

Input · payload.json:

{
  "id": "con_22aa9b969cca481a962fed38b53f41c8",
  "capabilities": [
    "consent"
  ]
}

CLI:

topolo actions validate app_topolo_nurture.connectors.update --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "unsupported_capability",
    "message": "TopoloCRM does not support consent.",
    "details": {
      "capability": "consent"
    }
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Refused request · not_found

Input · payload.json:

{
  "id": "con_missing",
  "status": "active"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.update --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Connector was not found in this workspace."
  }
}

HTTP 404. Preserve the refusal details and do not claim success.

Refused request · connector_disconnected

Input · payload.json:

{
  "id": "con_22aa9b969cca481a962fed38b53f41c8",
  "status": "active"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.update --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 409:

{
  "error": {
    "code": "connector_disconnected",
    "message": "Connect the provider again to use a disconnected connector."
  }
}

HTTP 409. Preserve the refusal details and do not claim success.

Verify the result

Call app_topolo_nurture.connectors.list and confirm the changed fields.

Errors and recovery

organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
not_found (HTTP 404): List connectors to find a valid id in this workspace.
unsupported_capability (HTTP 422): Use only the capabilities app_topolo_nurture.connectors.catalog lists for the provider.
invalid_config (HTTP 422): Send every required config field app_topolo_nurture.connectors.catalog lists for the provider (error.details.field names the bad one), e.g. crmWorkspaceId for topolo_crm. For topolo_engage send campaignId and seatId together, picked from app_topolo_nurture.connectors.engage_options.
connector_credential_required (HTTP 503): Call with a credential TopoloEngage accepts; this deployment may also lack the Engage URL.
connector_unavailable (HTTP 502): TopoloEngage refused or failed while checking the campaign and seat; check the credential can read the Engage workspace, then retry.
connector_disconnected (HTTP 409): Connect the provider again with app_topolo_nurture.connectors.connect.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

Read the connector first, then send the previous capabilities, config or status back.

List connectors: List the connectors in the caller's Nurture workspace (any status) with their enabled capabilities, config, last sync time, resume cursor and last error. A workspace that still has the retired settings.crmWorkspaceId link gets an equivalent TopoloCRM connector (contact_source) on this call.
Update a connector: Change a connector's capabilities, config, or status (active or paused). A paused connector keeps its settings but neither syncs nor takes part in eligibility or lead handoff. Only the fields sent change; config is replaced whole, so send every field. A topolo_engage campaignId and seatId are checked in Engage as the caller. Use connectors.disconnect to disconnect.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.

Update a connector

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · unsupported_capability

Refused request · not_found

Refused request · connector_disconnected

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence