---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Broadcasts"
description: "The `broadcasts` collection of Sylphx Notify: A Broadcast sends one template to a segment of recipients, fired by a Workflows Schedule."
type: reference
product: email
summary: "A Broadcast sends one template to a segment of recipients, fired by a Workflows Schedule."
updated: 2026-09-28
order: 900
---

> **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.

A Broadcast sends one template to a segment of recipients, fired by a Workflows Schedule. Every recipient still passes suppression and preferences.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/Broadcast` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/broadcasts/{broadcast}` · **Shape** `spec_status`

## Fields

| 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. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/broadcasts#get) | Gets a broadcast. |
| `GET` | [`list`](/docs/api/broadcasts#list) | Lists broadcasts. |
| `POST` | [`create`](/docs/api/broadcasts#create) | Creates a broadcast. |
| `PATCH` | [`update`](/docs/api/broadcasts#update) | Updates a broadcast. |
| `DELETE` | [`delete`](/docs/api/broadcasts#delete) | Deletes a broadcast. |
| `POST` | [`send`](/docs/api/broadcasts#send) | Sends a Broadcast now. |
| `POST` | [`cancel`](/docs/api/broadcasts#cancel) | Cancels a Broadcast; messages already admitted still deliver. |

## get

Gets a broadcast.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/broadcasts/get)

## list

Lists broadcasts.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts` · scope `notify:read` · effect `read` · paginated · [Request, response and examples](/docs/api/broadcasts/list)

## create

Creates a broadcast.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/broadcasts/create)

## update

Updates a broadcast.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/broadcasts/update)

## delete

Deletes a broadcast.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast` · scope `notify:write` · effect `destructive` · [Request, response and examples](/docs/api/broadcasts/delete)

## send

Sends a Broadcast now.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast:send` · scope `notify:send` · effect `write` · validate_only · [Request, response and examples](/docs/api/broadcasts/send)

## cancel

Cancels a Broadcast; messages already admitted still deliver.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast:cancel` · scope `notify:send` · effect `destructive` · [Request, response and examples](/docs/api/broadcasts/cancel)