> 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/add-broadcast-recipients.md).

# Add broadcast recipients

Add a batch of recipients to a broadcast. Each targets a customer (customerUid) or an ad-hoc address; at least one of the two is required, and recipients are deduplicated on (broadcast, address). Allowed only while the broadcast is DRAFT. Returns the full recipient list.

Consent is the responsibility of the party building the recipient list (the "outtake"/list maker): recipients added here are sent to as-is. Use customer search (consent filter) to build a consented audience; MARKETING sends must only include recipients with the relevant consent.

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":{"BroadcastRecipientsAddRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastRecipientsAddSchema"}}}}},"schemas":{"BroadcastRecipientsAddSchema":{"title":"BroadcastRecipientsAddSchema","description":"A batch of recipients to add to a broadcast (DRAFT only).","type":"object","required":["recipients"],"properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastRecipientInputSchema"}}}},"BroadcastRecipientInputSchema":{"title":"BroadcastRecipientInputSchema","description":"A recipient to add. Provide customerUid to target a customer (address is snapshotted from the customer), or address for an ad-hoc recipient. At least one of customerUid / address is required (server-validated). Recipients are deduplicated on (broadcast, address).","type":"object","properties":{"customerUid":{"$ref":"#/components/schemas/UID"},"address":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"BroadcastRecipientSchema":{"title":"BroadcastRecipientSchema","description":"A recipient of a broadcast — either a customer (customerUid set, address snapshotted from the customer) or an ad-hoc address (customerUid null).","type":"object","required":["broadcastRecipientUid","customerUid","displayName","address","status"],"properties":{"broadcastRecipientUid":{"$ref":"#/components/schemas/UID"},"customerUid":{"description":"The customer this recipient represents, or null for an ad-hoc address.","$ref":"#/components/schemas/OptionalNullableUID"},"displayName":{"type":"string","nullable":true,"description":"Customer display label, or null for an ad-hoc address-only recipient."},"address":{"type":"string","description":"The mobile number or email address the broadcast is sent to (snapshotted from the customer when customerUid is set)."},"status":{"$ref":"#/components/schemas/BroadcastRecipientStatusENUM"}}},"OptionalNullableUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*","nullable":true},"BroadcastRecipientStatusENUM":{"title":"BroadcastRecipientStatusENUM","description":"Delivery state of a single broadcast recipient.\nQUEUED: not yet handed to the provider. DISPATCHED: handed to the provider, delivery not yet confirmed. DELIVERED: confirmed delivered. FAILED: delivery failed.","enum":["QUEUED","DISPATCHED","DELIVERED","FAILED"],"type":"string"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"BroadcastRecipientListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BroadcastRecipientSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"BroadcastRecipientListResponse"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/broadcasts/{broadcastUid}/recipients":{"post":{"summary":"Add broadcast recipients","description":"Add a batch of recipients to a broadcast. Each targets a customer (customerUid) or an ad-hoc address; at least one of the two is required, and recipients are deduplicated on (broadcast, address).\nAllowed only while the broadcast is DRAFT. Returns the full recipient list.\n\nConsent is the responsibility of the party building the recipient list (the \"outtake\"/list maker): recipients added here are sent to as-is. Use customer search (consent filter) to build a consented audience; MARKETING sends must only include recipients with the relevant consent.\n\nRequired permissions: BROADCAST","operationId":"add-broadcast-recipients","tags":["Broadcast"],"requestBody":{"$ref":"#/components/requestBodies/BroadcastRecipientsAddRequest"},"responses":{"200":{"$ref":"#/components/responses/BroadcastRecipientListResponse"}}}}}}
```


---

# 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/add-broadcast-recipients.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.