Send a broadcast notification across the site or topic by using form-data method (legacy / deprecated)

Post a broadcast message to all users (even the non-authenticated ones). Also, this endpoint can send broadcast messages to users who subscribed to topics, check the body schema for more information. This API is deprecated; please use /v5/notifications/{section_uuid}/broadcast/form instead

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Form Data
string
required

The title of the broadcast.

string
required

The description of the broadcast.

string
required

The url of the image that will be displayed.

string
required

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

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.

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.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

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