Skip to content
Console
On this page

Broadcasts

A Broadcast sends one template to a segment of recipients, fired by a Workflows Schedule.

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/broadcasts/{broadcast}.
uidstringbct_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specBroadcastSpecDesired state. Required.
statusBroadcastStatusObserved 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.

MethodCallWhat it does
GETgetGets a broadcast.
GETlistLists broadcasts.
POSTcreateCreates a broadcast.
PATCHupdateUpdates a broadcast.
DELETEdeleteDeletes a broadcast.
POSTsendSends a Broadcast now.
POSTcancelCancels 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

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

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

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

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

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

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