Messages

Create broadcast

The method is used for creating broadcasts for Email, SMS, Mobile Push, Web Push, Viber, Telegram channels.

post/api/v1/broadcast

Request

Base URL: https://yespo.io (the document declares no server; this is the origin it was published from)
URL: https://yespo.io/api/v1/broadcast
Auth: HTTP basic

Request body

titlestring

Broadcast title

messageIdstring required

Message ID

groupsinteger[] required

excludedGroupsinteger[]

startDatestring

The broadcast start date. Use the following format: "YYYY-MM-DDTHH:mm". If not specified, the broadcast starts immediately

batchSizeinteger

The broadcasting speed management parameter, the number of messages per specified time interval.

batchIntervalUnit'MINUTE' | 'HOUR' | 'DAY' | 'MONTH'

The broadcasting speed management parameter—the time interval.

domainstring

Broadcast domain. For web push messages.

appIdstring

Application ID. For mob push and telegram messages.

Example request

{
  "title": "Season's discounts",
  "messageId": "AB2489300",
  "startDate": "2023-10-28T14:00",
  "batchSize": 50,
  "domain": "SportsNewsUpdates",
  "appId": "8182a34b-9c87-4777-8de1-598f2df9de4f"
}

Changes

No recorded changes to this operation across all 1 revision of this API.