Updates information on a specific announcement. You can update the information of an announcement only when its status is scheduled, which indicates that the announcement hasn't started. After the announcement starts, you can change its status.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
unique_id | string | Specifies the unique ID of the announcement. |
The following table lists the properties of an HTTP request that this action supports.
Properties
Optional | Type | Description |
---|---|---|
action | string | Specifies an action to take on the announcement. If this property is updated, other specified properties in the request aren't effective. Acceptable values are cancel, pause, resume, and stop. The Announcement actions table explains each action in detail. |
announcement_group | string | Specifies the name of an announcement group. If not specified, all announcements are returned, regardless of their group. |
target_custom_type | string | Determines which group channels are target 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 |
create_channel | boolean | Determines whether to create a new channel if there is no existing channel that fits the specified target scope including |
create_channel_options.name | string | Specifies the name of the channel. (Default: Group Channel) |
create_channel_options.cover_url | string | Specifies the URL of the cover image for the channel. |
create_channel_options.custom_type | string | Specifies the custom channel type. |
create_channel_options.data | string | Specifies additional channel information such as a long description of the channel or |
create_channel_options.distinct | string | Determines whether to create a distinct channel. (Default: true) |
message.user_id | string | Specifies the unique ID of the announcement sender. |
message.content | string | Specifies the content of the message. |
message.data | string | Specifies additional information regarding the message, such as custom font size, font type, or file, in |
enable_push | boolean | Determines whether to turn on push notifications of the announcement. If set to true, push notifications are sent for announcements. |
scheduled_at | long | Specifies the time to start the announcement in Unix milliseconds |
end_at | long | Specifies the time to permanently end the announcement in Unix milliseconds |
cease_at | string | 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 |
resume_at | string | SSpecifies 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 |
You can change the status of an announcement by specifying one of the following four actions in the action
property.
Action | Description |
---|---|
cancel | Status changes from scheduled to canceled. |
pause | Status changes from running to paused. |
resume | Status changes from paused to running. |
stop | Status changes from running to paused. |
This API request can be applied to two situations as shown below.
If successful, this action returns an updated announcement resource containing its status information in the response body.
If you attempt to take an action on an announcement with an unacceptable status, an error is returned with a 400-series HTTP code. For example, the stop action is applicable to the running status only.
In the case of an error, an error object is returned. A detailed list of error codes is available here.