Topolo Docs Topolo Platform
Open workspace

Update manual compliance footer

Set the Engage-owned (manual) footer values (manual.source becomes manual). postalAddress (multi-line, up to 500 characters) and optOutText (one line, up to 300) are both required; senderNameOverride (up to 120) replaces the seat display name in {{sender_name}} in both modes, null clears it. In brand mode the values are stored but the Brand kit footer stays effective until sending.compliance.disconnect_brand. Messages already rendered keep their footer; held messages pick the new one up on the next run. Verify with sending.compliance.get; roll back by updating with the previous values.

Outcome

Set the Engage-owned (manual) footer values (manual.source becomes manual). postalAddress (multi-line, up to 500 characters) and optOutText (one line, up to 300) are both required; senderNameOverride (up to 120) replaces the seat display name in {{sender_name}} in both modes, null clears it. In brand mode the values are stored but the Brand kit footer stays effective until sending.compliance.disconnect_brand. Messages already rendered keep their footer; held messages pick the new one up on the next run. Verify with sending.compliance.get; roll back by updating with the previous values.

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.update --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
postalAddressYes{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\u0000-\\u0009\\u000b-\\u001f\\u007f]+$"}
optOutTextYes{"type":"string","minLength":1,"maxLength":300,"pattern":"^[^\\u0000-\\u001f\\u007f]+$"}
senderNameOverrideNo{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\u0000-\\u001f\\u007f]+$"},{"type":"null"}]}

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.update --data @payload.json --json
topolo actions plan app_topolo_engage.sending.compliance.update --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.update --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 · runDueSends > renders the footer from manual settings and the sender name override, with Brand down

Action input

{
  "postalAddress": "Acme Ltd\n2 Road\nLeeds",
  "optOutText": "Reply stop to opt out.",
  "senderNameOverride": "Ash at Acme"
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Acme Ltd\n2 Road\nLeeds",
      "optOutText": "Reply stop to opt out.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Acme Ltd\n2 Road\nLeeds",
      "optOutText": "Reply stop to opt out.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": "Ash at Acme",
    "lastBrandResolve": null,
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": true,
    "reason": null
  }
}

Source test: runDueSends > renders the footer from manual settings and the sender name override, with Brand down. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > saves manual values and keeps sending settings

Action input

{
  "postalAddress": "Acme\n\n Leeds",
  "optOutText": "Reply stop.",
  "senderNameOverride": "Ash"
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Acme\nLeeds",
      "optOutText": "Reply stop.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Acme\nLeeds",
      "optOutText": "Reply stop.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": "Ash",
    "lastBrandResolve": null,
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": false,
    "reason": "not_configured"
  }
}

Source test: sending.compliance.* actions > saves manual values and keeps sending settings. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > connects to Brand: live footer with kit and version, manual values kept and cached as last-known-good

Action input

{
  "postalAddress": "Kept Ltd",
  "optOutText": "Kept."
}

Actual local response

{
  "compliance": {
    "mode": "brand",
    "effective": {
      "source": "brand",
      "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": "Kept Ltd",
      "optOutText": "Kept.",
      "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 > connects to Brand: live footer with kit and version, manual values kept and cached as last-known-good. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending.compliance.* actions > saves manual values and keeps sending settings

Action input

{
  "postalAddress": "Acme",
  "optOutText": "Reply stop."
}

Actual local response

{
  "compliance": {
    "mode": "manual",
    "effective": {
      "source": "manual",
      "postalAddress": "Acme",
      "optOutText": "Reply stop.",
      "legalName": null,
      "brandKitRef": null,
      "brandVersionRef": null,
      "resolvedAt": null,
      "missing": [],
      "complete": true
    },
    "manual": {
      "postalAddress": "Acme",
      "optOutText": "Reply stop.",
      "source": "manual",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    "senderNameOverride": null,
    "lastBrandResolve": null,
    "missing": [],
    "complete": true
  },
  "brand": {
    "available": false,
    "reason": "not_configured"
  }
}

Source test: sending.compliance.* actions > saves manual values and keeps sending settings. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Set the Engage-owned (manual) footer values (manual.source becomes manual). postalAddress (multi-line, up to 500 characters) and optOutText (one line, up to 300) are both required; senderNameOverride (up to 120) replaces the seat display name in {{sender_name}} in both modes, null clears it. In brand mode the values are stored but the Brand kit footer stays effective until sending.compliance.disconnect_brand. Messages already rendered keep their footer; held messages pick the new one up on the next run. Verify with sending.compliance.get; roll back by updating with the previous values.

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

Refused input; do not execute

{
  "postalAddress": "Acme"
}

Actual local response

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

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

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

Action input

{
  "postalAddress": "A",
  "optOutText": "x"
}

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

{
  "postalAddress": "Acme",
  "optOutText": "one\ntwo"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for sending.compliance.update is invalid.",
    "details": [
      {
        "origin": "string",
        "code": "invalid_format",
        "format": "regex",
        "pattern": "/^[^\\u0000-\\u001f\\u007f]+$/",
        "path": [
          "optOutText"
        ],
        "message": "Use a single line of plain text."
      }
    ]
  }
}

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

{
  "postalAddress": "  ",
  "optOutText": "x"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for sending.compliance.update is invalid.",
    "details": [
      {
        "origin": "string",
        "code": "too_small",
        "minimum": 1,
        "inclusive": true,
        "path": [
          "postalAddress"
        ],
        "message": "Too small: expected string to have >=1 characters"
      },
      {
        "origin": "string",
        "code": "invalid_format",
        "format": "regex",
        "pattern": "/^[^\\u0000-\\u0009\\u000b-\\u001f\\u007f]+$/",
        "path": [
          "postalAddress"
        ],
        "message": "Use plain text; line breaks are allowed."
      }
    ]
  }
}

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

{
  "postalAddress": "A",
  "optOutText": "x",
  "extra": 1
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for sending.compliance.update is invalid.",
    "details": [
      {
        "code": "unrecognized_keys",
        "keys": [
          "extra"
        ],
        "path": [],
        "message": "Unrecognized key: \"extra\""
      }
    ]
  }
}

Source test: sending.compliance.* actions > validates input and permission. 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.
  • 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.

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.