Record a batch failure

For an active batch, records a failure row and changes that batch to paused. It does not pause or archive the campaign.

Outcome and boundaries

For an active batch, records a failure row and changes that batch to paused. It does not pause or archive the campaign.

Schedules a background failure notification attempt; the HTTP result is not delivery proof.

Before you start

• Confirm the intended environment and current credential organization using whoami; discover the exact application/action before any call.
• Required application permission: app_topolo_campaigns.campaigns:write. Catalog discoverability is not permission to execute.
• Discover an authorized canonical workspace and bind resourceType workspace/resourceId separately from action input.
• All worked cases in this guide are hypothetical source-reviewed illustrations; no business action, live fixture, customer data or provider request was executed.
• Canonical workspace minimum access is read_write in addition to the application permission. After grant verification, the first request may create an app-local identity/recipient mirror even before the later app-permission check; this is not campaign-domain completion.

Discover the intended identifiers

• Read campaigns.get and batches.list in the same workspace; select an active batch.

Action: app_topolo_campaigns.batches.fail · POST /api/campaigns/{id}/batches/{batchId}/fail.

Input fields

Safe call sequence

Write the reviewed input to payload.json; fixture identifiers below are unusable examples. Validate before planning, bind the discovered resource separately, and execute only within actual authority.

topolo actions validate app_topolo_campaigns.batches.fail --data @payload.json --json
topolo actions plan app_topolo_campaigns.batches.fail --resource-type workspace --resource-id "$CAMPAIGNS_WORKSPACE_ID" --data @payload.json --json

The published action requires confirmation. Only after the exact mutation is authorized, use that same payload/context with --confirm on plan/call; no operation in this guide has been executed.

Worked cases

Every response below is synthetic and source-reviewed, not captured. HTTP status and body are explained independently; a structurally valid body alone never proves successful execution. Middleware may add a different error envelope.

Fail an active batch · HTTP 201

Input:

{
  "id": "campaign_example",
  "batchId": "batch_example",
  "reason": "Illustrative supplier rejection"
}

Illustrative response:

{
  "failure": {
    "id": "batch_failure_example",
    "batchId": "batch_example",
    "campaignId": "campaign_example",
    "batchName": "Illustrative print run",
    "reason": "Illustrative supplier rejection",
    "occurredAt": "2026-10-20T00:00:00.000Z"
  }
}

Draft or already-paused batch · HTTP 400

Input:

{
  "id": "campaign_example",
  "batchId": "batch_example",
  "reason": "Illustrative reason"
}

Illustrative response:

{
  "error": "batch_not_running"
}

Repeating this call on the now-paused batch does not create a second success.

Missing batch · HTTP 404

Input:

{
  "id": "campaign_example",
  "batchId": "batch_absent",
  "reason": "Illustrative reason"
}

Illustrative response:

{
  "error": "batch_not_found"
}

Verify the outcome

• Read batches.list and confirm the selected batch is paused. Read campaigns.get separately; do not infer its status changed.

Refusals and recovery

• HTTP 404 batch_not_found: Correct the named input or retain the authoritative refusal in the same context.
• HTTP 400 batch_not_running: Correct the named input or retain the authoritative refusal in the same context.
• HTTP 400 reason_required: Correct the named input or retain the authoritative refusal in the same context.
• HTTP 403 forbidden: Raw handler permission refusal. SDKs can normalize it to permission_denied. Keep the same intended resource; do not widen access.
• HTTP 403 workspace_forbidden: The canonical workspace grant refused the selected resource. Resolve it with the access owner, not a guessed workspace.

After resolving the batch issue and reviewing its current state, update that batch if authorized. This does not remove the failure record or retract notifications; do not reactivate a campaign merely to compensate for this batch-only effect.

Source and catalog limits

Published title/effects/verification/recovery claim the campaign pauses. Exact source updates campaigns_batches only. This is a source/catalog contract discrepancy, not a claim of current deployed behavior.

Exact schemas and provenance

Input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "batchId": {
      "type": "string",
      "minLength": 1
    },
    "reason": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id",
    "batchId",
    "reason"
  ],
  "additionalProperties": false
}

Output schema:

{
  "type": "object",
  "title": "Record batch failure response",
  "description": "Operation result returned by batches.fail.",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "title": "batch record",
          "properties": {
            "id": {
              "type": "string",
              "description": "Stable identifier when the batch exposes one."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "additionalProperties": true
        }
      ]
    },
    "result": {
      "type": "object",
      "additionalProperties": true
    },
    "message": {
      "type": "string"
    }
  },
  "additionalProperties": true,
  "x-topolo-contract-source": "derived-action-metadata",
  "x-topolo-contract-precision": "structural"
}

Reviewed immutable source: TopoloCampaigns@cacbb8b12b4e19a662cf82d03a927aef3c3a35e8, apps/api/src/campaign-orchestration-store.ts. Fresh production catalog was read on 2026-10-20. Its publication metadata is not proof that this source is loaded. Output examples are not widened or rewritten to force schema success; the accompanying validation record classifies exact success, refusal, no-body and structural-schema limits.

Related actions

• List campaign batches — Campaigns: Lists batch metadata for the selected campaign, newest updates first. An empty array can also mean that the campaign id is absent or outside the bound workspace; this read does not verify campaign existence.
• Update a campaign batch — Campaigns: Changes stored batch name, status or plannedCount. The source accepts the declared status set without an active-only transition guard. An update advances updatedAt even when no effective field changes.
• Get campaign — Campaigns: Reads one non-deleted campaign in the bound organization and workspace. An absent or differently scoped campaign returns HTTP 404 campaign_not_found.

Local input rejection example

This deliberately invalid input belongs to a pure schema check; it is never a planned or executed request. The closed action input schema must reject the extra field. It has no HTTP status or server response.

{
  "id": "campaign_example",
  "batchId": "batch_example",
  "reason": "Illustrative supplier rejection",
  "__unsupported_field": true
}

The hidden companion labels this as ILLUSTRATIVE_LOCAL_SCHEMA_CHECK; its validation representation is not an action output.

Published output validation limits

Current published output qualification: the output schema accepts an empty object, a partial success marker, a partial data object and a refusal body. It therefore establishes only broad structure. Require the documented HTTP/domain result and source-shaped fields; missing fields or a schema-valid error are not success.

These observations come from pure checks of the exact published schema; they are not server responses or production captures.