Update broadcast recipients

Update a batch of existing recipients in place, each identified by its broadcastRecipientUid. Recipients not listed are left unchanged. Allowed only while the broadcast is DRAFT. Returns the full recipient list.

Required permissions: BROADCAST

put

/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 recipient edits, each identified by broadcastRecipientUid (DRAFT only). Recipients not listed are left unchanged.

Responses

200

BroadcastRecipientListResponse

application/json

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

PUT /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: 87

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

200

BroadcastRecipientListResponse

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