Sync a connector

Run one bounded sync as the caller: with contact_source, page the remote contacts (up to 50 pages, resuming from lastSyncCursor) and upsert them into Nurture contacts; with suppression_sync, push pending blocking ledger events for connector-sourced contacts. A sync only writes contact profiles: it never changes an unsubscribe or suppression, never unarchives a contact, and never takes over an address Nurture already holds from another source (counted as skipped). Safe to repeat.

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.sync --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

POST /api/connectors/{id}/sync

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}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Creates or updates Nurture contacts from the remote source and stores lastSyncAt and the resume cursor (null once the last page is read).
Records Nurture suppression events on linked TopoloCRM contacts (contactability.events.record, idempotent by key).

Interpret the response

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

Repeat until counts.complete is true, then call app_topolo_nurture.contacts.list and confirm the synced contacts (source connector).

Exact success schema:

{
  "type": "object",
  "required": [
    "connector",
    "counts"
  ],
  "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"
        }
      }
    },
    "counts": {
      "type": "object",
      "required": [
        "pages",
        "fetched",
        "created",
        "updated",
        "unchanged",
        "skipped",
        "complete",
        "pushed"
      ],
      "properties": {
        "pages": {
          "type": "integer"
        },
        "fetched": {
          "type": "integer"
        },
        "created": {
          "type": "integer"
        },
        "updated": {
          "type": "integer"
        },
        "unchanged": {
          "type": "integer"
        },
        "skipped": {
          "type": "integer"
        },
        "pushed": {
          "type": "integer"
        },
        "complete": {
          "type": "boolean"
        }
      }
    }
  }
}

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_05b5f8d590044e13bd7b85799061cb90"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.sync --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.sync --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.sync --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.sync",
    "input": {
      "id": "con_05b5f8d590044e13bd7b85799061cb90"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "connector": {
    "id": "con_05b5f8d590044e13bd7b85799061cb90",
    "provider": "topolo_crm",
    "capabilities": [
      "suppression_sync"
    ],
    "config": {
      "crmWorkspaceId": "crm_ws"
    },
    "status": "active",
    "lastSyncAt": "2026-10-04T00:32:36.508Z",
    "lastSyncCursor": null,
    "lastError": null,
    "createdAt": "2026-10-04T00:32:36.507Z",
    "updatedAt": "2026-10-04T00:32:36.508Z"
  },
  "counts": {
    "pages": 0,
    "fetched": 0,
    "created": 0,
    "updated": 0,
    "unchanged": 0,
    "skipped": 0,
    "complete": false,
    "pushed": 0
  }
}

HTTP 200. Repeat until counts.complete is true, then call app_topolo_nurture.contacts.list and confirm the synced contacts (source connector).

Another supported request

Input · payload.json:

{
  "id": "con_7831aad09b1b4ac4bd21290dfb98d6ee"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.sync --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.sync --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.sync --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.sync",
    "input": {
      "id": "con_7831aad09b1b4ac4bd21290dfb98d6ee"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "connector": {
    "id": "con_7831aad09b1b4ac4bd21290dfb98d6ee",
    "provider": "topolo_crm",
    "capabilities": [
      "contact_source",
      "suppression_sync"
    ],
    "config": {
      "crmWorkspaceId": "crm_ws"
    },
    "status": "active",
    "lastSyncAt": "2026-10-04T00:32:36.423Z",
    "lastSyncCursor": null,
    "lastError": null,
    "createdAt": "2026-10-04T00:32:36.422Z",
    "updatedAt": "2026-10-04T00:32:36.426Z"
  },
  "counts": {
    "pages": 1,
    "fetched": 3,
    "created": 3,
    "updated": 0,
    "unchanged": 0,
    "skipped": 0,
    "complete": true,
    "pushed": 0
  }
}

HTTP 200. Repeat until counts.complete is true, then call app_topolo_nurture.contacts.list and confirm the synced contacts (source connector).

Refused request · connector_not_active

Input · payload.json:

{
  "id": "con_22aa9b969cca481a962fed38b53f41c8"
}

CLI:

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

Captured local response · HTTP 409:

{
  "error": {
    "code": "connector_not_active",
    "message": "Resume a paused connector (or connect it again) before syncing."
  }
}

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

Refused request · connector_unavailable

Input · payload.json:

{
  "id": "con_05b5f8d590044e13bd7b85799061cb90"
}

CLI:

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

Captured local response · HTTP 502:

{
  "error": {
    "code": "connector_unavailable",
    "message": "The topolo_crm connector failed: TopoloCRM contacts.list failed (403).",
    "details": {
      "connector": {
        "id": "con_05b5f8d590044e13bd7b85799061cb90",
        "provider": "topolo_crm",
        "capabilities": [
          "contact_source"
        ],
        "config": {
          "crmWorkspaceId": "crm_ws"
        },
        "status": "active",
        "lastSyncAt": "2026-10-04T00:32:36.509Z",
        "lastSyncCursor": null,
        "lastError": "TopoloCRM contacts.list failed (403).",
        "createdAt": "2026-10-04T00:32:36.507Z",
        "updatedAt": "2026-10-04T00:32:36.509Z"
      },
      "counts": {
        "pages": 0,
        "fetched": 0,
        "created": 0,
        "updated": 0,
        "unchanged": 0,
        "skipped": 0,
        "complete": false,
        "pushed": 0
      }
    }
  }
}

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

Refused request · connector_credential_required

Input · payload.json:

{
  "id": "con_05b5f8d590044e13bd7b85799061cb90"
}

CLI:

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

Captured local response · HTTP 503:

{
  "error": {
    "code": "connector_credential_required",
    "message": "This deployment or credential cannot reach the connector's provider."
  }
}

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

Verify the result

Repeat until counts.complete is true, then call app_topolo_nurture.contacts.list and confirm the synced contacts (source connector).

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.
connector_not_active (HTTP 409): Resume it with app_topolo_nurture.connectors.update status active, or connect it again.
connector_credential_required (HTTP 503): Call with a user or API-key credential the provider accepts; this deployment may also lack the provider URL.
connector_unavailable (HTTP 502): The provider refused or failed; progress so far is kept (error.details.counts, connector.lastSyncCursor). Check the credential can read the remote workspace, then sync again.

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

Archive any contact synced in error; archived contacts are never unarchived by later syncs.

List contacts: List the contacts Nurture holds for the caller's workspace, ordered by email, optionally filtered by status and a prefix search on email, first or last name. Pages of up to 200; pass nextCursor back as cursor for the next page.
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.
Archive contact: Archive a contact so segments stop matching it and imports no longer update it. The record is kept; use erase for a right-to-erasure request.

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.

Sync 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 · connector_not_active

Refused request · connector_unavailable

Refused request · connector_credential_required

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence