Cancel broadcast

Cancel a broadcast that is awaiting approval, approved, scheduled or sending. Every recipient not yet processed is marked cancelled and never sent; recipients already processed keep their outcome (their consumed reservations still count toward caps). Cancelling is final.

Outcome

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.broadcasts.cancel --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.broadcasts.list --detail --json

id: broadcasts record id in the selected workspace.

Request

POST /api/broadcasts/{id}/cancel

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	broadcasts record id in the selected workspace. {"minLength":1,"maxLength":64}
`reason`	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
    },
    "reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Moves the broadcast to cancelled and marks pending recipients cancelled.

Interpret the response

The returned identifier path is $.broadcast.id for broadcast. Empty lists do not discover a target.

Call app_topolo_nurture.broadcasts.stats and confirm status cancelled and no pending recipients.

Exact success schema:

{
  "type": "object",
  "required": [
    "broadcast"
  ],
  "properties": {
    "broadcast": {
      "type": "object",
      "required": [
        "id",
        "status",
        "topicId",
        "segmentIds",
        "schedule"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "templateId": {
          "type": [
            "string",
            "null"
          ]
        },
        "templateVersion": {
          "type": [
            "integer",
            "null"
          ]
        },
        "topicId": {
          "type": "string"
        },
        "segmentIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "purpose": {
          "type": "string",
          "enum": [
            "marketing"
          ]
        },
        "schedule": {
          "type": "object",
          "required": [
            "mode"
          ],
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "now",
                "at",
                "recipient_local"
              ]
            }
          }
        },
        "throttlePerHour": {
          "type": [
            "integer",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "draft",
            "pending_approval",
            "approved",
            "scheduled",
            "sending",
            "sent",
            "cancelled",
            "failed",
            "archived"
          ]
        },
        "launchAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "totalRecipients": {
          "type": [
            "integer",
            "null"
          ]
        },
        "createdBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "submittedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "submittedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "approvedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "approvedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "rejectedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "rejectedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "rejectionReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "scheduledBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "scheduledAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "launchedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "cancelledBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "cancelledAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "cancelReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "failureReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "legacy": {
          "type": [
            "object",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    }
  }
}

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": "bc_1c98f7632c7149afaea7457b966df1a9"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.cancel --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.cancel --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.cancel --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.broadcasts.cancel",
    "input": {
      "id": "bc_1c98f7632c7149afaea7457b966df1a9"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "broadcast": {
    "id": "bc_1c98f7632c7149afaea7457b966df1a9",
    "name": "October",
    "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
    "templateVersion": 1,
    "topicId": "topic_435f69a6fed94bda858f258f5350188f",
    "segmentIds": [
      "seg_5a37efa6266547cc94ba208903123dbc"
    ],
    "purpose": "marketing",
    "schedule": {
      "mode": "now"
    },
    "throttlePerHour": null,
    "status": "cancelled",
    "launchAt": "2026-10-01T09:00:00.000Z",
    "totalRecipients": null,
    "createdBy": "u1",
    "submittedBy": "u1",
    "submittedAt": "2026-10-01T09:00:00.000Z",
    "approvedBy": "u2",
    "approvedAt": "2026-10-01T09:00:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "rejectionReason": null,
    "scheduledBy": "u1",
    "scheduledAt": "2026-10-01T09:00:00.000Z",
    "launchedAt": null,
    "completedAt": null,
    "cancelledBy": "u1",
    "cancelledAt": "2026-10-01T09:00:00.000Z",
    "cancelReason": null,
    "failureReason": null,
    "legacy": null,
    "createdAt": "2026-10-04T00:32:37.865Z",
    "updatedAt": "2026-10-04T00:32:37.866Z"
  }
}

HTTP 200. Call app_topolo_nurture.broadcasts.stats and confirm status cancelled and no pending recipients.

Another supported request

Input · payload.json:

{
  "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2",
  "reason": "Not needed"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.cancel --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.cancel --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.cancel --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.broadcasts.cancel",
    "input": {
      "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2",
      "reason": "Not needed"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "broadcast": {
    "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2",
    "name": "October",
    "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
    "templateVersion": 1,
    "topicId": "topic_435f69a6fed94bda858f258f5350188f",
    "segmentIds": [
      "seg_5a37efa6266547cc94ba208903123dbc"
    ],
    "purpose": "marketing",
    "schedule": {
      "mode": "now"
    },
    "throttlePerHour": null,
    "status": "cancelled",
    "launchAt": null,
    "totalRecipients": null,
    "createdBy": "u1",
    "submittedBy": "u1",
    "submittedAt": "2026-10-01T09:00:00.000Z",
    "approvedBy": null,
    "approvedAt": null,
    "rejectedBy": null,
    "rejectedAt": null,
    "rejectionReason": null,
    "scheduledBy": null,
    "scheduledAt": null,
    "launchedAt": null,
    "completedAt": null,
    "cancelledBy": "u2",
    "cancelledAt": "2026-10-01T09:00:00.000Z",
    "cancelReason": "Not needed",
    "failureReason": null,
    "legacy": null,
    "createdAt": "2026-10-04T00:32:37.863Z",
    "updatedAt": "2026-10-04T00:32:37.864Z"
  }
}

HTTP 200. Call app_topolo_nurture.broadcasts.stats and confirm status cancelled and no pending recipients.

Refused request · invalid_status

Input · payload.json:

{
  "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2"
}

CLI:

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

Captured local response · HTTP 409:

{
  "error": {
    "code": "invalid_status",
    "message": "The broadcast is cancelled; this action needs pending_approval or approved or scheduled or sending.",
    "details": {
      "status": "cancelled",
      "expected": [
        "pending_approval",
        "approved",
        "scheduled",
        "sending"
      ]
    }
  }
}

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

Refused request · not_found

Input · payload.json:

{
  "id": "bc_missing"
}

CLI:

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

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Broadcast was not found in this workspace."
  }
}

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

Verify the result

Call app_topolo_nurture.broadcasts.stats and confirm status cancelled and no pending recipients.

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 broadcasts to find a valid id in this workspace.
invalid_status (HTTP 409): Read the broadcast with app_topolo_nurture.broadcasts.get; error.details.expected lists the statuses this action accepts.

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

A cancelled broadcast cannot resume; create a new one for the remaining audience.

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.

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.

Cancel broadcast

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · invalid_status

Refused request · not_found

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence