Topolo Docs Topolo Platform
Open workspace

Check send eligibility

Dry-run whether up to 100 contacts may be sent a message now (or at `at`): suppression blocks, address deliverability, the per-contact caps and quiet hours. Each recipient returns eligible, reason codes and, when every reason is time-bound, nextEligibleAt. Contacts without an active email point return no_contact_point. Purpose defaults to outreach; transactional needs messageCategory. Nothing is reserved or sent.

Outcome

Dry-run whether up to 100 contacts may be sent a message now (or at at): suppression blocks, address deliverability, the per-contact caps and quiet hours. Each recipient returns eligible, reason codes and, when every reason is time-bound, nextEligibleAt. Contacts without an active email point return no_contact_point. Purpose defaults to outreach; transactional needs messageCategory. Nothing is reserved or sent.

Before you start

  • Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:read.
  • Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.eligibility.check --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
purposeNo{"type":"string","enum":["outreach","marketing","transactional"]}
messageCategoryNo{"type":"string","enum":["receipt","password_reset","account_security","billing","order_update","service_notice"]}
topicKeyNo{"type":"string","minLength":1,"maxLength":120}
recipientsYes{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string","minLength":1,"maxLength":128}},"required":["contactId"],"additionalProperties":false}}
atNo`{"type":"string","format":"date-time","pattern":"^(?:(?:\d\d[2468][048]

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.eligibility.check --data @payload.json --json
topolo actions plan app_topolo_engage.eligibility.check --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

Execute the unchanged validated read.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.eligibility.check --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --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 · contactability routes > ledger > blocks an address across workspaces of one organization but not across organizations

Action input

{
  "recipients": [
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-10-01T12:00:00.000Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": false,
      "reasons": [
        "contact_point_undeliverable"
      ]
    }
  ]
}

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

Captured HTTP 200 · contactability routes > ledger > stops outreach after a global unsubscribe

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ],
  "at": "2026-10-01T12:00:00.000Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "opt.out@acme.io",
      "eligible": false,
      "reasons": [
        "unsubscribed"
      ]
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    },
    {
      "contactId": "contact_2"
    },
    {
      "contactId": "contact_3"
    },
    {
      "contactId": "eng_ct_x"
    }
  ]
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "contact_point_undeliverable"
      ]
    },
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": false,
      "reasons": [
        "manual_block"
      ]
    },
    {
      "contactId": "contact_3",
      "address": null,
      "eligible": false,
      "reasons": [
        "no_contact_point"
      ]
    },
    {
      "contactId": "eng_ct_x",
      "address": null,
      "eligible": false,
      "reasons": [
        "no_contact_point"
      ]
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > applies quiet hours in the recipient timezone, falling back to Europe/London, across DST

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    },
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-07-01T20:00:00Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "quiet_hours"
      ],
      "nextEligibleAt": "2026-07-02T07:00:00.000Z"
    },
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": false,
      "reasons": [
        "quiet_hours"
      ],
      "nextEligibleAt": "2026-07-01T23:00:00.000Z"
    }
  ]
}

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

Captured HTTP 200 · archived contact retention > erases only archived contacts past the period in workspaces that set one, and they stay suppressed

Action input

{
  "recipients": [
    {
      "contactId": "contact_5"
    }
  ],
  "at": "2026-10-05T12:00:00.000Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_5",
      "address": "old@acme.io",
      "eligible": false,
      "reasons": [
        "erased"
      ]
    }
  ]
}

Source test: archived contact retention > erases only archived contacts past the period in workspaces that set one, and they stay suppressed. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contactability routes > eligibility > reserves under the cap, replays a granted key, and counts consumed sends

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ]
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "daily_cap_reached"
      ],
      "nextEligibleAt": "2026-10-02T12:00:00.000Z"
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ]
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": true,
      "reasons": []
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Action input

{
  "purpose": "transactional",
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ]
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "transactional_category_required"
      ]
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Action input

{
  "purpose": "marketing",
  "topicKey": "news",
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ]
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "not_subscribed"
      ]
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Action input

{
  "purpose": "transactional",
  "messageCategory": "receipt",
  "recipients": [
    {
      "contactId": "contact_1"
    }
  ],
  "at": "2026-10-01T22:00:00Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": true,
      "reasons": []
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > applies quiet hours in the recipient timezone, falling back to Europe/London, across DST

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    },
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-03-29T00:30:00Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "quiet_hours"
      ],
      "nextEligibleAt": "2026-03-29T07:00:00.000Z"
    },
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": true,
      "reasons": []
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > applies quiet hours in the recipient timezone, falling back to Europe/London, across DST

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    },
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-10-25T00:30:00Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "quiet_hours"
      ],
      "nextEligibleAt": "2026-10-25T08:00:00.000Z"
    },
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": true,
      "reasons": []
    }
  ]
}

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

Captured HTTP 200 · contactability routes > eligibility > applies quiet hours in the recipient timezone, falling back to Europe/London, across DST

Action input

{
  "recipients": [
    {
      "contactId": "contact_1"
    },
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-07-01T10:00:00Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_1",
      "address": "ada@acme.io",
      "eligible": true,
      "reasons": []
    },
    {
      "contactId": "contact_2",
      "address": "grace@navy.mil",
      "eligible": true,
      "reasons": []
    }
  ]
}

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

Captured HTTP 200 · contacts.erase > keeps the same email suppressed for every purpose when it is added again as a new contact

Action input

{
  "purpose": "outreach",
  "recipients": [
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-10-05T12:00:00.000Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_2",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "erased"
      ]
    }
  ]
}

Source test: contacts.erase > keeps the same email suppressed for every purpose when it is added again as a new contact. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contacts.erase > keeps the same email suppressed for every purpose when it is added again as a new contact

Action input

{
  "purpose": "marketing",
  "recipients": [
    {
      "contactId": "contact_2"
    }
  ],
  "at": "2026-10-05T12:00:00.000Z"
}

Actual local response

{
  "results": [
    {
      "contactId": "contact_2",
      "address": "ada@acme.io",
      "eligible": false,
      "reasons": [
        "erased"
      ]
    }
  ]
}

Source test: contacts.erase > keeps the same email suppressed for every purpose when it is added again as a new contact. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Dry-run whether up to 100 contacts may be sent a message now (or at at): suppression blocks, address deliverability, the per-contact caps and quiet hours. Each recipient returns eligible, reason codes and, when every reason is time-bound, nextEligibleAt. Contacts without an active email point return no_contact_point. Purpose defaults to outreach; transactional needs messageCategory. Nothing is reserved or sent.

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 · contactability routes > eligibility > checks recipients: eligible, blocked, undeliverable and without a contact point

Refused input; do not execute

{
  "recipients": []
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for eligibility.check is invalid.",
    "details": [
      {
        "origin": "array",
        "code": "too_small",
        "minimum": 1,
        "inclusive": true,
        "path": [
          "recipients"
        ],
        "message": "Too small: expected array to have >=1 items"
      }
    ]
  }
}

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

Error recovery

  • HTTP 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.

Evidence and limits

  • /api/eligibility/check

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