Outcome
Make one arm the winner. It must be results.recommendedWinner (significant at 95%) unless override is true with an overrideReason; the override, reason and acting user are recorded. Broadcast with testPercent: the winner is queued for every remaining contact and the broadcast resumes sending (it must be sending or sent). Journey: the draft's split node is set to 100% winner (other arms weight 0, no holdout); publish the journey to make it live, as published versions never change. The experiment ends as promoted.
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 read_write. 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.experiments.promote --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.experiments.list --detail --json
id: experiments record id in the selected workspace.
Request
POST /api/experiments/{id}/promote
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
| Field | Required | Type | Constraints |
|---|---|---|---|
id | Required | string | experiments record id in the selected workspace. {"minLength":1,"maxLength":64} |
arm | Required | string | {"pattern":"^[a-z0-9][a-z0-9_-]{0,31}$"} |
override | Optional | boolean | {} |
overrideReason | Optional | string | {"minLength":1,"maxLength":500} |
Exact input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"arm": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,31}$"
},
"override": {
"type": "boolean"
},
"overrideReason": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"id",
"arm"
],
"additionalProperties": false
}
Effects
- Sets status promoted with winnerArm, promotedBy, promotedAt, promotionOverride and overrideReason.
- Broadcast with testPercent: inserts the remainder as pending recipients on the winning variant and moves the broadcast to sending; they go out through eligibility like every recipient (remainderRecipients counts them).
- Journey: saves a new journey draft with the split at 100% winner; nothing changes for live enrollments until journeys.publish.
Interpret the response
The returned identifier path is $.experiment.id for experiment. Empty lists do not discover a target.
Call app_topolo_nurture.experiments.get and confirm status promoted and winnerArm; for journeys call journeys.get and confirm the split weights.
Exact success schema:
{
"type": "object",
"required": [
"experiment",
"decision",
"overridden"
],
"properties": {
"experiment": {
"type": "object",
"required": [
"id",
"kind",
"status",
"arms",
"controlArm",
"goal"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"broadcast",
"journey"
]
},
"broadcastId": {
"type": [
"string",
"null"
]
},
"journeyId": {
"type": [
"string",
"null"
]
},
"nodeId": {
"type": [
"string",
"null"
]
},
"arms": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"weight"
],
"properties": {
"key": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"weight": {
"type": "integer"
},
"variant": {
"type": "object"
}
}
}
},
"controlArm": {
"type": "string"
},
"holdoutPercent": {
"type": "integer"
},
"testPercent": {
"type": [
"integer",
"null"
]
},
"goal": {
"type": "object",
"required": [
"kind",
"windowHours"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"event",
"click"
]
},
"eventType": {
"type": "string"
},
"urlPrefix": {
"type": [
"string",
"null"
]
},
"windowHours": {
"type": "integer"
}
}
},
"minSamplePerArm": {
"type": "integer"
},
"confidenceLevel": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"active",
"stopped",
"promoted"
]
},
"winnerArm": {
"type": [
"string",
"null"
]
},
"promotedBy": {
"type": [
"string",
"null"
]
},
"promotedAt": {
"type": [
"string",
"null"
]
},
"promotionOverride": {
"type": "boolean"
},
"overrideReason": {
"type": [
"string",
"null"
]
},
"remainderRecipients": {
"type": [
"integer",
"null"
]
},
"stoppedBy": {
"type": [
"string",
"null"
]
},
"stoppedAt": {
"type": [
"string",
"null"
]
},
"stopReason": {
"type": [
"string",
"null"
]
},
"createdBy": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"decision": {
"type": "string",
"enum": [
"winner",
"control_wins",
"insufficient_sample",
"no_significant_difference"
]
},
"overridden": {
"type": "boolean"
}
}
}
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:
{
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"arm": "question",
"override": true,
"overrideReason": "Launch deadline"
}
CLI:
topolo actions validate app_topolo_nurture.experiments.promote --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.promote --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.experiments.promote --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.experiments.promote",
"input": {
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"arm": "question",
"override": true,
"overrideReason": "Launch deadline"
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"experiment": {
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"name": "Subject test",
"kind": "broadcast",
"broadcastId": "bc_9194b079231e4246b56ba9a260d4b399",
"journeyId": null,
"nodeId": null,
"arms": [
{
"key": "control",
"label": null,
"weight": 50,
"variant": {}
},
{
"key": "question",
"label": "Question subject",
"weight": 50,
"variant": {
"templateVersion": 1,
"subject": "Ready?"
}
}
],
"controlArm": "control",
"holdoutPercent": 20,
"testPercent": 50,
"goal": {
"kind": "event",
"eventType": "purchase",
"windowHours": 72
},
"minSamplePerArm": 100,
"confidenceLevel": 0.95,
"status": "promoted",
"winnerArm": "question",
"promotedBy": "u2",
"promotedAt": "2026-10-01T09:00:00.000Z",
"promotionOverride": true,
"overrideReason": "Launch deadline",
"remainderRecipients": 21,
"stoppedBy": null,
"stoppedAt": null,
"stopReason": null,
"createdBy": "u1",
"createdAt": "2026-10-04T00:32:35.068Z",
"updatedAt": "2026-10-04T00:32:35.282Z"
},
"decision": "insufficient_sample",
"overridden": true
}
HTTP 200. Call app_topolo_nurture.experiments.get and confirm status promoted and winnerArm; for journeys call journeys.get and confirm the split weights.
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:
{
"id": "exp_41afd28d70724d678a329ee6bb478a54",
"arm": "control",
"override": true,
"overrideReason": "Keep it"
}
CLI:
topolo actions validate app_topolo_nurture.experiments.promote --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.promote --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.experiments.promote --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.experiments.promote",
"input": {
"id": "exp_41afd28d70724d678a329ee6bb478a54",
"arm": "control",
"override": true,
"overrideReason": "Keep it"
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"experiment": {
"id": "exp_41afd28d70724d678a329ee6bb478a54",
"name": "Subject test",
"kind": "broadcast",
"broadcastId": "bc_982e00778f594bae9cc4b6483ff552a6",
"journeyId": null,
"nodeId": null,
"arms": [
{
"key": "control",
"label": null,
"weight": 50,
"variant": {}
},
{
"key": "question",
"label": "Question subject",
"weight": 50,
"variant": {
"templateVersion": 1,
"subject": "Ready?"
}
}
],
"controlArm": "control",
"holdoutPercent": 0,
"testPercent": null,
"goal": {
"kind": "event",
"eventType": "purchase",
"windowHours": 72
},
"minSamplePerArm": 100,
"confidenceLevel": 0.95,
"status": "promoted",
"winnerArm": "control",
"promotedBy": "u1",
"promotedAt": "2026-10-01T09:00:00.000Z",
"promotionOverride": true,
"overrideReason": "Keep it",
"remainderRecipients": null,
"stoppedBy": "u1",
"stoppedAt": "2026-10-01T09:00:00.000Z",
"stopReason": null,
"createdBy": "u1",
"createdAt": "2026-10-04T00:32:35.384Z",
"updatedAt": "2026-10-04T00:32:35.408Z"
},
"decision": "insufficient_sample",
"overridden": true
}
HTTP 200. Call app_topolo_nurture.experiments.get and confirm status promoted and winnerArm; for journeys call journeys.get and confirm the split weights.
Refused request · not_significant
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:
{
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"arm": "question"
}
CLI:
topolo actions validate app_topolo_nurture.experiments.promote --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.promote --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 409:
{
"error": {
"code": "not_significant",
"message": "This arm is not a significant winner; wait for more data, or pass override with a reason.",
"details": {
"decision": "insufficient_sample",
"recommendedWinner": null
}
}
}
HTTP 409. Preserve the refusal details and do not claim success.
Refused request · unknown_arm
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:
{
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"arm": "nope"
}
CLI:
topolo actions validate app_topolo_nurture.experiments.promote --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.promote --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 422:
{
"error": {
"code": "unknown_arm",
"message": "\"nope\" is not an arm of this experiment.",
"details": {
"arms": [
"control",
"question"
]
}
}
}
HTTP 422. Preserve the refusal details and do not claim success.
Refused request · invalid_status
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:
{
"id": "exp_e6a4ff5a74cb4129922a9c41aca79ca9",
"arm": "control",
"override": true,
"overrideReason": "x"
}
CLI:
topolo actions validate app_topolo_nurture.experiments.promote --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.promote --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 409:
{
"error": {
"code": "invalid_status",
"message": "The experiment is promoted.",
"details": {
"status": "promoted"
}
}
}
HTTP 409. Preserve the refusal details and do not claim success.
Verify the result
- Call app_topolo_nurture.experiments.get and confirm status promoted and winnerArm; for journeys call journeys.get and confirm the split weights.
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.not_found(HTTP 404): List experiments to find a valid id in this workspace.invalid_status(HTTP 409): Read the experiment with app_topolo_nurture.experiments.get; only an active experiment can be stopped, and a promoted one is final.unknown_arm(HTTP 422): Pass one of the arm keys in error.details.arms.override_reason_required(HTTP 422): Pass overrideReason with override.not_significant(HTTP 409): Wait for more data (app_topolo_nurture.experiments.results), or promote with override and a reason after the user agrees.broadcast_not_sending(HTTP 409): Promote once the broadcast has launched; a cancelled or failed broadcast cannot send the remainder.journey_archived(HTTP 409): The journey is archived; nothing can be promoted into it.split_node_not_found(HTTP 409): Restore the split node (with the winning arm) in the journey draft, 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
Promotion is final and remainder sends cannot be recalled; for a journey, edit the draft split weights back before publishing.
Related actions
- Get experiment: Read one experiment: what it tests (broadcast, or journey and split node), its arms, control, holdout and test shares, goal, minimum sample, status and, once promoted, the winner, who promoted it and whether significance was overridden (with the reason).
- Get broadcast progress: Read delivery progress: the broadcast status, total recipients, counts per recipient status, processed (sent_intended + skipped + failed), progress 0-1, and how many recipients were skipped for each reason.
- Publish journey version: Freeze the current draft as the next immutable version and make it live: new trigger matches and manual enrollments use it from now on. Existing enrollments stay pinned to the version they entered on. Refused when the draft is invalid or unchanged since the last publish.
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.