Create broadcasts

POST {{baseUrl}}/broadcasts

Create a broadcast to send notifications to upto a 1,000 recipients - users or topic subscribers. You can identify users by their email address or by an external_id.

You don't have to import your users into MagicBell. If a user does not exist we'll create it automatically.

You can send user attributes like firstname, customattributes, and more when creating a broadcast.

A new notification will be shown in the inbox of each recipient in real-time. It will also be delivered to each recipient through all channels you have enabled for your project.

Request Body

{"broadcast"=>{"title"=>"<string>", "recipients"=>[{"email"=>"<string>", "external_id"=>"<string>", "matches"=>"<string>"}, {"email"=>"<string>", "external_id"=>"<string>", "matches"=>"<string>"}], "content"=>"<string>", "action_url"=>"<uri>", "custom_attributes"=>{"minim88"=>true, "id_845"=>-30752217.949173182, "non_92"=>-88155558.28659564}, "category"=>"<string>", "topic"=>"<string>", "overrides"=>{"channels"=>{"in_app"=>{"title"=>"<string>", "content"=>"<string>", "action_url"=>"<string>"}, "email"=>{"title"=>"<string>", "content"=>"<string>", "action_url"=>"<string>"}, "web_push"=>{"title"=>"<string>", "content"=>"<string>", "action_url"=>"<string>"}, "mobile_push"=>{"title"=>"<string>", "content"=>"<string>", "action_url"=>"<string>"}}}}}

HEADERS

RESPONSES

status: Created

{"broadcast":{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","recipients":[{"topic":{"subscribers":"\u003cboolean\u003e"}}],"status":{"status":"enqueued","summary":{"total":"\u003cinteger\u003e","failures":"\u003cinteger\u003e"},"errors":[{"Duis3":-33877684.62399294,"mollit_26a":false},{"doloref55":"do minim","ind":-76117224.3533991}]},"content":"\u003cstring\u003e","action_url":"\u003curi\u003e","category":"\u003cstring\u003e","topic":"\u003cstring\u003e","custom_attributes":{"labore805":96481481.68199375,"mollit14":true},"sent_at":"\u003cdateTime\u003e","overrides":{"dolore_a57":true,"in_fc":-71159749.65850036,"officia0f":true,"nostrud_838":false,"nostrud__e":"et elit laboris"}}}