Skip to main content
POST
/
api
/
v1
/
public
/
broadcasts
/
send-prepared
Redeem a preparedSendId and trigger the broadcast
curl --request POST \
  --url http://localhost:3001/api/v1/public/broadcasts/send-prepared \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "preparedSendId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "NotStarted",
  "firstRedeem": true
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
preparedSendId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

​
broadcastId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
status
enum<string>
required

Lifecycle status of a broadcast campaign

Available options:
NotStarted,
InProgress,
Triggered,
Sent,
Failed,
Archived,
Warming,
Paused
​
firstRedeem
boolean
required