Schedule an announcement

POST {{baseUrl}}/v3/announcements

Schedule an announcement

Schedules a new announcement. You can also schedule an announcement in the Sendbird Dashboard.

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

Request Body

{"message"=>"<string>", "message.type"=>"<string>", "message.user_id"=>"<string>", "message.content"=>"<string>", "target_at"=>"<string>", "target_list"=>["<string>", "<string>"], "target_channel_type"=>"<string>", "unique_id"=>"<string>", "message.custom_type"=>"<string>", "message.data"=>"<string>", "create_channel"=>"<boolean>", "announcement_group"=>"<string>", "create_channel_options"=>"<string>", "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>", "scheduled_at"=>"<integer>", "cease_at"=>"<string>", "resume_at"=>"<string>", "end_at"=>"<integer>", "enable_push"=>"<boolean>", "assign_sender_as_channel_inviter"=>"<boolean>"}

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","target_channel_type":"\u003cstring\u003e","create_channel_options":{"distinct":"\u003cboolean\u003e","data":"\u003cstring\u003e","name":"\u003cstring\u003e","cover_url":"\u003cstring\u003e","custom_type":"\u003cstring\u003e"},"status":"\u003cstring\u003e","scheduled_at":"\u003cnumber\u003e","cease_at":"\u003cstring\u003e","resume_at":"\u003cstring\u003e","completed_at":"\u003cnumber\u003e","sent_user_count":"\u003cnumber\u003e","sent_channel_count":"\u003cnumber\u003e","open_count":"\u003cnumber\u003e","open_rate":"\u003cnumber\u003e"}