Create broadcast

Create a draft broadcast: a template (optionally a pinned templateVersion), a subscription topic, one to 20 segments, a schedule and an optional throttlePerHour. Purpose is always marketing. Nothing is sent; the draft must be submitted, approved by a different person, and scheduled. schedule is {mode:"now"} (default), {mode:"at", sendAt ISO-8601} or {mode:"recipient_local", date YYYY-MM-DD, time HH:MM, fallbackTimezone IANA}: recipient_local sends at that wall-clock time in each contact's own zone, using fallbackTimezone when the contact has none.

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.create --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.templates.list --detail --json
topolo actions get app_topolo_nurture.subscription_topics.list --detail --json

templateId: Nurture template id; inspect its active state and version.
topicId: Subscription topic record id; topicKey is a separate stable topic key.

Request

POST /api/broadcasts

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
`name`	Required	string	{"minLength":1,"maxLength":120}
`templateId`	Optional	string	Nurture template id; inspect its active state and version. {"minLength":1,"maxLength":64}
`templateVersion`	Optional	integer	{"minimum":1,"maximum":100000}
`topicId`	Required	string	Subscription topic record id; topicKey is a separate stable topic key. {"minLength":1,"maxLength":64}
`segmentIds`	Required	array	{"minItems":1,"maxItems":20}
`schedule`	Optional	See schema	{}
`throttlePerHour`	Optional	integer	{"minimum":1,"maximum":1000000}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "templateId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "templateVersion": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "topicId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "segmentIds": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      }
    },
    "schedule": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "const": "now"
            }
          },
          "required": [
            "mode"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "const": "at"
            },
            "sendAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          "required": [
            "mode",
            "sendAt"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "const": "recipient_local"
            },
            "date": {
              "type": "string",
              "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
            },
            "time": {
              "type": "string",
              "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
            },
            "fallbackTimezone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            }
          },
          "required": [
            "mode",
            "date",
            "time",
            "fallbackTimezone"
          ],
          "additionalProperties": false
        }
      ]
    },
    "throttlePerHour": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    }
  },
  "required": [
    "name",
    "topicId",
    "segmentIds"
  ],
  "additionalProperties": false
}

Effects

Creates one draft broadcast; nothing is sent.

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 with $.broadcast.id and confirm status draft.

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:

{
  "name": "October",
  "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
  "topicId": "topic_435f69a6fed94bda858f258f5350188f",
  "segmentIds": [
    "seg_5a37efa6266547cc94ba208903123dbc"
  ]
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.create --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.create --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.create --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.create",
    "input": {
      "name": "October",
      "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
      "topicId": "topic_435f69a6fed94bda858f258f5350188f",
      "segmentIds": [
        "seg_5a37efa6266547cc94ba208903123dbc"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "broadcast": {
    "id": "bc_aa4b6946d7b441cc8f0e2e1653a11ed2",
    "name": "October",
    "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
    "templateVersion": null,
    "topicId": "topic_435f69a6fed94bda858f258f5350188f",
    "segmentIds": [
      "seg_5a37efa6266547cc94ba208903123dbc"
    ],
    "purpose": "marketing",
    "schedule": {
      "mode": "now"
    },
    "throttlePerHour": null,
    "status": "draft",
    "launchAt": null,
    "totalRecipients": null,
    "createdBy": "u1",
    "submittedBy": null,
    "submittedAt": null,
    "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 201. Call app_topolo_nurture.broadcasts.get with $.broadcast.id and confirm status draft.

Another supported request

Input · payload.json:

{
  "name": "October",
  "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
  "topicId": "topic_435f69a6fed94bda858f258f5350188f",
  "segmentIds": [
    "seg_5a37efa6266547cc94ba208903123dbc"
  ]
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.create --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.create --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.create --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.create",
    "input": {
      "name": "October",
      "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
      "topicId": "topic_435f69a6fed94bda858f258f5350188f",
      "segmentIds": [
        "seg_5a37efa6266547cc94ba208903123dbc"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "broadcast": {
    "id": "bc_1c98f7632c7149afaea7457b966df1a9",
    "name": "October",
    "templateId": "tpl_737889e80e504b6ba06b1d3e0b50aab2",
    "templateVersion": null,
    "topicId": "topic_435f69a6fed94bda858f258f5350188f",
    "segmentIds": [
      "seg_5a37efa6266547cc94ba208903123dbc"
    ],
    "purpose": "marketing",
    "schedule": {
      "mode": "now"
    },
    "throttlePerHour": null,
    "status": "draft",
    "launchAt": null,
    "totalRecipients": null,
    "createdBy": "u1",
    "submittedBy": null,
    "submittedAt": null,
    "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 201. Call app_topolo_nurture.broadcasts.get with $.broadcast.id and confirm status draft.

Refused request · schedule_in_past

Input · payload.json:

{
  "name": "X",
  "topicId": "topic_7882fdbc77614457b384744e81929d44",
  "segmentIds": [
    "seg_330eddbe201c4fa4a82d02c8dc9f4cbb"
  ],
  "schedule": {
    "mode": "at",
    "sendAt": "2026-09-30T00:00:00Z"
  }
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "schedule_in_past",
    "message": "The scheduled time has already passed; reject the broadcast back to draft and choose a later time."
  }
}

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

Refused request · template_unavailable

Input · payload.json:

{
  "name": "X",
  "templateId": "tpl_missing",
  "topicId": "topic_7882fdbc77614457b384744e81929d44",
  "segmentIds": [
    "seg_330eddbe201c4fa4a82d02c8dc9f4cbb"
  ]
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "template_unavailable",
    "message": "The template is missing or archived."
  }
}

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

Refused request · template_version_unavailable

Input · payload.json:

{
  "name": "X",
  "templateId": "tpl_756669a0c1a14d73a1655a0d78ae01be",
  "templateVersion": 9,
  "topicId": "topic_7882fdbc77614457b384744e81929d44",
  "segmentIds": [
    "seg_330eddbe201c4fa4a82d02c8dc9f4cbb"
  ]
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "template_version_unavailable",
    "message": "The template has no version 9."
  }
}

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

Verify the result

Call app_topolo_nurture.broadcasts.get with $.broadcast.id and confirm status draft.

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.
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.
template_version_unavailable (HTTP 422): Call templates.get to see the current version, or omit templateVersion to use it.
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

Archive the draft created in error.

Test send broadcast: Render the broadcast's template (pinned version, else current) for up to 5 named addresses, merged with sampleContactId when given, and record a test send labelled "[Test]" in the subject. It bypasses the audience and eligibility and is allowed in any status but archived. With a verified sender (sending_settings) each address gets one email through Nexus email.send as the caller (transactional class, idempotent per address); deliveries[] reports sent with the Nexus message id, or not_sent with a reason. The rendered html and text are returned for review.
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.
Archive broadcast: Archive a broadcast that is a draft or has finished (sent, cancelled or failed) so it leaves the working list. Its recipients and history are kept. A broadcast awaiting approval, approved, scheduled or sending must be cancelled first.

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.

Create broadcast

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · schedule_in_past

Refused request · template_unavailable

Refused request · template_version_unavailable

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence