Send a broadcast notification across the site or topic

post

https://notifications.viafoura.co/v5/notifications/{site_uuid}/broadcast

Post a broadcast notification to all users (even the non-authenticated ones). This endpoint can also send a broadcast notification to users who subscribed to a topic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_uuid

uuid

required

Body Params

title

string

required

The title of the broadcast.

description

string

required

The description of the broadcast.

image_url

string

required

The url of the image that will be displayed.

url

string

required

The url that the user will be redirected to on-click.

push_time_to_live

int64

The time, in seconds, a push notification should be retained once it has been sent to to Push Service, but not received by the end-user's browser. This can happen when a user's computer is powered off, their browser is not running, or their device does not have access to the internet. Default is 4 weeks. If set to 0, the notification will only be sent to users who can receive it immediately.

topic_id

string

A string to represent the topic id. For site broadcasting, topic_id should not be included. For topic broadcasting, the topic_id must be unique for each topic.

broadcast_type

string

enum

required

Allowed:

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here!