API referenceBroadcasts

PATCH /broadcasts/{broadcastId}

Update a draft (name, description, message, template, segmentFilters)

PATCH
/broadcasts/{broadcastId}

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

broadcastId*string

Broadcast id

Request Body

application/json
  1. body
name?string
description?string
template?
message?
segmentFilters?

Response Body

{success, broadcast}

application/json
  1. response
success?boolean
broadcast?
Example Request
curl -X PATCH 'https://example.com/api/v1/broadcasts/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "broadcast": {}}

GET /broadcasts/{broadcastId} GET

A broadcast with its configuration and stats

DELETE /broadcasts/{broadcastId} DELETE

Delete a draft