---
title: "Create broadcast"
method: POST
path: "/api/v1/broadcast"
tags: ["Messages"]
---

# Create broadcast

`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

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

## Request body

- NewBroadcastRequest
  - `title` string: Broadcast title
  - `messageId` string, required: Message ID
  - `groups` integer[], required
  - `excludedGroups` integer[]
  - `startDate` string: The broadcast start date. Use the following format: "YYYY-MM-DDTHH:mm". If not specified, the broadcast starts immediately
  - `batchSize` integer: 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.
  - `domain` string: Broadcast domain. For web push messages.
  - `appId` string: Application ID. For mob push and telegram messages.

## Response `200`

---

[API](https://skmtc.dev/yespo/apis/yespo-api.md) · [All operations](https://skmtc.dev/yespo/apis/yespo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yespo/apis/yespo-api/revisions/b662f92b6c40?raw)