Update a broadcast

Authorization

api-key

X-API-Key<token>

In: header

Path Parameters

id*string

Broadcast UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 200

subject?string

Lengthlength <= 500

subjectB?string

Lengthlength <= 500

previewText?string

Lengthlength <= 300

fromName?string

Lengthlength <= 100

fromEmail?string

Formatemail

senderId?string

audienceType?string

Value in

"all"
"segments"
"tags"

audienceFilter?

blocks?array<>

theme?string

backgroundColor?string

maxWidth?string

primaryColor?string

containerPaddingMobile?

footerStyles?

abTestSplit?number

Total % of audience used for A/B test (A gets half, B gets half)

Range10 <= value <= 100

abTestDurationHours?number

Hours before auto-winner is selected

Range1 <= value <= 72

timezoneMode?string

Value in

"fixed"
"subscriber"

scheduledAt?string

localTime?string

localDate?string

categoryId?string

Email category ID for preference center opt-out filtering

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/broadcasts/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "550e8400-e29b-41d4-a716-446655440000",  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",  "name": "Summer Sale Announcement",  "status": "draft",  "subject": "Our biggest sale of the year 🎉",  "previewText": "Preview of what's inside...",  "fromName": "Peleka Team",  "fromEmail": "[email protected]",  "audienceType": "all",  "audienceFilter": {    "ids": []  },  "blocks": [],  "theme": "modern",  "footerStyles": {},  "sentCount": 0,  "createdAt": "2026-01-01T00:00:00.000Z",  "updatedAt": "2026-01-01T00:00:00.000Z"}