> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/broadcast/create-a-broadcast.md).

# Create a broadcast

Create a broadcast. It is created in DRAFT status. Recipients are added via the broadcast recipients endpoints. Creating never sends — transition the broadcast to LAUNCHED (via update) to send it.

Required permissions: BROADCAST

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Broadcast","description":"Broadcast"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"BroadcastCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastCreateSchema"}}}}},"schemas":{"BroadcastCreateSchema":{"title":"BroadcastCreateSchema","description":"Create a broadcast. It is created in DRAFT status. Recipients are added via the broadcast recipients endpoints, not a filter. Creating never sends — transition the broadcast via update to send it.","type":"object","required":["channel","purpose","title","body"],"properties":{"broadcastUid":{"description":"Optional client-supplied id for the broadcast. Omit to have one generated. Must be unique within the tenant.","$ref":"#/components/schemas/OptionalUID"},"channel":{"$ref":"#/components/schemas/BroadcastChannelENUM"},"purpose":{"$ref":"#/components/schemas/BroadcastPurposeENUM"},"title":{"type":"string"},"description":{"type":"string"},"body":{"type":"string","description":"The message content. Plain text for SMS, HTML for EMAIL."},"subject":{"type":"string","description":"Email subject. Required for EMAIL, ignored for SMS."},"sender":{"type":"string","description":"Optional sender name/address. Resolved from configuration if omitted."},"sendAt":{"type":"string","format":"date-time","description":"Optional scheduled send time, applied when the broadcast is sent. Omit to send immediately."}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"BroadcastChannelENUM":{"title":"BroadcastChannelENUM","description":"The delivery channel of a broadcast. A broadcast is single-channel.","enum":["SMS","EMAIL"],"type":"string"},"BroadcastPurposeENUM":{"title":"BroadcastPurposeENUM","description":"The purpose of a broadcast. MARKETING is a marketing message; SERVICE is a service/transactional message.\nConsent is the responsibility of the party building the recipient list: MARKETING sends must only include recipients with the relevant marketing consent (see add recipients).","enum":["MARKETING","SERVICE"],"type":"string"},"BroadcastResponseSchema":{"title":"BroadcastResponseSchema","description":"A broadcast header.","type":"object","properties":{"broadcastUid":{"$ref":"#/components/schemas/UID"},"channel":{"$ref":"#/components/schemas/BroadcastChannelENUM"},"purpose":{"$ref":"#/components/schemas/BroadcastPurposeENUM"},"status":{"$ref":"#/components/schemas/BroadcastStatusENUM"},"title":{"type":"string","description":"Operator-facing label."},"description":{"type":"string","description":"Operator-facing note. Empty string if not set."},"body":{"type":"string","description":"The message content. Plain text for SMS, HTML for EMAIL."},"subject":{"type":"string","description":"Email subject. Empty string for SMS."},"sender":{"type":"string","description":"Sender name/address. Empty string if resolved from configuration at send time."},"storeUid":{"description":"Store the broadcast is sent in the context of — the SMS bill payer and/or sender.","$ref":"#/components/schemas/UID"},"sendAt":{"type":"string","format":"date-time","nullable":true,"description":"Scheduled send time. Null means send immediately on launch."},"startedAt":{"type":"string","format":"date-time","nullable":true,"description":"When sending started. Null until the broadcast starts sending."},"finishedAt":{"type":"string","format":"date-time","nullable":true,"description":"When sending finished. Null until the broadcast completes."},"progress":{"$ref":"#/components/schemas/BroadcastProgressSchema"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["broadcastUid","channel","purpose","status","title","description","body","subject","sender","storeUid","sendAt","startedAt","finishedAt","progress","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"BroadcastStatusENUM":{"title":"BroadcastStatusENUM","description":"Lifecycle state of a broadcast.\nDRAFT: editable, recipients can be edited. LAUNCHED: committed to send — sent immediately when sendAt is null or in the past, or held until a future sendAt. SENDING: in progress. COMPLETED: all recipients processed. CANCELLED: stopped before/while sending. FAILED: aborted with an error.","enum":["DRAFT","LAUNCHED","SENDING","COMPLETED","CANCELLED","FAILED"],"type":"string"},"BroadcastProgressSchema":{"title":"BroadcastProgressSchema","description":"Live delivery progress for a broadcast, derived from its recipients.","type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of recipients."},"queuedCount":{"type":"integer","description":"Recipients not yet handed to the provider."},"dispatchedCount":{"type":"integer","description":"Recipients handed to the provider, delivery not yet confirmed."},"deliveredCount":{"type":"integer","description":"Recipients confirmed delivered."},"failedCount":{"type":"integer","description":"Recipients that failed to deliver."}},"required":["totalCount","queuedCount","dispatchedCount","deliveredCount","failedCount"]}},"responses":{"BroadcastResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastResponseSchema"}}},"description":"BroadcastResponse"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/broadcasts":{"post":{"summary":"Create a broadcast","description":"Create a broadcast. It is created in DRAFT status. Recipients are added via the broadcast recipients endpoints.\nCreating never sends — transition the broadcast to LAUNCHED (via update) to send it.\n\nRequired permissions: BROADCAST","operationId":"create-broadcast","tags":["Broadcast"],"requestBody":{"$ref":"#/components/requestBodies/BroadcastCreateRequest"},"responses":{"201":{"$ref":"#/components/responses/BroadcastResponse"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/broadcast/create-a-broadcast.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.