Add matching contacts to list

Outcome

Add the active contacts matching a filter or saved segmentId (exactly one), newest first, to a list, up to max (default 1000, at most 5000). Idempotent: contacts already on the list count as alreadyMember. truncated is true when more contacts matched than max. The write is audited. Errors: 404 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.lists.members.add_from_filter --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

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.lists.members.add_from_filter --data @payload.json --json
topolo actions plan app_topolo_engage.lists.members.add_from_filter --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.lists.members.add_from_filter --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 · ICP filters over the published actions > lists.members.add_from_filter > adds matching contacts idempotently, reports truncation and audits

Action input

{
  "listId": "list_1",
  "filter": {
    "companyIn": [
      "acme"
    ]
  },
  "max": 1
}

Actual local response

{
  "listId": "list_1",
  "matched": 1,
  "added": 1,
  "alreadyMember": 0,
  "truncated": true
}

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

Captured HTTP 200 · ICP filters over the published actions > lists.members.add_from_filter > applies a contactability filter before adding

Action input

{
  "listId": "list_1",
  "filter": {
    "contactability": "eligible"
  }
}

Actual local response

{
  "listId": "list_1",
  "matched": 2,
  "added": 2,
  "alreadyMember": 0,
  "truncated": false
}

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

Captured HTTP 200 · ICP filters over the published actions > lists.members.add_from_filter > adds matching contacts idempotently, reports truncation and audits

Action input

{
  "listId": "list_1",
  "filter": {
    "companyIn": [
      "acme"
    ]
  }
}

Actual local response

{
  "listId": "list_1",
  "matched": 2,
  "added": 1,
  "alreadyMember": 1,
  "truncated": false
}

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

Captured HTTP 200 · ICP filters over the published actions > lists.members.add_from_filter > adds matching contacts idempotently, reports truncation and audits

Action input

{
  "listId": "list_1",
  "filter": {
    "companyIn": [
      "acme"
    ]
  }
}

Actual local response

{
  "listId": "list_1",
  "matched": 2,
  "added": 0,
  "alreadyMember": 2,
  "truncated": false
}

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

Captured HTTP 200 · ICP filters over the published actions > lists.members.add_from_filter > adds matching contacts idempotently, reports truncation and audits

Action input

{
  "listId": "list_1",
  "segmentId": "segment_1"
}

Actual local response

{
  "listId": "list_1",
  "matched": 1,
  "added": 1,
  "alreadyMember": 0,
  "truncated": false
}

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

Effects and response meaning

• Add the active contacts matching a filter or saved segmentId (exactly one), newest first, to a list, up to max (default 1000, at most 5000). Idempotent: contacts already on the list count as alreadyMember. truncated is true when more contacts matched than max. The write is audited. Errors: 404 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 404 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Action input

{
  "listId": "list_9",
  "filter": {}
}

Actual local response

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

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

Captured HTTP 404 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Action input

{
  "listId": "list_1",
  "segmentId": "segment_9"
}

Actual local response

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

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

Captured HTTP 422 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Refused input; do not execute

{
  "listId": "list_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for lists.members.add_from_filter is invalid.",
    "details": [
      {
        "code": "custom",
        "path": [],
        "message": "Provide exactly one of filter or segmentId."
      }
    ]
  }
}

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

Captured HTTP 422 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Action input

{
  "listId": "list_1",
  "filter": {
    "titleAny": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ],
    "companyIn": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ],
    "countryIn": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ]
  }
}

Actual local response

{
  "error": {
    "code": "filter_too_complex",
    "message": "A filter may bind at most 60 values; this one binds 75."
  }
}

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

Captured HTTP 403 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Action input

{
  "listId": "list_1",
  "filter": {}
}

Actual local response

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

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

Captured HTTP 409 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Action input

{
  "listId": "list_1",
  "filter": {}
}

Actual local response

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

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

Captured HTTP 422 · ICP filters over the published actions > lists.members.add_from_filter > refuses missing or archived lists, missing segments, bad sources, complex filters and readers

Refused input; do not execute

{
  "filter": {},
  "max": 5001,
  "listId": "list_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for lists.members.add_from_filter is invalid.",
    "details": [
      {
        "origin": "number",
        "code": "too_big",
        "maximum": 5000,
        "inclusive": true,
        "path": [
          "max"
        ],
        "message": "Too big: expected number to be <=5000"
      }
    ]
  }
}

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

Error recovery

• HTTP 404 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 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 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.
• HTTP 422 filter_too_complex: 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.
• HTTP 409 state_conflict: Read the current retained state and reconcile the requested transition before retrying. Do not blindly replay a non-idempotent mutation.

Related actions

• List prospect lists
• Create prospect list
• Get prospect list
• Update prospect list
• Archive prospect list
• Add contacts to list
• Remove contacts from list

Evidence and limits

• /api/lists/{listId}/members/from-filter

• segments-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.