MillionSend.Broadcasts (MillionSend v0.2.0)

Broadcasts. Create a draft, then send/3 it (optionally scheduled). Target with an optional segment_id and/or topic_id; neither means every contact of the team.

{:ok, b} = MillionSend.Broadcasts.create(%{
  from: "Acme <news@acme.dev>", subject: "Launch", html: "<p>hi</p>"
})
MillionSend.Broadcasts.send(b.id, scheduled_at: "2026-09-01T09:00:00Z")

Summary

Functions

cancel(client \\ MillionSend.client(), id)

POST /broadcasts/:id/cancel — scheduled only.

create(client \\ MillionSend.client(), params)

POST /broadcasts

get(client \\ MillionSend.client(), id)

GET /broadcasts/:id

list()

GET /broadcasts — accepts limit:, after:, before:.

list(client)

list(client, opts)

remove(client \\ MillionSend.client(), id)

DELETE /broadcasts/:id — draft only.

send(id)

POST /broadcasts/:id/send — pass scheduled_at: to schedule, omit to send now.

send(client, id)

send(client, id, opts)

update(client \\ MillionSend.client(), id, params)

PATCH /broadcasts/:id — draft only.

Functions

cancel(client \\ MillionSend.client(), id)

@spec cancel(MillionSend.Client.t(), String.t()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

POST /broadcasts/:id/cancel — scheduled only.

create(client \\ MillionSend.client(), params)

@spec create(MillionSend.Client.t(), map()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

POST /broadcasts

get(client \\ MillionSend.client(), id)

@spec get(MillionSend.Client.t(), String.t()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

GET /broadcasts/:id

list()

GET /broadcasts — accepts limit:, after:, before:.

list(client)

@spec list(MillionSend.Client.t() | keyword()) ::
  {:ok, MillionSend.List.t()} | {:error, MillionSend.Error.t()}

list(client, opts)

@spec list(
  MillionSend.Client.t(),
  keyword()
) :: {:ok, MillionSend.List.t()} | {:error, MillionSend.Error.t()}

remove(client \\ MillionSend.client(), id)

@spec remove(MillionSend.Client.t(), String.t()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

DELETE /broadcasts/:id — draft only.

send(id)

@spec send(String.t()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

POST /broadcasts/:id/send — pass scheduled_at: to schedule, omit to send now.

send(client, id)

@spec send(MillionSend.Client.t() | String.t(), String.t() | keyword()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

send(client, id, opts)

@spec send(MillionSend.Client.t(), String.t(), keyword()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

update(client \\ MillionSend.client(), id, params)

@spec update(MillionSend.Client.t(), String.t(), map()) ::
  {:ok, MillionSend.Broadcasts.Broadcast.t()} | {:error, MillionSend.Error.t()}

PATCH /broadcasts/:id — draft only.