Broadcasts API

11 operations. Guide: Send a broadcast to a segment. Requests and responses are JSON with snake_case fields; authenticate with Authorization: Bearer <api key>. The examples assume a client built as in SDKs and the command line.

Create a broadcast

POST /v1/broadcasts

A draft: from an address on a marketing domain, a subject (or an A/B test of two), a block document or HTML with contact properties as variables, and a segment or topic.

Operation createBroadcast, SDK minket.broadcasts.create. Keys: full access. Test keys work on test-mode data.

Request body

Field	Type	Required	Description
`name`	string	yes	1 to 200 characters.
`from`	string	no	An email address, optionally with a display name as `Name <address>`. 3 to 998 characters.
`reply_to`	string or array of string	no	One address, or an array of up to 50.
`subject`	string	no	At most 998 characters.
`preview_text`	string	no	At most 500 characters.
`segment_id`	string	no	A UUID.
`topic_id`	string	no	A UUID.
`document`	object	no
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string	no	At most 1048576 characters.
`text`	string	no	At most 1048576 characters.
`throttle_per_minute`	integer	no	1 to 10000.
`ab_test`	object	no
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.

Response

201 Created: Broadcast.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"broadcast"	yes
`project_id`	string	yes	A UUID.
`mode`	one of "live", "test"	yes
`name`	string	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`subject`	string or null	yes
`preview_text`	string or null	yes
`segment_id`	string or null	yes	A UUID.
`topic_id`	string or null	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`throttle_per_minute`	integer	yes
`ab_test`	object or null	yes
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.
`ab_test.winner`	one of "a", "b", null or null	yes
`ab_test.decided_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.window_ends_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.results`	array of object	yes
`ab_test.results[].key`	one of "a", "b"	yes
`ab_test.results[].subject`	string	yes
`ab_test.results[].recipients`	integer	yes
`ab_test.results[].sent`	integer	yes
`ab_test.results[].opened`	integer	yes
`ab_test.results[].clicked`	integer	yes
`stats`	object	yes
`stats.recipients`	integer	yes
`stats.sent`	integer	yes
`stats.delivered`	integer	yes
`stats.opened`	integer	yes
`stats.clicked`	integer	yes
`stats.bounced`	integer	yes
`stats.complained`	integer	yes
`stats.unsubscribed`	integer	yes
`stats.skipped`	integer	yes
`stats.failed`	integer	yes
`stats.pending`	integer	yes
`error`	string or null	yes
`scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`started_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/broadcasts \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"October news","from":"Acme News <news@news.acme.example>","subject":"What is new in October","segment_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","html":"<p>Hello {{first_name}}, here is what changed.</p>"}'

TypeScript

const result = await minket.broadcasts.create({
  name: "October news",
  from: "Acme News <news@news.acme.example>",
  subject: "What is new in October",
  segment_id: "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b",
  html: "<p>Hello {{first_name}}, here is what changed.</p>"
});

CLI

minket api createBroadcast --body '{"name":"October news","from":"Acme News <news@news.acme.example>","subject":"What is new in October","segment_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","html":"<p>Hello {{first_name}}, here is what changed.</p>"}'

Python

from minket.api.broadcasts import create_broadcast
from minket.models import CreateBroadcastBody

result = create_broadcast.sync(client=client, body=CreateBroadcastBody.from_dict({"name":"October news","from":"Acme News <news@news.acme.example>","subject":"What is new in October","segment_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","html":"<p>Hello {{first_name}}, here is what changed.</p>"}))

var body minket.CreateBroadcastJSONRequestBody
res, err := client.CreateBroadcastWithResponse(ctx, body)

List broadcasts

GET /v1/broadcasts

Operation listBroadcasts, SDK minket.broadcasts.list. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"broadcast"	yes
`data[].project_id`	string	yes	A UUID.
`data[].mode`	one of "live", "test"	yes
`data[].name`	string	yes
`data[].from`	string or null	yes
`data[].reply_to`	array of string	yes
`data[].subject`	string or null	yes
`data[].preview_text`	string or null	yes
`data[].segment_id`	string or null	yes	A UUID.
`data[].topic_id`	string or null	yes	A UUID.
`data[].status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes
`data[].throttle_per_minute`	integer	yes
`data[].ab_test`	object or null	yes
`data[].ab_test.variants`	array of object	yes
`data[].ab_test.variants[].key`	one of "a", "b"	yes
`data[].ab_test.variants[].subject`	string	yes	At most 998 characters.
`data[].ab_test.sample_percent`	integer	yes	5 to 50.
`data[].ab_test.window_minutes`	integer	yes	15 to 1440.
`data[].ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.
`data[].ab_test.winner`	one of "a", "b", null or null	yes
`data[].ab_test.decided_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].ab_test.window_ends_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].ab_test.results`	array of object	yes
`data[].ab_test.results[].key`	one of "a", "b"	yes
`data[].ab_test.results[].subject`	string	yes
`data[].ab_test.results[].recipients`	integer	yes
`data[].ab_test.results[].sent`	integer	yes
`data[].ab_test.results[].opened`	integer	yes
`data[].ab_test.results[].clicked`	integer	yes
`data[].stats`	object	yes
`data[].stats.recipients`	integer	yes
`data[].stats.sent`	integer	yes
`data[].stats.delivered`	integer	yes
`data[].stats.opened`	integer	yes
`data[].stats.clicked`	integer	yes
`data[].stats.bounced`	integer	yes
`data[].stats.complained`	integer	yes
`data[].stats.unsubscribed`	integer	yes
`data[].stats.skipped`	integer	yes
`data[].stats.failed`	integer	yes
`data[].stats.pending`	integer	yes
`data[].error`	string or null	yes
`data[].scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].started_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/broadcasts \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.list();

CLI

minket api listBroadcasts

Python

from minket.api.broadcasts import list_broadcasts

result = list_broadcasts.sync(client=client)

res, err := client.ListBroadcastsWithResponse(ctx, &minket.ListBroadcastsParams{})

Get a broadcast, with its progress and analytics

GET /v1/broadcasts/{id}

Operation getBroadcast, SDK minket.broadcasts.get. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: Broadcast.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"broadcast"	yes
`project_id`	string	yes	A UUID.
`mode`	one of "live", "test"	yes
`name`	string	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`subject`	string or null	yes
`preview_text`	string or null	yes
`segment_id`	string or null	yes	A UUID.
`topic_id`	string or null	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`throttle_per_minute`	integer	yes
`ab_test`	object or null	yes
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.
`ab_test.winner`	one of "a", "b", null or null	yes
`ab_test.decided_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.window_ends_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.results`	array of object	yes
`ab_test.results[].key`	one of "a", "b"	yes
`ab_test.results[].subject`	string	yes
`ab_test.results[].recipients`	integer	yes
`ab_test.results[].sent`	integer	yes
`ab_test.results[].opened`	integer	yes
`ab_test.results[].clicked`	integer	yes
`stats`	object	yes
`stats.recipients`	integer	yes
`stats.sent`	integer	yes
`stats.delivered`	integer	yes
`stats.opened`	integer	yes
`stats.clicked`	integer	yes
`stats.bounced`	integer	yes
`stats.complained`	integer	yes
`stats.unsubscribed`	integer	yes
`stats.skipped`	integer	yes
`stats.failed`	integer	yes
`stats.pending`	integer	yes
`error`	string or null	yes
`scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`started_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.get("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import get_broadcast

result = get_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Update a draft broadcast

PATCH /v1/broadcasts/{id}

Operation updateBroadcast, SDK minket.broadcasts.update. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`name`	string	no	1 to 200 characters.
`from`	string	no	An email address, optionally with a display name as `Name <address>`. 3 to 998 characters.
`reply_to`	string or array of string or null	no	One address, or an array of up to 50.
`subject`	string or null	no	At most 998 characters.
`preview_text`	string or null	no	At most 500 characters.
`segment_id`	string or null	no	A UUID.
`topic_id`	string or null	no	A UUID.
`document`	object or null	no
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	no	At most 1048576 characters.
`text`	string or null	no	At most 1048576 characters.
`throttle_per_minute`	integer	no	1 to 10000.
`ab_test`	object or null	no
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.

Response

200 Success: Broadcast.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"broadcast"	yes
`project_id`	string	yes	A UUID.
`mode`	one of "live", "test"	yes
`name`	string	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`subject`	string or null	yes
`preview_text`	string or null	yes
`segment_id`	string or null	yes	A UUID.
`topic_id`	string or null	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`throttle_per_minute`	integer	yes
`ab_test`	object or null	yes
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.
`ab_test.winner`	one of "a", "b", null or null	yes
`ab_test.decided_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.window_ends_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.results`	array of object	yes
`ab_test.results[].key`	one of "a", "b"	yes
`ab_test.results[].subject`	string	yes
`ab_test.results[].recipients`	integer	yes
`ab_test.results[].sent`	integer	yes
`ab_test.results[].opened`	integer	yes
`ab_test.results[].clicked`	integer	yes
`stats`	object	yes
`stats.recipients`	integer	yes
`stats.sent`	integer	yes
`stats.delivered`	integer	yes
`stats.opened`	integer	yes
`stats.clicked`	integer	yes
`stats.bounced`	integer	yes
`stats.complained`	integer	yes
`stats.unsubscribed`	integer	yes
`stats.skipped`	integer	yes
`stats.failed`	integer	yes
`stats.pending`	integer	yes
`error`	string or null	yes
`scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`started_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X PATCH https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"What is new this October"}'

TypeScript

const result = await minket.broadcasts.update("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  subject: "What is new this October"
});

CLI

minket api updateBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"subject":"What is new this October"}'

Python

from minket.api.broadcasts import update_broadcast
from minket.models import UpdateBroadcastBody

result = update_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=UpdateBroadcastBody.from_dict({"subject":"What is new this October"}))

var body minket.UpdateBroadcastJSONRequestBody
res, err := client.UpdateBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Delete a draft broadcast

DELETE /v1/broadcasts/{id}

Drafts, canceled and failed broadcasts; a scheduled one is canceled first.

Operation deleteBroadcast, SDK minket.broadcasts.delete. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required
`object`	"broadcast"	yes
`id`	string	yes
`deleted`	true	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X DELETE https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.delete("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api deleteBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import delete_broadcast

result = delete_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DeleteBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Send or schedule a broadcast

POST /v1/broadcasts/{id}/send

Sends a draft now or at scheduled_at, and resumes a paused one. When sending starts the audience is resolved to a recipient snapshot (subscribed, not suppressed); consent and suppression are checked again for each recipient, and sends are throttled per domain.

Operation sendBroadcast, SDK minket.broadcasts.send. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`scheduled_at`	string	no	At most 100 characters.

Response

202 Queued: object.

Field	Type	Required	Description
`object`	"broadcast"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/send \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scheduled_at":"tomorrow at 9am"}'

TypeScript

const result = await minket.broadcasts.send("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  scheduled_at: "tomorrow at 9am"
});

CLI

minket api sendBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"scheduled_at":"tomorrow at 9am"}'

Python

from minket.api.broadcasts import send_broadcast
from minket.models import SendBroadcastBody

result = send_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=SendBroadcastBody.from_dict({"scheduled_at":"tomorrow at 9am"}))

var body minket.SendBroadcastJSONRequestBody
res, err := client.SendBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Cancel a scheduled or sending broadcast

POST /v1/broadcasts/{id}/cancel

Operation cancelBroadcast, SDK minket.broadcasts.cancel. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"broadcast"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/cancel \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.cancel("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api cancelBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import cancel_broadcast

result = cancel_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.CancelBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Duplicate a broadcast

POST /v1/broadcasts/{id}/duplicate

A new draft named <name> (copy) with the broadcast's sender, subject, audience, content, throttle and A/B test settings, whatever its status. Nothing about sending carries over.

Operation duplicateBroadcast, SDK minket.broadcasts.duplicate. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

201 Created: Broadcast.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"broadcast"	yes
`project_id`	string	yes	A UUID.
`mode`	one of "live", "test"	yes
`name`	string	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`subject`	string or null	yes
`preview_text`	string or null	yes
`segment_id`	string or null	yes	A UUID.
`topic_id`	string or null	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`throttle_per_minute`	integer	yes
`ab_test`	object or null	yes
`ab_test.variants`	array of object	yes
`ab_test.variants[].key`	one of "a", "b"	yes
`ab_test.variants[].subject`	string	yes	At most 998 characters.
`ab_test.sample_percent`	integer	yes	5 to 50.
`ab_test.window_minutes`	integer	yes	15 to 1440.
`ab_test.metric`	one of "opens", "clicks"	no	Default `"opens"`.
`ab_test.winner`	one of "a", "b", null or null	yes
`ab_test.decided_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.window_ends_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`ab_test.results`	array of object	yes
`ab_test.results[].key`	one of "a", "b"	yes
`ab_test.results[].subject`	string	yes
`ab_test.results[].recipients`	integer	yes
`ab_test.results[].sent`	integer	yes
`ab_test.results[].opened`	integer	yes
`ab_test.results[].clicked`	integer	yes
`stats`	object	yes
`stats.recipients`	integer	yes
`stats.sent`	integer	yes
`stats.delivered`	integer	yes
`stats.opened`	integer	yes
`stats.clicked`	integer	yes
`stats.bounced`	integer	yes
`stats.complained`	integer	yes
`stats.unsubscribed`	integer	yes
`stats.skipped`	integer	yes
`stats.failed`	integer	yes
`stats.pending`	integer	yes
`error`	string or null	yes
`scheduled_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`started_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/duplicate \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.duplicate("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api duplicateBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import duplicate_broadcast

result = duplicate_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DuplicateBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Send a test copy to up to five addresses

POST /v1/broadcasts/{id}/test

Separate emails with the broadcast's current content, outside its analytics. Addresses that are contacts get their own variables.

Operation testBroadcast, SDK minket.broadcasts.test. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`to`	array of string	yes	At most 5 items.

Response

202 Queued: object.

Field	Type	Required	Description
`object`	"broadcast"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "scheduled", "queued", "sending", "testing", "sent", "canceled", "failed", "paused"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/test \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":["jane@example.com"]}'

TypeScript

const result = await minket.broadcasts.test("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  to: [
    "jane@example.com"
  ]
});

CLI

minket api testBroadcast 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"to":["jane@example.com"]}'

Python

from minket.api.broadcasts import test_broadcast
from minket.models import TestBroadcastBody

result = test_broadcast.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=TestBroadcastBody.from_dict({"to":["jane@example.com"]}))

var body minket.TestBroadcastJSONRequestBody
res, err := client.TestBroadcastWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

List a broadcast's recipients and their status

GET /v1/broadcasts/{id}/recipients

Newest contact first. event keeps the recipients whose email had that event (unsubscribed: who left since; suppressed: skipped or refused as suppressed) and adds count for opens and clicks, clicked_links for clicks and bounce_type for bounces. email matches part of the address.

Operation listBroadcastRecipients, SDK minket.broadcasts.recipients. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.
`status`	query	one of "pending", "sent", "skipped", "failed"	no
`event`	query	one of "sent", "delivered", "opened", "clicked", "bounced", "complained", "unsubscribed", "suppressed"	no
`email`	query	string	no
`bounce_type`	query	one of "permanent", "transient", "undetermined"	no

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].contact_id`	string	yes	A UUID.
`data[].email`	string	yes
`data[].email_id`	string or null	yes	A UUID.
`data[].variant`	one of "a", "b", null or null	yes
`data[].status`	one of "pending", "sent", "skipped", "failed"	yes
`data[].skipped_reason`	string or null	yes
`data[].sent_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].count`	integer	no
`data[].clicked_links`	array of object	no
`data[].clicked_links[].url`	string	yes
`data[].clicked_links[].clicks`	integer	yes
`data[].bounce_type`	one of "permanent", "transient", "undetermined"	no
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/recipients \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.recipients("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listBroadcastRecipients 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import list_broadcast_recipients

result = list_broadcast_recipients.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListBroadcastRecipientsWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", &minket.ListBroadcastRecipientsParams{})

List the links a broadcast's recipients clicked

GET /v1/broadcasts/{id}/links

Most clicked first, with clicks (each recipient once a day per link) and unique_clicks (recipients). Page with a link's id as after or before.

Operation listBroadcastLinks, SDK minket.broadcasts.links. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`limit`	query	integer	no	Default `20`.
`after`	query	string	no
`before`	query	string	no

Response

200 Success: object.

Field	Type	Required
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes
`data[].url`	string	yes
`data[].clicks`	integer	yes
`data[].unique_clicks`	integer	yes
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/broadcasts/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/links \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.broadcasts.links("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listBroadcastLinks 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.broadcasts import list_broadcast_links

result = list_broadcast_links.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListBroadcastLinksWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", &minket.ListBroadcastLinksParams{})

Updated 30 October 2026