Broadcast to Segments

Broadcast to segments with the Flow REST API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Details

This broadcast API call allows you to trigger one or more events for specific segments. You can specify either the name of the segment or its ID, which can be obtained from the segments list. Learn how to get audience segments .

POST rest/v1/broadcast/instant/segment HTTP/1.1
Host: api.flow.ai
Content-Type: application/json
Authorization: MY_MESSAGING_API_KEY
{
    "audience": [{
        "name": "MY_SEGMENT_1"
    }, {
        "id": "ID_OF_MY_SEGMENT_2"
    }, {
        "name": "MY_SEGMENT_3",
        "id": "ID_OF_MY_SEGMENT_3"
    }],
    "payload": {
        "type": "event",
        "eventName": "EVENT_NAME"
    }
}
Body Params
audience
array of objects

The segment to trigger event for. A list of segment objects. Either the name or id needs to be provided.

audience
payload
object

A list of event objects

Response

Language
LoadingLoading…
Response
Choose an example:
application/json