Topolo Docs Topolo Platform
Open workspace

Get compliance footer

Get the workspace compliance footer appended to every outreach email. mode is manual (Engage-owned values) or brand (connected live to the workspace Brand kit). effective is the footer the next rendered message gets, with its source: manual, brand (resolved live now) or brand_cached (the last-known-good Brand resolve, used while Brand is unreachable). manual holds the Engage-owned values, kept unchanged while connected. lastBrandResolve is the last successful Brand resolve (kit, version, time). While postal_address_missing or opt_out_text_missing is listed the runner holds every message and sends nothing; in brand mode that happens when Brand never resolved or the kit has no registered address, and manual values are never used instead. brand.available and brand.reason (not_configured, unreachable, not_bound) say whether Brand can be used; Brand is optional and never required to send.

Outcome

Get the workspace compliance footer appended to every outreach email. mode is manual (Engage-owned values) or brand (connected live to the workspace Brand kit). effective is the footer the next rendered message gets, with its source: manual, brand (resolved live now) or brand_cached (the last-known-good Brand resolve, used while Brand is unreachable). manual holds the Engage-owned values, kept unchanged while connected. lastBrandResolve is the last successful Brand resolve (kit, version, time). While postal_address_missing or opt_out_text_missing is listed the runner holds every message and sends nothing; in brand mode that happens when Brand never resolved or the kit has no registered address, and manual values are never used instead. brand.available and brand.reason (not_configured, unreachable, not_bound) say whether Brand can be used; Brand is optional and never required to send.

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.sending.compliance.get --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

This action accepts an empty input object ({}). Resource context is supplied separately when required.

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.sending.compliance.get --data @payload.json --json
topolo actions plan app_topolo_engage.sending.compliance.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.sending.compliance.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 · sending.compliance.* actions > refuses to connect when Brand is not connected, unbound, unreachable or has no address, leaving the mode unchanged

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "manual",
      "updatedAt": null
    },
    "senderNameOverride": null,
    "lastBrandResolve": null,
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": false,
    "reason": "not_configured"
  }
}

Source test: sending.compliance.* actions > refuses to connect when Brand is not connected, unbound, unreachable or has no address, leaving the mode unchanged. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > reports a cached Brand footer while Brand is unreachable or no longer configured

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "brand",
    "effective": {
      "source": "brand_cached",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": "Brand Ltd",
      "brandKitRef": "bk_1",
      "brandVersionRef": "bkv_3",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": {
      "kitRef": "bk_1",
      "versionRef": "bkv_3",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": "Brand Ltd"
    },
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": false,
    "reason": "unreachable"
  }
}

Source test: sending.compliance.* actions > reports a cached Brand footer while Brand is unreachable or no longer configured. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > refuses to copy when there is no Brand footer, leaving the mode connected

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "brand",
    "effective": {
      "source": null,
      "postalAddress": null,
      "optOutText": null,
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [
        "postal_address_missing",
        "opt_out_text_missing"
      ],
      "complete": false
    },
    "manual": {
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": {
      "kitRef": "bk_1",
      "versionRef": "bkv_3",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": "Brand Ltd"
    },
    "missing": [
      "postal_address_missing",
      "opt_out_text_missing"
    ],
    "complete": false
  },
  "brand": {
    "available": false,
    "reason": "not_bound"
  }
}

Source test: sending.compliance.* actions > refuses to copy when there is no Brand footer, leaving the mode connected. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > gets the manual footer, what is missing and whether Brand is available, without calling Brand

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": null,
      "optOutText": null,
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [
        "postal_address_missing",
        "opt_out_text_missing"
      ],
      "complete": false
    },
    "manual": {
      "postalAddress": null,
      "optOutText": null,
      "source": null,
      "updatedAt": null
    },
    "senderNameOverride": null,
    "lastBrandResolve": null,
    "missing": [
      "postal_address_missing",
      "opt_out_text_missing"
    ],
    "complete": false
  },
  "brand": {
    "available": false,
    "reason": "not_configured"
  }
}

Source test: sending.compliance.* actions > gets the manual footer, what is missing and whether Brand is available, without calling Brand. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > gets the manual footer, what is missing and whether Brand is available, without calling Brand

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "manual",
      "updatedAt": null
    },
    "senderNameOverride": null,
    "lastBrandResolve": null,
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": true,
    "reason": null
  }
}

Source test: sending.compliance.* actions > gets the manual footer, what is missing and whether Brand is available, without calling Brand. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > reports a cached Brand footer while Brand is unreachable or no longer configured

Action input

{}

Actual local response

{
  "compliance": {
    "mode": "brand",
    "effective": {
      "source": "brand_cached",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": "Brand Ltd",
      "brandKitRef": "bk_1",
      "brandVersionRef": "bkv_3",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Example Ltd\n1 Example Street\nLondon",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": {
      "kitRef": "bk_1",
      "versionRef": "bkv_3",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": "Brand Ltd"
    },
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": false,
    "reason": "not_configured"
  }
}

Source test: sending.compliance.* actions > reports a cached Brand footer while Brand is unreachable or no longer configured. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Get the workspace compliance footer appended to every outreach email. mode is manual (Engage-owned values) or brand (connected live to the workspace Brand kit). effective is the footer the next rendered message gets, with its source: manual, brand (resolved live now) or brand_cached (the last-known-good Brand resolve, used while Brand is unreachable). manual holds the Engage-owned values, kept unchanged while connected. lastBrandResolve is the last successful Brand resolve (kit, version, time). While postal_address_missing or opt_out_text_missing is listed the runner holds every message and sends nothing; in brand mode that happens when Brand never resolved or the kit has no registered address, and manual values are never used instead. brand.available and brand.reason (not_configured, unreachable, not_bound) say whether Brand can be used; Brand is optional and never required to send.

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

No refusal response for this action is present in the selected capture set.

Error recovery

Evidence and limits

  • /api/sending-settings/compliance

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