SEsendbird
Announcement

Schedule an announcement

Changed on

Schedule an announcement

Creates an announcement. You can also schedule an announcement in the Sendbird Dashboard.

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

post/v3/announcements

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

announcement_groupstring
assign_sender_as_channel_inviterboolean
cease_atstring
create_channelboolean
enable_pushboolean
end_atinteger
keep_channel_hidden_for_senderboolean
mark_as_readboolean
resume_atstring
scheduled_atinteger
send_to_frozen_channelsboolean
target_atstring
target_channel_typestring
target_custom_typestring
target_liststring[]
unique_idstring

Example request

{
  "create_channel_options": {
    "cover_url": "cover_url",
    "data": "data",
    "custom_type": "custom_type",
    "name": "name",
    "distinct": true
  }
}

Response

Successful Response

announcement_groupstring
cease_atstring
completed_atinteger
create_channelboolean
enable_pushboolean
end_atinteger
mark_as_readboolean
open_countinteger
open_ratenumber
prioritystring
resume_atstring
scheduled_atinteger
send_to_frozen_channelsboolean
sent_channel_countinteger
sent_user_countinteger
statusstring
target_atstring
target_channel_countinteger
target_channel_typestring
target_custom_typestring
target_user_countinteger
unique_idstring

Example response

{
  "create_channel_options": {
    "cover_url": "cover_url",
    "data": "data",
    "custom_type": "custom_type",
    "name": "name",
    "distinct": true
  },
  "end_at": 6,
  "enable_push": true,
  "mark_as_read": true,
  "target_at": "target_at",
  "unique_id": "unique_id",
  "target_user_count": 2,
  "announcement_group": "announcement_group",
  "sent_channel_count": 7,
  "sent_user_count": 9,
  "scheduled_at": 2,
  "open_count": 5,
  "message": {
    "message_retention_hour": 1,
    "data": "data",
    "custom_type": "custom_type",
    "user_id": "user_id",
    "type": "type",
    "content": "content"
  },
  "priority": "priority",
  "target_channel_count": 3,
  "target_channel_type": "target_channel_type",
  "completed_at": 0,
  "cease_at": "cease_at",
  "resume_at": "resume_at",
  "send_to_frozen_channels": true,
  "target_custom_type": "target_custom_type",
  "create_channel": true,
  "open_rate": 5.637376656633329,
  "status": "status"
}

Changes

  • 7a85bad03e90Revision changes
    • breaking

      the request property type changed from string to object

    • breaking

      the request property format changed from no format to int64

    • breaking

      the request property format changed from no format to int64

    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id scheduleAnnouncement removed and replaced with scheduleAnAnnouncement

    • info

      added the new optional header request parameter api-token

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional