---
title: "Schedule an announcement"
method: POST
path: "/v3/announcements"
tags: ["Announcement"]
---

# Schedule an announcement

`POST /v3/announcements`

## Request

- Base URL: `https://api-APP_ID.sendbird.com`
- URL: `https://api-APP_ID.sendbird.com/v3/announcements`
- Auth: none declared

## Schedule an announcement

Creates an announcement. You can also schedule an announcement in the [Sendbird Dashboard](https://dashboard.sendbird.com).

[https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement](https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement)

## Headers

- `api-token` string

## Request body

- ScheduleAnAnnouncementRequest
  - `announcement_group` string
  - `assign_sender_as_channel_inviter` boolean
  - `cease_at` string
  - `create_channel` boolean
  - `create_channel_options` ScheduleAnAnnouncementRequestCreateChannelOptions
    - `cover_url` string
    - `custom_type` string
    - `data` string
    - `distinct` boolean
    - `name` string
  - `enable_push` boolean
  - `end_at` integer
  - `keep_channel_hidden_for_sender` boolean
  - `mark_as_read` boolean
  - `message` ScheduleAnAnnouncementRequestMessage
    - `content` string
    - `custom_type` string
    - `data` string
    - `type` string
    - `user_id` string
  - `resume_at` string
  - `scheduled_at` integer
  - `send_to_frozen_channels` boolean
  - `target_at` string
  - `target_channel_type` string
  - `target_custom_type` string
  - `target_list` string[]
  - `unique_id` string

## Response `200`

Successful Response

- ScheduleAnAnnouncementResponse
  - `announcement_group` string
  - `cease_at` string
  - `completed_at` integer
  - `create_channel` boolean
  - `create_channel_options` ScheduleAnAnnouncementRequestCreateChannelOptions
    - `cover_url` string
    - `custom_type` string
    - `data` string
    - `distinct` boolean
    - `name` string
  - `enable_push` boolean
  - `end_at` integer
  - `mark_as_read` boolean
  - `message` ScheduleAnAnnouncementResponseMessage
    - `content` string
    - `custom_type` string
    - `data` string
    - `message_retention_hour` integer
    - `type` string
    - `user_id` string
  - `open_count` integer
  - `open_rate` number
  - `priority` string
  - `resume_at` string
  - `scheduled_at` integer
  - `send_to_frozen_channels` boolean
  - `sent_channel_count` integer
  - `sent_user_count` integer
  - `status` string
  - `target_at` string
  - `target_channel_count` integer
  - `target_channel_type` string
  - `target_custom_type` string
  - `target_user_count` integer
  - `unique_id` string

## Changes

- **2025-07-27** `7a85bad03e90`: 3 breaking, 11 warning, 24 info
  - the `create_channel_options` request property type changed from `string` to `object`
  - the `end_at` request property format changed from no format to `int64`
  - the `scheduled_at` request property format changed from no format to `int64`
  - deleted the `header` request parameter `Api-Token`
  - …34 more
- **2023-11-10** `135d8b0705d4`: 1 info
  - the `header` request parameter `Api-Token` became optional
- **2022-10-25** `f602ae6767eb`: 1 breaking, 3 warning, 8 info
  - the `message` request property type changed from `string` to `object`
  - removed the request property `message.content`
  - removed the request property `message.type`
  - removed the request property `message.user_id`
  - …8 more
- **2022-06-29** `4012275aa67d`: 2 info
  - api tag `Message` added
  - api tag `Announcements` removed
- **2022-02-16** `c42164095c7c`: 1 breaking
  - the `header` request parameter `Api-Token` became required

[Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/announcements/post.md)

---

[API](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk.md) - [All operations](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/revisions/9e53a5288df0?raw)