Topolo Docs Topolo Platform
Open workspace

Disconnect compliance footer from Brand kit

Switch the footer back to manual mode: messages rendered from now on use the Engage-owned manual values. With copyToManual true, the current Brand footer (resolved live, else the last-known-good resolve) is first copied into the manual values (manual.source becomes brand); 409 brand_footer_unavailable when there is no Brand footer to copy, and the mode is unchanged. Already rendered and approved messages keep their footer. Disconnecting a workspace already in manual mode changes nothing. Verify with sending.compliance.get (mode manual); roll back with sending.compliance.connect_brand.

Outcome

Switch the footer back to manual mode: messages rendered from now on use the Engage-owned manual values. With copyToManual true, the current Brand footer (resolved live, else the last-known-good resolve) is first copied into the manual values (manual.source becomes brand); 409 brand_footer_unavailable when there is no Brand footer to copy, and the mode is unchanged. Already rendered and approved messages keep their footer. Disconnecting a workspace already in manual mode changes nothing. Verify with sending.compliance.get (mode manual); roll back with sending.compliance.connect_brand.

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

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
copyToManualNo{"type":"boolean"}

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.disconnect_brand --data @payload.json --json
topolo actions plan app_topolo_engage.sending.compliance.disconnect_brand --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.sending.compliance.disconnect_brand --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 · sending.compliance.* actions > disconnects back to manual, keeping manual values, and is a no-op when already manual

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 > disconnects back to manual, keeping manual values, and is a no-op when already manual. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > disconnects copying the current Brand values into the manual values

Action input

{
  "copyToManual": true
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "New Ltd",
      "optOutText": "Test opt-out sentence for fixtures.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "New Ltd",
      "optOutText": "Test opt-out sentence for fixtures.",
      "source": "brand",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": {
      "kitRef": "bk_1",
      "versionRef": "bkv_4",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "postalAddress": "New Ltd",
      "optOutText": null,
      "legalName": null
    },
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": true,
    "reason": null
  }
}

Source test: sending.compliance.* actions > disconnects copying the current Brand values into the manual values. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > copies the cached Brand values while Brand is down, keeping a manual address the kit lacks

Action input

{
  "copyToManual": true
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Brand opt-out sentence.",
      "source": "brand",
      "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": true,
    "reason": null
  }
}

Source test: sending.compliance.* actions > copies the cached Brand values while Brand is down, keeping a manual address the kit lacks. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > disconnects back to manual, keeping manual values, and is a no-op when already manual

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": "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": true,
    "reason": null
  }
}

Source test: sending.compliance.* actions > disconnects back to manual, keeping manual values, and is a no-op when already manual. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > copies the cached Brand values while Brand is down, keeping a manual address the kit lacks

Action input

{
  "copyToManual": true
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Only opt-out.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Brand Ltd\n9 Lane\nBath",
      "optOutText": "Only opt-out.",
      "source": "brand",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": {
      "kitRef": "bk_1",
      "versionRef": "bkv_9",
      "resolvedAt": "2026-10-06T08:30:00.000Z",
      "postalAddress": null,
      "optOutText": "Only opt-out.",
      "legalName": null
    },
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": true,
    "reason": null
  }
}

Source test: sending.compliance.* actions > copies the cached Brand values while Brand is down, keeping a manual address the kit lacks. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Switch the footer back to manual mode: messages rendered from now on use the Engage-owned manual values. With copyToManual true, the current Brand footer (resolved live, else the last-known-good resolve) is first copied into the manual values (manual.source becomes brand); 409 brand_footer_unavailable when there is no Brand footer to copy, and the mode is unchanged. Already rendered and approved messages keep their footer. Disconnecting a workspace already in manual mode changes nothing. Verify with sending.compliance.get (mode manual); roll back with sending.compliance.connect_brand.

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 403 · sending.compliance.* actions > validates input and permission

Action input

{}

Actual local response

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

Source test: sending.compliance.* actions > validates input and permission. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · sending.compliance.* actions > validates input and permission

Refused input; do not execute

{
  "copyToManual": "yes"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for sending.compliance.disconnect_brand is invalid.",
    "details": [
      {
        "expected": "boolean",
        "code": "invalid_type",
        "path": [
          "copyToManual"
        ],
        "message": "Invalid input: expected boolean, received string"
      }
    ]
  }
}

Source test: sending.compliance.* actions > validates input and permission. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Action input

{
  "copyToManual": true
}

Actual local response

{
  "error": {
    "code": "brand_footer_unavailable",
    "message": "There is no Brand footer to copy. The footer is still connected to Brand; disconnect without copying instead."
  }
}

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.

Error recovery

  • 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 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.
  • HTTP 409 brand_footer_unavailable: Preserve the request and inspect the declared dependency state. Retry only after the transient or configuration cause is resolved; do not infer that the operation completed.

Evidence and limits

  • /api/sending-settings/compliance/disconnect-brand

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