Update attribution settings

Outcome

Change how conversions are credited: goalEventTypes (1-10 lifecycle event types, e.g. purchase, subscription_changed, mql), windowDays (1-90) and basis (send or click). Only the fields sent change. Reports are computed on read, so every report, past periods included, uses the new settings immediately; nothing stored is rewritten.

Before you start

• Verify identity and pin the intended organization and environment before discovering the action.
• Discover a granted Nurture workspace. The application permission is workspace:write; required workspace access is admin. A permission alone does not supply a workspace grant.
• Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
• Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.attribution_settings.update --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

PATCH /api/reports/settings/attribution

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "goalEventTypes": {
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "signup",
          "trial_started",
          "trial_ending",
          "form_submitted",
          "purchase",
          "subscription_changed",
          "feature_used",
          "inactive",
          "mql",
          "engage_not_now"
        ]
      }
    },
    "windowDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 90
    },
    "basis": {
      "type": "string",
      "enum": [
        "send",
        "click"
      ]
    }
  },
  "additionalProperties": false
}

Effects

• Saves the named attribution fields for the workspace; reports read them on every call.

Interpret the response

This is a configuration, diagnostic or aggregate response with no guaranteed resource identifier. Inspect its complete values and verify the outcome with the corresponding read action.

Call app_topolo_nurture.attribution_settings.get and confirm the changed fields.

Exact success schema:

{
  "type": "object",
  "required": [
    "attribution"
  ],
  "properties": {
    "attribution": {
      "type": "object",
      "required": [
        "goalEventTypes",
        "windowDays",
        "basis",
        "model"
      ],
      "properties": {
        "goalEventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "windowDays": {
          "type": "integer"
        },
        "basis": {
          "type": "string",
          "enum": [
            "send",
            "click"
          ]
        },
        "model": {
          "type": "string",
          "enum": [
            "last_touch"
          ]
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "updatedBy": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "windowDays": 3
}

CLI:

topolo actions validate app_topolo_nurture.attribution_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.attribution_settings.update",
    "input": {
      "windowDays": 3
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "attribution": {
    "goalEventTypes": [
      "purchase"
    ],
    "windowDays": 3,
    "basis": "send",
    "model": "last_touch",
    "updatedAt": "2026-10-04T00:32:35.386Z",
    "updatedBy": "u2"
  }
}

HTTP 200. Call app_topolo_nurture.attribution_settings.get and confirm the changed fields.

Another supported request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "basis": "click"
}

CLI:

topolo actions validate app_topolo_nurture.attribution_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.attribution_settings.update",
    "input": {
      "basis": "click"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "attribution": {
    "goalEventTypes": [
      "purchase"
    ],
    "windowDays": 14,
    "basis": "click",
    "model": "last_touch",
    "updatedAt": "2026-10-12T09:00:00.000Z",
    "updatedBy": "u1"
  }
}

HTTP 200. Call app_topolo_nurture.attribution_settings.get and confirm the changed fields.

Refused request · permission_denied

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "windowDays": 3
}

CLI:

topolo actions validate app_topolo_nurture.attribution_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

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

HTTP 403. Preserve the refusal details and do not claim success.

Refused request · invalid_input

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "goalEventTypes": []
}

CLI:

topolo actions validate app_topolo_nurture.attribution_settings.update --data @payload.json --json
topolo actions plan app_topolo_nurture.attribution_settings.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "origin": "array",
        "code": "too_small",
        "minimum": 1,
        "inclusive": true,
        "path": [
          "goalEventTypes"
        ],
        "message": "Too small: expected array to have >=1 items"
      }
    ]
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Verify the result

• Call app_topolo_nurture.attribution_settings.get and confirm the changed fields.

Errors and recovery

• organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
• permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
• workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
• invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

Read the settings first, then send the previous values back through update.

Related actions

• Get workspace report: Report the whole Nurture workspace: headline conversions and revenue, clicks and delivery engagement, opens (with a privacy caveat), and breakdowns by journey/broadcast (bySource) and template (byTemplate). Covers messages sent in the last days (default 30, max 365). Conversions are goal lifecycle events (attribution_settings, default purchase) credited last-touch: the latest send (or click, basis click) to that contact within windowDays before the event gets it and its revenue (properties amountMinor + currency, summed per currency). Engagement is unique per send. Opens only count with open tracking on and are approximate (opens.caveat); judge on conversions and revenue.
• Update attribution settings: Change how conversions are credited: goalEventTypes (1-10 lifecycle event types, e.g. purchase, subscription_changed, mql), windowDays (1-90) and basis (send or click). Only the fields sent change. Reports are computed on read, so every report, past periods included, uses the new settings immediately; nothing stored is rewritten.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.