Create an announcement

Creates an announcement that sends a message to target channels. Announcements can also be created and scheduled from the Sendbird Dashboard.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId: scheduleAnAnnouncement
Server: https://api-{app_id}.sendbird.com
Authentication: apiTokenAuth

Request parameters

No URL, query, or header parameters.

Request body

ScheduleAnAnnouncementRequest

Properties: announcement_groupassign_sender_as_channel_invitercease_atcreate_channelcreate_channel_optionsenable_pushend_atkeep_channel_hidden_for_sendermark_as_readmessageresume_atscheduled_atsend_to_frozen_channelstarget_attarget_channel_typetarget_custom_typetarget_listunique_id

Responses

`200`

ScheduleAnAnnouncementResponseapplication/json

Request succeeded.

Properties: announcement_groupcease_atcompleted_atcreate_channelcreate_channel_optionsenable_pushend_atmark_as_readmessageopen_countopen_ratepriorityresume_atscheduled_atsend_to_frozen_channelssent_channel_countsent_user_countstatustarget_attarget_channel_counttarget_channel_typetarget_custom_typetarget_user_countunique_id

`400`

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

`401`

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

`403`

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

`404`

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

`429`

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

`500`

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "announcement_group": "announcement_group_value",
  "cease_at": "cease_at_value",
  "completed_at": 1,
  "create_channel": true,
  "create_channel_options": {
    "cover_url": "https://example.com/avatar.png",
    "custom_type": "default",
    "data": "{\"key\":\"value\"}",
    "distinct": true,
    "name": "Example Channel"
  },
  "enable_push": true,
  "end_at": 1,
  "mark_as_read": true
}