Topolo Docs Topolo Platform
Open workspace

Get sending settings

Get the workspace sending settings: the global daily cap, the recipient-local send window (ISO weekdays, 1 = Monday, start and end time, fallback time zone also used to count the workspace's day), seat-health thresholds, how many silent days close an enrollment after its last step, and the approval look-ahead (hours before its send time a message is rendered and queued for approval, default 24). Defaults apply until saved.

Outcome

Get the workspace sending settings: the global daily cap, the recipient-local send window (ISO weekdays, 1 = Monday, start and end time, fallback time zone also used to count the workspace's day), seat-health thresholds, how many silent days close an enrollment after its last step, and the approval look-ahead (hours before its send time a message is rendered and queued for approval, default 24). Defaults apply until saved.

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.settings.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.settings.get --data @payload.json --json
topolo actions plan app_topolo_engage.sending.settings.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.settings.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 · captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access

Action input

{}

Actual local response

{
  "settings": {
    "globalDailyCap": 100,
    "windowWeekdays": [
      2,
      3,
      4
    ],
    "windowStart": "08:00",
    "windowEnd": "11:00",
    "fallbackTimezone": "Europe/London",
    "healthWindowDays": 14,
    "healthMinSent": 20,
    "healthMaxBounceRate": 0.02,
    "healthMaxOptOutRate": 0.05,
    "closeAfterDays": 12,
    "approvalLookaheadHours": 24,
    "updatedAt": "2026-10-01T00:00:00.000Z"
  }
}

Source test: captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sending settings routes > saves settings (weekdays de-duplicated and sorted) and replaces them

Action input

{}

Actual local response

{
  "settings": {
    "globalDailyCap": 100,
    "windowWeekdays": [
      2,
      3,
      4
    ],
    "windowStart": "08:00",
    "windowEnd": "11:00",
    "fallbackTimezone": "Europe/London",
    "healthWindowDays": 14,
    "healthMinSent": 20,
    "healthMaxBounceRate": 0.02,
    "healthMaxOptOutRate": 0.05,
    "closeAfterDays": 12,
    "approvalLookaheadHours": 24,
    "updatedAt": null
  }
}

Source test: sending settings routes > saves settings (weekdays de-duplicated and sorted) and replaces them. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access

Action input

{}

Actual local response

{
  "settings": {
    "globalDailyCap": 75,
    "windowWeekdays": [
      1,
      2,
      3,
      4,
      5
    ],
    "windowStart": "09:00",
    "windowEnd": "17:00",
    "fallbackTimezone": "Europe/London",
    "healthWindowDays": 14,
    "healthMinSent": 20,
    "healthMaxBounceRate": 0.02,
    "healthMaxOptOutRate": 0.05,
    "closeAfterDays": 12,
    "approvalLookaheadHours": 48,
    "updatedAt": "2026-10-06T08:30:00.000Z"
  }
}

Source test: captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access

Action input

{}

Actual local response

{
  "settings": {
    "globalDailyCap": 75,
    "windowWeekdays": [
      1,
      2,
      3,
      4,
      5
    ],
    "windowStart": "09:00",
    "windowEnd": "17:00",
    "fallbackTimezone": "Europe/London",
    "healthWindowDays": 14,
    "healthMinSent": 20,
    "healthMaxBounceRate": 0.02,
    "healthMaxOptOutRate": 0.05,
    "closeAfterDays": 12,
    "approvalLookaheadHours": 24,
    "updatedAt": "2026-10-06T08:30:00.000Z"
  }
}

Source test: captures real settings routes, schema refusals, permissions, scope, read-back and recovery without network access. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Get the workspace sending settings: the global daily cap, the recipient-local send window (ISO weekdays, 1 = Monday, start and end time, fallback time zone also used to count the workspace's day), seat-health thresholds, how many silent days close an enrollment after its last step, and the approval look-ahead (hours before its send time a message is rendered and queued for approval, default 24). Defaults apply until saved.

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

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