Broadcast

post

https://api.meya.ai/broadcast

Programmatically trigger bot broadcasts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

❗️
Do not spam users
Use this feature sparingly. Do not spam users who have not opted in to receiving push broadcasts. Make sure to test your code before putting in production.

📘
Tip: Mock before sending
set mock: true to test your queries without sending actual broadcasts. Useful to determine how many users will be impacted.

Audience filter expressions

You can construct filter expressions using the syntax userfield__expression: value in order to limit your broadcast to user's who match that expression.

ex. last_name__eq: "Musk" which match all users with the last name Musk.

See the datastore for all possible filter expressions.

Body Params

flow

string

required

The unique flow name to trigger.

action

string

Defaults to start

Start at another state other than default

name

string

Defaults to flow

The name you want to give your broadcast for reference purposes.

send_time

date-time

The UNIX timestamp you want to schedule for the broadcast. If omitted, the broadcast will send now.

max_users

int32

Defaults to 100

The maximum number of users you want to receive your broadcast. This is to guard against sending to too many of your users.

repeat

string

The cron-formatted string for repeated broadcasts.

repeat_end

date-time

The last UNIX timestamp you want your broadcast to send (if it's a repeated broadcast). Note all times are in UTC.

mock

boolean

Defaults to false

If set to true, a broadcast will not be sent but will do a mock request and return the number of users.

fieldname__expression

string

Add user filters for segmenting the broadcast audience. See below for examples.

Responses

Do not spam users

Tip: Mock before sending

Audience filter expressions

200200

400400