Topolo Docs Topolo Platform
Open workspace

Get contact contactability

Resolve the suppression ledger for one contact: the active blocks (code, purpose, scope, since, sourceApp) on the contact and on each of its email addresses. Address blocks (hard_bounce, complaint, wrong_person) apply across every workspace of the organization; contact blocks stay in this workspace. contactable is false when any block applies to outreach.

Outcome

Resolve the suppression ledger for one contact: the active blocks (code, purpose, scope, since, sourceApp) on the contact and on each of its email addresses. Address blocks (hard_bounce, complaint, wrong_person) apply across every workspace of the organization; contact blocks stay in this workspace. contactable is false when any block applies to outreach.

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.contactability.status.get --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}

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.contactability.status.get --data @payload.json --json
topolo actions plan app_topolo_engage.contactability.status.get --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.contactability.status.get --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 · runner with the Nexus transport contract > unsubscribe_needs_one_recipient records a manual block (provider_suppressed) and stops the enrollment

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "manual_block",
      "purpose": "all",
      "scope": "contact",
      "since": "2026-10-06T08:30:00.000Z",
      "sourceApp": "topolo-nexus"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

Source test: runner with the Nexus transport contract > unsubscribe_needs_one_recipient records a manual block (provider_suppressed) and stops the enrollment. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contactability routes > ledger > records blocks idempotently and resolves the contact status

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": true,
  "blocks": [],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

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 > blocks an address across workspaces of one organization but not across organizations

Action input

{
  "id": "contact_2"
}

Actual local response

{
  "contactId": "contact_2",
  "contactable": false,
  "blocks": [
    {
      "code": "hard_bounce",
      "purpose": "all",
      "scope": "address",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    }
  ],
  "addresses": [
    {
      "address": "grace@navy.mil",
      "verificationStatus": "unknown",
      "blocks": [
        {
          "code": "hard_bounce",
          "purpose": "all",
          "scope": "address",
          "since": "2026-10-01T12:00:00.000Z",
          "sourceApp": "topolo-engage"
        }
      ]
    }
  ]
}

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 > needs evidence to loosen, and the strictest block wins

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "complaint",
      "purpose": "marketing",
      "scope": "address",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    },
    {
      "code": "complaint",
      "purpose": "outreach",
      "scope": "address",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    },
    {
      "code": "hard_bounce",
      "purpose": "all",
      "scope": "address",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": [
        {
          "code": "complaint",
          "purpose": "marketing",
          "scope": "address",
          "since": "2026-10-01T12:00:00.000Z",
          "sourceApp": "topolo-engage"
        },
        {
          "code": "complaint",
          "purpose": "outreach",
          "scope": "address",
          "since": "2026-10-01T12:00:00.000Z",
          "sourceApp": "topolo-engage"
        },
        {
          "code": "hard_bounce",
          "purpose": "all",
          "scope": "address",
          "since": "2026-10-01T12:00:00.000Z",
          "sourceApp": "topolo-engage"
        }
      ]
    }
  ]
}

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 > pages history and refuses foreign cursors, unknown contacts and readers

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "manual_block",
      "purpose": "all",
      "scope": "contact",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

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 > blocks an address across workspaces of one organization but not across organizations

Action input

{
  "id": "contact_3"
}

Actual local response

{
  "contactId": "contact_3",
  "contactable": true,
  "blocks": [],
  "addresses": [
    {
      "address": "grace@navy.mil",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

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 > pages history and refuses foreign cursors, unknown contacts and readers

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "manual_block",
      "purpose": "all",
      "scope": "contact",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    },
    {
      "code": "unsubscribed",
      "purpose": "marketing",
      "scope": "contact",
      "topicKey": "newsletter",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

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

Captured HTTP 200 · contactability routes > suppression imports > applies once per key, blocking matched contacts

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "unsubscribed",
      "purpose": "marketing",
      "scope": "contact",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    },
    {
      "code": "unsubscribed",
      "purpose": "outreach",
      "scope": "contact",
      "since": "2026-10-01T12:00:00.000Z",
      "sourceApp": "topolo-engage"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

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

Captured HTTP 200 · transport events > a reply records reply_stop, marks the enrollment replied and cancels the pending follow-up

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "reply_stop",
      "purpose": "outreach",
      "scope": "contact",
      "since": "2026-10-06T10:00:00.000Z",
      "sourceApp": "topolo-nexus"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": []
    }
  ]
}

Source test: transport events > a reply records reply_stop, marks the enrollment replied and cancels the pending follow-up. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · transport events > a hard bounce records hard_bounce and ends the enrollment as bounced

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "hard_bounce",
      "purpose": "all",
      "scope": "address",
      "since": "2026-10-06T10:00:00.000Z",
      "sourceApp": "topolo-nexus"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": [
        {
          "code": "hard_bounce",
          "purpose": "all",
          "scope": "address",
          "since": "2026-10-06T10:00:00.000Z",
          "sourceApp": "topolo-nexus"
        }
      ]
    }
  ]
}

Source test: transport events > a hard bounce records hard_bounce and ends the enrollment as bounced. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · transport events > a complaint records complaint and stops the enrollment; delivery after it never softens the outcome

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "contactId": "contact_1",
  "contactable": false,
  "blocks": [
    {
      "code": "complaint",
      "purpose": "marketing",
      "scope": "address",
      "since": "2026-10-06T10:00:00.000Z",
      "sourceApp": "topolo-nexus"
    },
    {
      "code": "complaint",
      "purpose": "outreach",
      "scope": "address",
      "since": "2026-10-06T10:00:00.000Z",
      "sourceApp": "topolo-nexus"
    }
  ],
  "addresses": [
    {
      "address": "ada@acme.io",
      "verificationStatus": "unknown",
      "blocks": [
        {
          "code": "complaint",
          "purpose": "marketing",
          "scope": "address",
          "since": "2026-10-06T10:00:00.000Z",
          "sourceApp": "topolo-nexus"
        },
        {
          "code": "complaint",
          "purpose": "outreach",
          "scope": "address",
          "since": "2026-10-06T10:00:00.000Z",
          "sourceApp": "topolo-nexus"
        }
      ]
    }
  ]
}

Source test: transport events > a complaint records complaint and stops the enrollment; delivery after it never softens the outcome. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Resolve the suppression ledger for one contact: the active blocks (code, purpose, scope, since, sourceApp) on the contact and on each of its email addresses. Address blocks (hard_bounce, complaint, wrong_person) apply across every workspace of the organization; contact blocks stay in this workspace. contactable is false when any block applies to outreach.

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 · contactability routes > ledger > pages history and refuses foreign cursors, unknown contacts and readers

Action input

{
  "id": "eng_ct_x"
}

Actual local response

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

Source test: contactability-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.

Evidence and limits

  • /api/contacts/{id}/contactability

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