Submit broadcast for approval

Submit a draft for approval. Checks that the topic and every segment are active, the schedule is still ahead, and the template renders without errors; pins the template version (the given one, else the current one) so the approver reviews exactly what will be sent. The submitter is recorded and cannot approve it.

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.submit --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}/submit

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}

Exact input schema:

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

Effects

Moves the broadcast from draft to pending_approval and pins templateVersion.

Interpret the response

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

Call app_topolo_nurture.broadcasts.get and confirm status pending_approval and submittedBy.

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.submit --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.submit --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.submit --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.submit",
    "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": "pending_approval",
    "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": null,
    "cancelledAt": null,
    "cancelReason": null,
    "failureReason": null,
    "legacy": null,
    "createdAt": "2026-10-04T00:32:37.865Z",
    "updatedAt": "2026-10-04T00:32:37.865Z"
  }
}

HTTP 200. Call app_topolo_nurture.broadcasts.get and confirm status pending_approval and submittedBy.

Another supported request

Input · payload.json:

{
  "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.submit --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.submit --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.submit --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.submit",
    "input": {
      "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2"
    },
    "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": "pending_approval",
    "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": null,
    "cancelledAt": null,
    "cancelReason": null,
    "failureReason": null,
    "legacy": null,
    "createdAt": "2026-10-04T00:32:37.863Z",
    "updatedAt": "2026-10-04T00:32:37.863Z"
  }
}

HTTP 200. Call app_topolo_nurture.broadcasts.get and confirm status pending_approval and submittedBy.

Refused request · invalid_status

Input · payload.json:

{
  "id": "bc_11e8f679c65f4b9c9db34760e8e11cb7"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.submit --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.submit --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 pending_approval; this action needs draft.",
    "details": {
      "status": "pending_approval",
      "expected": [
        "draft"
      ]
    }
  }
}

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

Refused request · template_required

Input · payload.json:

{
  "id": "bc_ae74a3160b6f49718ff1102fbf73fd41"
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "template_required",
    "message": "Choose a template for the broadcast first."
  }
}

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

Refused request · invalid_template

Input · payload.json:

{
  "id": "bc_f1aa581a971c489f9e0dce84ace034c7"
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_template",
    "message": "The template has problems that must be fixed first.",
    "details": {
      "problems": [
        {
          "path": "blocks",
          "code": "footer_required",
          "message": "A template needs exactly one unsubscribe and preference footer block.",
          "severity": "error"
        }
      ]
    }
  }
}

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

Verify the result

Call app_topolo_nurture.broadcasts.get and confirm status pending_approval and submittedBy.

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.
template_required (HTTP 422): Set templateId with app_topolo_nurture.broadcasts.update first.
invalid_template (HTTP 422): Fix each problem in error.details.problems with templates.update, then pin the new version on the draft and retry.
topic_unavailable (HTTP 422): Pick an active subscription topic from this workspace, or update the draft.
segment_unavailable (HTTP 422): Pick an active segment from this workspace, or update the draft.
template_unavailable (HTTP 422): Pick an active template from this workspace, or update the draft.
schedule_in_past (HTTP 422): Choose a later sendAt or date; for recipient_local the time must still be ahead somewhere (UTC-12).
invalid_timezone (HTTP 422): Use an IANA zone such as Europe/London for fallbackTimezone.

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

Ask an approver to reject it back to draft, or cancel it.

Approve broadcast: Approve a broadcast awaiting approval. The approver must be a different verified user from the submitter (both ids come from the caller's credential); the same user is refused with approval_requires_second_person. Approval does not send anything; schedule it next.
Reject broadcast: Return a broadcast that is awaiting approval, or already approved but not yet scheduled, to draft with a reason. The approval and submission are cleared, so it must be submitted and approved again.

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.

Submit broadcast for approval

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 · template_required

Refused request · invalid_template

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence