---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a broadcast"
description: "`notify.broadcasts.create` (POST /v1/{parent}/broadcasts): Creates a broadcast."
type: reference
product: email
summary: "Creates a broadcast."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Creates a broadcast.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts`
- **Scope** `notify:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [broadcasts](/docs/api/broadcasts)
- **Query** `broadcast_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `broadcast_id` | `string` | The broadcast id, the final name segment; the server assigns one when empty. |
| `broadcast` | `Broadcast` | The broadcast to create; only caller-writable fields are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Broadcast

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/broadcasts/{broadcast}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `BroadcastSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### BroadcastSpec

| Field | Type | What it is |
| --- | --- | --- |
| `topic` | `string` | The topic every message carries. Required. |
| `template` | `string` | The template to render. Required. |
| `segment_filter` | `string` | AIP-160 filter over recipient labels and fields selecting the segment. Required. |
| `data` | `struct` | Template variables shared by every message. |
| `send_time` | `timestamp` | When to send; unset sends only on `:send`. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/broadcasts/{broadcast}`. |
| `uid` | `string` | `bct_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `BroadcastSpec` | Desired state. Required. |
| `status` | `BroadcastStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### BroadcastSpec

| Field | Type | What it is |
| --- | --- | --- |
| `topic` | `string` | The topic every message carries. Required. |
| `template` | `string` | The template to render. Required. |
| `segment_filter` | `string` | AIP-160 filter over recipient labels and fields selecting the segment. Required. |
| `data` | `struct` | Template variables shared by every message. |
| `send_time` | `timestamp` | When to send; unset sends only on `:send`. |

### BroadcastStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `BroadcastState` | The broadcast's progress. Output only. One of `draft`, `scheduled`, `sending`, `sent`, `cancelled`. |
| `schedule` | `string` | The Workflows Schedule that fires it. Output only. |
| `admitted_count` | `int64` | Messages admitted. Output only. |
| `skipped_count` | `int64` | Recipients skipped by suppression or preference. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"segment_filter":"…","template":"…","topic":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.notify.broadcasts.create({ broadcast: { spec: { segmentFilter: '…', template: '…', topic: '…' } }, parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::notify::CreateBroadcastRequest::default();
req.broadcast = Some(sylphx::notify::Broadcast {
    spec: Some(sylphx::notify::BroadcastSpec {
        segment_filter: "…".to_string(),
        template: "…".to_string(),
        topic: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.notify().broadcasts().create(req).await?;
```

**CLI**

```bash
sylphx notify broadcasts create --parent orgs/acme/projects/shop/envs/production --spec.topic … --spec.template … --spec.segment-filter …
```

**MCP**

```json
{ "method_id": "notify.broadcasts.create", "args": {"broadcast":{"spec":{"segment_filter":"…","template":"…","topic":"…"}},"parent":"orgs/acme/projects/shop/envs/production"} }
```