Creates an announcement. You can also create an announcement on the Sendbird Dashboard.
When sending an announcement, you can define target audience by using properties like
target_custom_type. If the group channel targeted for the announcement doesn't exist, you can create a new channel and send the announcement by setting the
create_channel to true and specifying channel attributes such as
create_channel_options.custom_type for the new channel.
Note: When a target channel is created and the values set to
create_channel_options.custom_typedon't match, the new channel will use the value of
target_custom_typeis empty, the custom type will be set to
create_channel_options.custom_typefor the new channel.
The following table lists the properties of an HTTP request that this action supports.
The message of a new announcement.
Specifies the type of the message. Acceptable values are MESG for a text message and ADMM for an admin message.
Specifies the unique ID of the sender when
Specifies the content of the message.
Specifies the target channel scope to send the announcement. Acceptable values are the following:
array of strings
Specifies an array of target user IDs or target channel URLs to send the announcement to when
Determines which type of group channel to send the announcement to based on
Specifies the unique ID for the announcement. The
Specifies the custom message type of the message of the announcement.
Specifies additional information regarding the message, such as custom font size, font type, or file, in
Specifies file information in
Specifies the name of the file.
Specifies the URL of where the file is hosted.
Specifies the size of the file.
Specifies the MIME type of the file, such as image, audio, or video.
Specifies the announcement group that the announcement belongs to.
Determines which group channels are targeted for the announcement based on their custom channel type. It also determines the custom channel type of new channels that will be created for this announcement. When target channels don't exist and
Determines whether to create a new channel if there is no existing channel that matches the same target scope specified by
A newly created channel configuration.
Specifies the name of the channel. (Default: Group Channel)
Specifies the URL of the cover image for the channel.
Specifies the custom channel type of the channel.
Specifies additional channel information, such as a long description of the channel or
Determines whether to create a distinct channel. (Default: true)
Specifies the time to start the announcement in Unix milliseconds format. If not specified, the default is the timestamp of when the request was delivered to Sendbird server. (Default: current timestamp)
Specifies the time to temporarily put the announcement on hold in UTC. The value is represented in HHMM format. This property should be specified in conjunction with the
Specifies the time to automatically resume the on-hold announcement in UTC. The value is represented in HHMM format. This property should be specified in conjunction with the
Specifies the time to permanently end the announcement in Unix milliseconds format. If specified, the announcement ends no matter if the announcement has been sent to all its targets.
Determines whether to turn on push notification for the announcement. If set to true, push notification is sent for the announcement. (Default: true)
Determines whether to assign an announcement sender as an inviter of the newly created channels. (Default: false)
If successful, this action returns an announcement resource containing its information and schedule in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.