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

post

/tenants/{tenantUid}/stores/{storeUid}/broadcasts/{broadcastUid}/recipients

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

broadcastUidstringRequired

Reference to a Broadcast.

Pattern: ^[A-Za-z0-9-_]+

Body

A batch of recipients to add to a broadcast (DRAFT only).

Responses

200

BroadcastRecipientListResponse

application/json

post/tenants/{tenantUid}/stores/{storeUid}/broadcasts/{broadcastUid}/recipients

POST /v2/tenants/{tenantUid}/stores/{storeUid}/broadcasts/{broadcastUid}/recipients HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "recipients": [
    {
      "customerUid": "text",
      "address": "text"
    }
  ]
}

200

BroadcastRecipientListResponse

{
  "items": [
    {
      "broadcastRecipientUid": "text",
      "customerUid": "text",
      "displayName": "text",
      "address": "text",
      "status": "QUEUED"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}