Set broadcast send rule

Creates or updates the send rule on a draft broadcast that keeps it from sending to contacts who already opened, clicked, or converted on named offers or broadcasts within a window. skip drops those action takers from the send. divert creates a copy of the broadcast, returned as divert_broadcast, that goes to them instead -- the copy is edited through the message endpoints on its own uuid before the origin sends, and cannot carry a send rule of its own. The rule locks once the broadcast is queued, sending, or complete. Editing an existing rule with the same source and an empty list keeps the current list; a named list replaces it; switching source requires the new list.

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

The broadcast UUID.

string
enum
required

The action a matching contact must have taken. converted only applies with source_mode: offers.

Allowed:
string
enum
required

Whether the action is matched against named offers or named broadcasts.

Allowed:
string
enum
required

skip drops the action takers from this send. divert sends them a copy of the broadcast instead, returned as divert_broadcast.

Allowed:
integer | null
1 to 65535

Days to look back for the action. Omit for the default of 30. Send null for no window -- the action counts no matter how long ago it happened.

offer_uuids
array of uuids
length ≤ 500

Offer UUIDs from get_offers to match the action against. Used with source_mode: offers.

offer_uuids
source_broadcast_uuids
array of uuids
length ≤ 500

Broadcast UUIDs to match the action against. Used with source_mode: broadcasts.

source_broadcast_uuids
Responses

401

Missing or invalid bearer token.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json