POST /subscriber/broadcast-by-tag

Scope required: (Manage Flow)

Broadcast sub flow by tags, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
exclude_tags[] Array No

array of tag ns, up to 10 tag ns

name String No

set a name for this broadcast

sub_flow_ns String Yes
scheduled_time Integer No

unix timestamp, e.g. 1786123679. Leave empty to send now

tags[] Array Yes

array of tag ns, up to 10 tag ns

type String No

available values: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION

user_fields[] Array No

up to 10 user fields

user_fields[].var_ns String No
user_fields[].value String No
max_per_minute Integer No

Rate limit, maximum per minute, default is 60

message_tag String No

when type is FACEBOOK_NOTIFICATION, available values: CONFIRMED_EVENT_UPDATE,POST_PURCHASE_UPDATE,ACCOUNT_UPDATE,NON_PROMOTIONAL_SUBSCRIPTION

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.