Update an announcement

PUT {{baseUrl}}/v3/announcements/:unique_id

Update an announcement

Updates information of a specific announcement before it starts or changes the status of a specific announcement after it starts. For the 2 different applications, refer to the request body below.

Note: Updating information of an announcement is possible only when the announcement status is scheduled, indicating it hasn't started yet.

https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-update-an-announcement

Request Body

{"unique_id"=>"<string>", "action"=>"<string>", "announcement_group"=>"<string>", "create_channel"=>"<boolean>", "create_channel_options.name"=>"<string>", "create_channel_options.cover_url"=>"<string>", "create_channel_options.custom_type"=>"<string>", "create_channel_options.data"=>"<string>", "create_channel_options.distinct"=>"<string>", "message.user_id"=>"<string>", "message.content"=>"<string>", "message.data"=>"<string>", "enable_push"=>"<boolean>", "scheduled_at"=>"<integer>", "end_at"=>"<integer>", "cease_at"=>"<string>", "resume_at"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"unique_id":"\u003cstring\u003e","announcement_group":"\u003cstring\u003e","message":{"type":"\u003cstring\u003e","custom_type":"\u003cstring\u003e","user_id":"\u003cstring\u003e","content":"\u003cstring\u003e","data":"\u003cstring\u003e","enable_push":"\u003cboolean\u003e","target_at":"\u003cstring\u003e","target_user_count":"\u003cnumber\u003e","target_channel_count":"\u003cnumber\u003e","status":"\u003cstring\u003e","scheduled_at":"\u003cnumber\u003e","completed_at":"\u003cnumber\u003e","sent_user_count":"\u003cnumber\u003e","open_count":"\u003cnumber\u003e","open_rate":"\u003cnumber\u003e"}}