Topolo Docs Topolo Platform
Open workspace

Update sourcing workflow

Rename a sourcing workflow or change its segment, target list, interval or maxPerRun. Provide at least one field. A new interval reschedules the next run from the last one. The write is audited. Errors: 404 workflow_not_found, list or segment not found; 409 archived list.

Outcome

Rename a sourcing workflow or change its segment, target list, interval or maxPerRun. Provide at least one field. A new interval reschedules the next run from the last one. The write is audited. Errors: 404 workflow_not_found, list or segment not found; 409 archived list.

Before you start

  • Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:write.
  • Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.
  • Review the exact effects and obtain approval before CLI --confirm or MCP confirm:true. A local capture does not authorize a live mutation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.sourcing.workflows.update --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
idYes{"type":"string","minLength":1,"maxLength":128}
nameNo{"type":"string","minLength":1,"maxLength":120}
segmentIdNo{"type":"string","minLength":1,"maxLength":128}
listIdNo{"type":"string","minLength":1,"maxLength":128}
intervalNo{"type":"string","enum":["hourly","daily","weekly"]}
maxPerRunNo{"type":"integer","minimum":1,"maximum":1000}

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.sourcing.workflows.update --data @payload.json --json
topolo actions plan app_topolo_engage.sourcing.workflows.update --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

Review the plan and approve its exact effects before executing the unchanged request.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.sourcing.workflows.update --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · sourcing workflows over the published actions > creates, lists, gets, updates and deletes a workflow with audited writes

Action input

{
  "id": "sourcingWorkflow_1",
  "name": "Renamed",
  "segmentId": "segment_2",
  "listId": "list_2",
  "maxPerRun": 5
}

Actual local response

{
  "workflow": {
    "id": "sourcingWorkflow_1",
    "name": "Renamed",
    "status": "active",
    "pausedReason": null,
    "source": {
      "kind": "segment",
      "segmentId": "segment_2"
    },
    "listId": "list_2",
    "interval": "daily",
    "maxPerRun": 5,
    "nextRunAt": "2026-10-01T09:00:00.000Z",
    "lastRunAt": null,
    "lastRunSummary": null,
    "createdBy": "user_1",
    "createdAt": "2026-10-01T09:00:00.000Z",
    "updatedAt": "2026-10-01T10:00:00.000Z"
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sourcing workflows over the published actions > reschedules from the last run when the interval changes

Action input

{
  "id": "sourcingWorkflow_1",
  "interval": "weekly"
}

Actual local response

{
  "workflow": {
    "id": "sourcingWorkflow_1",
    "name": "Acme top-up",
    "status": "active",
    "pausedReason": null,
    "source": {
      "kind": "segment",
      "segmentId": "segment_1"
    },
    "listId": "list_1",
    "interval": "weekly",
    "maxPerRun": 2,
    "nextRunAt": "2026-10-01T09:00:00.000Z",
    "lastRunAt": null,
    "lastRunSummary": null,
    "createdBy": "user_1",
    "createdAt": "2026-10-01T09:00:00.000Z",
    "updatedAt": "2026-10-01T09:00:00.000Z"
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sourcing workflows over the published actions > reschedules from the last run when the interval changes

Action input

{
  "id": "sourcingWorkflow_1",
  "interval": "hourly"
}

Actual local response

{
  "workflow": {
    "id": "sourcingWorkflow_1",
    "name": "Acme top-up",
    "status": "active",
    "pausedReason": null,
    "source": {
      "kind": "segment",
      "segmentId": "segment_1"
    },
    "listId": "list_1",
    "interval": "hourly",
    "maxPerRun": 2,
    "nextRunAt": "2026-10-01T10:00:00.000Z",
    "lastRunAt": "2026-10-01T09:00:00.000Z",
    "lastRunSummary": {
      "runId": "sourcingRun_1",
      "trigger": "manual",
      "status": "succeeded",
      "startedAt": "2026-10-01T09:00:00.000Z",
      "finishedAt": "2026-10-01T09:00:00.000Z",
      "matched": 2,
      "added": 2,
      "alreadyMember": 0,
      "skipped": 1,
      "errorCode": null
    },
    "createdBy": "user_1",
    "createdAt": "2026-10-01T09:00:00.000Z",
    "updatedAt": "2026-10-01T09:00:00.000Z"
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sourcing workflows over the published actions > reschedules from the last run when the interval changes

Action input

{
  "id": "sourcingWorkflow_1",
  "name": "Same",
  "interval": "hourly"
}

Actual local response

{
  "workflow": {
    "id": "sourcingWorkflow_1",
    "name": "Same",
    "status": "active",
    "pausedReason": null,
    "source": {
      "kind": "segment",
      "segmentId": "segment_1"
    },
    "listId": "list_1",
    "interval": "hourly",
    "maxPerRun": 2,
    "nextRunAt": "2026-10-01T10:00:00.000Z",
    "lastRunAt": "2026-10-01T09:00:00.000Z",
    "lastRunSummary": {
      "runId": "sourcingRun_1",
      "trigger": "manual",
      "status": "succeeded",
      "startedAt": "2026-10-01T09:00:00.000Z",
      "finishedAt": "2026-10-01T09:00:00.000Z",
      "matched": 2,
      "added": 2,
      "alreadyMember": 0,
      "skipped": 1,
      "errorCode": null
    },
    "createdBy": "user_1",
    "createdAt": "2026-10-01T09:00:00.000Z",
    "updatedAt": "2026-10-01T09:00:00.000Z"
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Rename a sourcing workflow or change its segment, target list, interval or maxPerRun. Provide at least one field. A new interval reschedules the next run from the last one. The write is audited. Errors: 404 workflow_not_found, list or segment not found; 409 archived list.

Verify the outcome

  • Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 422 · sourcing workflows over the published actions > creates, lists, gets, updates and deletes a workflow with audited writes

Action input

{
  "id": "sourcingWorkflow_1"
}

Actual local response

{
  "error": {
    "code": "invalid_input",
    "message": "Provide a name, segmentId, listId, interval or maxPerRun to change."
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 409 · sourcing workflows over the published actions > refuses missing or archived lists, missing segments and a TopoloCRM source

Action input

{
  "id": "sourcingWorkflow_1",
  "listId": "list_2"
}

Actual local response

{
  "error": {
    "code": "state_conflict",
    "message": "Archived lists cannot be sourced into."
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · sourcing workflows over the published actions > refuses missing or archived lists, missing segments and a TopoloCRM source

Action input

{
  "id": "sourcingWorkflow_1",
  "segmentId": "segment_9"
}

Actual local response

{
  "error": {
    "code": "segment_not_found",
    "message": "Segment was not found in this workspace."
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · sourcing workflows over the published actions > refuses missing or archived lists, missing segments and a TopoloCRM source

Action input

{
  "id": "sourcingWorkflow_9",
  "name": "x"
}

Actual local response

{
  "error": {
    "code": "workflow_not_found",
    "message": "Sourcing workflow was not found in this workspace."
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 409 · sourcing workflows over the published actions > refuses a segment change on a TopoloCRM-sourced workflow

Action input

{
  "id": "wf_crm",
  "segmentId": "segment_1"
}

Actual local response

{
  "error": {
    "code": "crm_source_needs_service_access",
    "message": "A scheduled workflow cannot read TopoloCRM yet: TopoloCRM accepts only a person's own session or API key, not a service credential. Import from TopoloCRM by hand with contacts.import_from_crm."
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 403 · sourcing workflows over the published actions > lets readers read but not write

Action input

{
  "id": "sourcingWorkflow_1",
  "name": "x"
}

Actual local response

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:write.",
    "details": {
      "requiredPermission": "workspace:write"
    }
  }
}

Source test: sourcing-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

  • HTTP 422 invalid_input: Correct the request against the current action input schema, then validate it again before planning.
  • HTTP 409 state_conflict: Read the current retained state and reconcile the requested transition before retrying. Do not blindly replay a non-idempotent mutation.
  • HTTP 404 segment_not_found: Rediscover the identifier using the related list or get action in the same authorized resource. Do not guess identifiers or change organization context.
  • HTTP 404 workflow_not_found: Rediscover the identifier using the related list or get action in the same authorized resource. Do not guess identifiers or change organization context.
  • HTTP 409 crm_source_needs_service_access: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
  • HTTP 403 permission_denied: Stop and inspect the current credential and selected resource. It needs workspace:write; do not broaden access or switch organization automatically.

Evidence and limits

  • /api/sourcing/workflows/{id}

  • sourcing-routes.test.ts

  • Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

  • Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

  • No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.