client.broadcasts
Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.
Métodos
One message sent to everybody in one or more audiences, a personalised copy for each person, with unsubscribe handled for you.
broadcasts.preview
Count who a broadcast to some audiences would reach
preview(body = nil, api_key: nil, **fields) -> HashReturns the numbers send would work from, without sending or writing anything: recipients, the people a broadcast to these audiences would reach now, unsubscribed, the contacts skipped because they have unsubscribed from every one of these audiences they are in, and suppressed, the subscribed contacts skipped because their address is on the suppression list. A contact in several of the audiences counts once.
The count is taken at the moment of the call, so contacts who join or leave before a send change it. Only audienceIds is sent, so you can pass the same Hash you are about to give send.
Parâmetros
audienceIdsArray<String>Obrigatório1 to 10 audience ids. One that names no audience in the workspace is a 404
audience_not_found.api_keyStringOverrides the client's API key for this call only.
Devolve
A Hash with audienceIds as sent, recipients, unsubscribed and suppressed.
Exemplo
draft = { audienceIds: ["aud_4c1b8e2a7d9f05c36b4e8a71", "aud_7e3d9a1c5b2f84e06d9a3c51"], from: "Acme <[email protected]>", subject: "The September release", text: "Hi {{firstName|there}}, here is what changed this month."} reach = client.broadcasts.preview(draft) puts "#{reach[:recipients]} will get it, #{reach[:unsubscribed]} unsubscribed, #{reach[:suppressed]} suppressed" client.broadcasts.send(draft) if reach[:recipients] > 0Notas
Needs only
audiences:read, so a key that cannot send can still show somebody the count.The SDK retries it after a network failure or a retryable status, since it changes nothing.
Também disponível em
broadcasts.send
Send one message to everybody in one or more audiences
send(body = nil, idempotency_key: nil, api_key: nil, **fields) -> HashCreates a broadcast: one message sent to every contact in the audiences you name, as a separate copy for each person. Every copy has exactly one recipient and no cc or bcc, so nobody sees who else it went to, and every copy is an ordinary email with its own msg_ id, events, tracking and webhooks. emails.list with broadcast_id: lists them. Copies are not filed in the Sent folder, because the broadcast is the record.
The call returns straight away with the broadcast queued, or scheduled when you pass scheduledAt, and the sending happens in the background, 50 people at a time. Poll get to follow status and counts as it goes.
Who gets it: every contact in at least one of audienceIds, counted once however many of them hold it, except a contact that has unsubscribed from every one of those audiences it is in, and except an address on the suppression list. A contact added to one of the audiences after this call but before the sending reaches it is included. counts.recipients is the estimate taken at the call, and preview returns the same count without sending.
subject, html and text take merge fields, filled in from each contact: firstName, lastName, name, email and unsubscribeUrl, each written between double braces. Each takes a fallback after a bar, so {{firstName|there}} reads there for a contact with no name. The first name is the first word of the contact's name and the last name is the rest. Values are escaped in html, and any other {{…}} is left as written. With template, the same values are passed as props, but only the ones the template declares.
Every copy carries the one-click unsubscribe headers mail clients and the large mailbox providers look for. An html or text body that does not place the unsubscribeUrl merge field itself gets a one-line footer with the link, while a template is sent as it is, so put the unsubscribeUrl merge field in the template. Following the link marks the person unsubscribed in every audience this broadcast went to. Their other audiences, their contact and mail sent to them one message at a time are not affected.
The whole send is checked against the plan's monthly sends before anything is written. A broadcast the allowance cannot cover raises 429 send_quota_exceeded and leaves nothing behind, and each copy counts as one send.
Parâmetros
audienceIdsArray<String>Obrigatório1 to 10 audience ids such as
aud_9f2c4b7e1a0d63d84c5f2e7b. A contact in several of them gets one copy. An id that names no audience in the workspace is a 404audience_not_foundand nothing is sent.fromString or HashObrigatórioSender as
[email protected],Acme <[email protected]>or a Hash withemailandname. It must be an address the key may send as, otherwise 403from_address_forbidden.replyToString or HashWhere replies go, the same for every copy.
subjectStringRequired unless a template supplies it, at most 998 characters. Takes merge fields.
htmlStringHTML body, at most 1,000,000 characters, with merge fields. Without the
unsubscribeUrlmerge field in it an unsubscribe footer is added.textStringPlain text body, at most 1,000,000 characters, with merge fields. Without the
unsubscribeUrlmerge field in it an unsubscribe line is added.templateHashA stored template instead of
htmlandtext, never beside them, as a Hash withidand optionallyversion,propsandslots. The merge values reach it as props it declares, such asfirstNameandunsubscribeUrl.trackingHashOpen and link tracking for every copy, as a Hash with
opensandclicks, each true or false. A field left out follows the address it is sent from when that address set it, and is on otherwise.tagsHashA Hash of up to 8 tags, keys of 1 to 64 letters, digits,
_or-, values up to 256 characters. Every copy carries them, plusbroadcast_id, which the server adds.scheduledAtTime, Date or StringA
Time, an ISO 8601 instant or a duration such asPT2HorP1D, in the future and at most 365 days out. ATimegoes out as a UTC ISO 8601 instant. Left out, the sending starts straight away.idempotency_keyStringYour own key, 1 to 255 characters of letters, digits,
_,.,:or-. Left out, the SDK makes one for the call, so its own retries never send twice. Sending the same key again answers with the broadcast it created instead of a new one. The same key with a different body is a 422idempotency_key_reuse.api_keyStringSends with this key instead of the client's.
Devolve
A Hash, the broadcast as get returns it plus replayed, with id (brd_ plus 24 hex), status queued or scheduled, audienceIds, from, subject, scheduledAt, createdAt and counts, whose recipients is the estimate and whose other counts start at 0.
Exemplo
broadcast = client.broadcasts.send( audienceIds: ["aud_4c1b8e2a7d9f05c36b4e8a71"], from: "Acme <[email protected]>", subject: "{{firstName|Hello}}, the September release is out", html: "<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p><p><a href=\"{{unsubscribeUrl}}\">Unsubscribe</a></p>", text: "Hi {{firstName|there}},\n\nHere is what changed this month.\n\nUnsubscribe: {{unsubscribeUrl}}", tags: {campaign: "release-2026-09"}, scheduledAt: "PT2H") puts broadcast[:id], broadcast[:status], broadcast[:replayed], broadcast[:counts][:recipients]Notas
Safe to retry. Every call carries an
Idempotency-Key, yours or one the SDK makes, so a retry after a network failure answers with the broadcast the first attempt created, withreplayed: true, instead of sending again. Keys are scoped to the API key or app that sent them. Reusing a key with a different body is a 422idempotency_key_reuse.Refusals: 422
no_recipientswhen the audiences are empty or everybody in them has unsubscribed or is suppressed, 409domain_not_sendablewhen thefromdomain cannot sign mail yet, 422 ontemplate.*when the template does not resolve.No attachments, cc, bcc, translation or encryption. A body from
htmlortextand atemplatetogether are refused.A test key (
oe_test_) creates a broadcast whose copies are marked sent and delivered to nobody, like any test send.
Também disponível em
- API
POST /broadcasts- TypeScript
broadcasts.send()- Python
broadcasts.send()- CLI
openemail broadcasts send
broadcasts.list
List one page of broadcasts, newest first
list(audience_id: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::PageReturns one page of the broadcasts in the workspace, newest first, each with live counts. audience_id: keeps the ones that were sent to that audience, alone or beside others.
Paging is keyset: limit: takes 1 to 100 and defaults to 25, and next_cursor, the id of the last broadcast on the page, goes back as cursor: while has_more? is true. Send the same audience_id: with every page. list_all and iterate do that walk for you.
The individual messages are not here. List the copies of one broadcast with emails.list and broadcast_id:.
Parâmetros
audience_idStringOnly the broadcasts that included this audience. An id that names no audience answers an empty page.
limitIntegerRows per page, a whole number from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page, a broadcast id. One that names no broadcast in the workspace is a 400invalid_cursor.api_keyStringOverrides the client's API key for this call only.
Devolve
An OpenEmail::Page with items, has_more? and next_cursor. Each item is a Hash with id, status, audienceIds, from, subject, counts and the timestamps.
Exemplo
page = client.broadcasts.list(audience_id: "aud_4c1b8e2a7d9f05c36b4e8a71", limit: 10) page.items.each do |broadcast| counts = broadcast[:counts] puts "#{broadcast[:createdAt]} #{broadcast[:subject]} #{broadcast[:status]} #{counts[:sent]}/#{counts[:recipients]}"endNotas
A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
Também disponível em
- API
GET /broadcasts- TypeScript
broadcasts.list()- Python
broadcasts.list()- CLI
openemail broadcasts list
broadcasts.list_all
Collect every broadcast into one array
list_all(audience_id: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every broadcast in the workspace, newest first, or every one sent to audience_id: when you pass it. limit sets the page size of each request, not the total.
Parâmetros
audience_idStringOnly the broadcasts that included this audience.
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA broadcast id to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Devolve
An Array of Hashes holding every broadcast across all pages, each shaped like an item of list.
Exemplo
broadcasts = client.broadcasts.list_all(limit: 100) sent = broadcasts.sum { |broadcast| broadcast[:counts][:sent] } puts "#{broadcasts.size} broadcasts, #{sent} copies sent"Notas
A failure on any page raises, and the broadcasts already fetched are discarded.
Every row carries live counts, so collecting a long history reads the copies of every broadcast in it. Use
iterateto stop early.A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
Também disponível em
- API
GET /broadcasts- TypeScript
broadcasts.listAll()- Python
broadcasts.list_all()
broadcasts.iterate
Stream broadcasts one at a time, newest first
iterate(audience_id: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields broadcasts one at a time, newest first, or passes each one to the block you give it, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests, so this is the cheap way to find the latest broadcast that matches something the filters cannot express.
Parâmetros
audience_idStringOnly the broadcasts that included this audience.
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA broadcast id to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Devolve
An Enumerator of Hashes, one broadcast per step, each shaped like an item of list, or yields each one to a block.
Exemplo
sending = client.broadcasts.iterate.find { |broadcast| broadcast[:status] == "sending" } puts "still going: #{sending[:id]}, #{sending[:counts][:queued]} waiting" if sendingNotas
Pages are fetched only as the loop reaches them, so an abandoned loop costs only the pages you consumed.
A key limited to particular addresses or domains lists only the broadcasts sent from an address or domain it holds.
Também disponível em
- API
GET /broadcasts- TypeScript
broadcasts.iterate()- Python
broadcasts.iterate()
broadcasts.get
Read one broadcast and how far it has got
get(id, api_key: nil) -> HashReturns one broadcast with counts read live from its copies, which makes this the call to poll while it sends.
status moves from scheduled or queued to sending and settles on sent once every copy handed over has gone out or failed. It reads sending for as long as copies are still waiting, even after the last person was reached and completedAt was set. cancelled and failed are the other two ends, and on failed lastError says why: the from address can no longer be sent from, the template stopped resolving, the plan ran out part way, the sending itself kept failing, or not one copy could be written.
counts.recipients is the estimate taken when it was created. created is the copies written, one per person reached, skipped the people passed over because their address was suppressed by then, and failedToQueue the people whose copy could not be written. queued, sending, sent, failed and cancelled count the copies by the state each one is in now.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.api_keyStringOverrides the client's API key for this call only.
Devolve
A Hash with id, status, mode, source, audienceIds, from, subject, counts, lastError, scheduledAt, startedAt, completedAt, cancelledAt, createdAt and updatedAt.
Exemplo
broadcast = client.broadcasts.get("brd_5a8c1e3f7b2d94a06c8e1f3b")counts = broadcast[:counts] if %w[sent cancelled failed].include?(broadcast[:status]) puts broadcast[:status], broadcast[:lastError]else puts "#{counts[:sent]} of #{counts[:recipients]} sent"endNotas
A missing broadcast raises
OpenEmail::ApiErrorwithnot_found?true and codebroadcast_not_found. An id from another workspace is a 404 too.For who each copy went to and what happened to it, use
list_recipients,get_recipientreads one copy with its content, andstatssums it up.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
- API
GET /broadcasts/{id}- TypeScript
broadcasts.get()- Python
broadcasts.get()- CLI
openemail broadcasts get
broadcasts.stats
Read how a broadcast performed
stats(id, grain: nil, offset_minutes: nil, days: nil, minutes: nil, api_key: nil) -> HashReturns the totals and a series for one broadcast. totals counts copies sent, delivered, bounced, complained (reported as spam) and failed, pending for the ones still waiting, and people who opened, clicked and unsubscribed, with opens and clicks as event counts. series is sparse and oldest first: one bucket per grain in which something happened, counting each person once at the first time it happened to them, so it adds up to the totals.
Pass days: or minutes: to also read what happened lately. window then counts the copies delivered, bounced, reported as spam, opened, clicked and unsubscribed inside it, and series keeps only its buckets, while totals still covers the whole broadcast. Without either, window is nil.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.grainStringBucket width:
minute,hourorday, defaulting tohour.offset_minutesIntegerMinutes east of UTC to cut the buckets in, from -840 to 840. Pass
Time.now.utc_offset / 60for the local zone.daysIntegerReads a window of this many days too, from 1 to 1095. It starts at the beginning of its first
grainbucket and ends now.minutesIntegerThe window in minutes, from 1 to 1576800, which wins over
dayswhen both are sent.api_keyStringOverrides the client API key for this call only.
Devolve
A Hash with broadcastId, grain, totals, window and series, each bucket of series a Hash with bucket, delivered, opened, clicked and unsubscribed. window is a Hash with since, delivered, bounced, complained, opened, clicked and unsubscribed, or nil when no window was asked for.
Exemplo
stats = client.broadcasts.stats("brd_5a8c1e3f7b2d94a06c8e1f3b", grain: "day")totals = stats[:totals] rate = totals[:sent].zero? ? 0 : totals[:opened].fdiv(totals[:sent]) puts "#{(rate * 100).round}% opened"Notas
Read only, so the SDK retries it after a network failure like any other read.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
- API
GET /broadcasts/{id}/stats- TypeScript
broadcasts.stats()- Python
broadcasts.stats()- CLI
openemail broadcasts stats
broadcasts.analytics
Read how broadcasts did over a time window
analytics(broadcast_ids: nil, days: nil, minutes: nil, grain: nil, offset_minutes: nil, api_key: nil) -> HashReturns the numbers behind the Analytics tab of the Broadcasts page in one request: how the live broadcasts sent inside a window did, added up in totals and cut to grain in series, and one row per broadcast in broadcasts so they can be compared.
A copy counts when it was sent inside the window, and everything that happened to it afterwards counts with it, so an open today of a copy sent last week is in a 30 day window but not in a 1 day one. Test mode broadcasts are left out. totals and series add up the broadcasts named in broadcast_ids:, or every one when it is left out, while broadcasts always lists every broadcast in the window, newest first.
series is sparse and oldest first: a bucket in which nothing happened has no entry, so a chart must fill the gaps. It counts each person once, at the first time it happened to them. grain: sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offset_minutes: shifts the boundaries so days break where the reader's day does. The window starts at the beginning of its oldest bucket, reported as since, and ends now, reported as until.
Parâmetros
broadcast_idsArray<String>Up to 50 broadcast ids for
totalsandseriesto add up, sent comma separated. Leave it out, or pass an empty Array, for every broadcast in the window. An id with no copy in the window adds nothing, and more than 50 is a 422.daysIntegerWindow length in days, from 1 to 1095, defaulting to 30.
minutesIntegerWindow length in minutes, from 1 to 1576800, which wins over
dayswhen both are sent.grainStringBucket width:
minute,hourorday, defaulting today.offset_minutesIntegerMinutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass
Time.now.utc_offset / 60for the local zone.api_keyStringOverrides the client API key for this call only.
Devolve
A Hash with object set to broadcast_analytics, since, until, grain, offsetMinutes, broadcastIds, totals, series and broadcasts. totals has broadcasts and the counts the totals of stats has, each entry of series is a Hash with bucket, sent, delivered, opened, clicked and unsubscribed, and each entry of broadcasts has id, subject, status, sentAt and the same counts.
Exemplo
analytics = client.broadcasts.analytics(days: 90, offset_minutes: Time.now.utc_offset / 60)totals = analytics[:totals] rate = totals[:delivered].zero? ? 0 : totals[:opened].fdiv(totals[:delivered]) puts "#{totals[:broadcasts]} broadcasts, #{(rate * 100).round}% opened" analytics[:broadcasts].each do |row| puts "#{row[:subject]}: #{row[:sent]} sent, #{row[:opened]} opened, #{row[:clicked]} clicked"endNotas
Read only, so the SDK retries it after a network failure like any other read.
opened,clickedandunsubscribedcount people, whileopensandclickscount events.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds, and the rest are left out as if they did not exist.
Também disponível em
broadcasts.list_recipients
List who a broadcast went to and what happened to each copy
list_recipients(id, filter: nil, q: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::PageReturns one page of the people a broadcast went to, one row per copy, sorted by address. Each row says the copy's status, when it was sent and delivered, whether it bounced or was reported as spam, how often it was opened and clicked, and whether the person unsubscribed from one of the broadcast's audiences after it went out.
Opens and clicks leave out image proxies and link scanners, and stay 0 when the broadcast went out with tracking off. emailId is the copy's msg_ id, which get_recipient reads with its content and emails.get reads as a sent email.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.filterStringKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.OpenEmail::BROADCAST_RECIPIENT_FILTERSnames them.qStringSearches the address and the name, ignoring case.
limitIntegerPage size, from 1 to 200. The server defaults to 50.
cursorStringThe
next_cursorof the previous page. Send the samefilter:andq:with it.api_keyStringOverrides the client API key for this call only.
Devolve
An OpenEmail::Page with items, has_more? and next_cursor. Each item is a Hash with emailId, contactId, email, name, status, sentAt, deliveredAt, bouncedAt, complainedAt, failure, opens, firstOpenAt, clicks, firstClickAt and unsubscribedAt.
Exemplo
page = client.broadcasts.list_recipients("brd_5a8c1e3f7b2d94a06c8e1f3b", filter: "bounced") page.items.each { |copy| puts "#{copy[:email]} #{copy[:bouncedAt]}" }Notas
A missing broadcast raises
OpenEmail::ApiErrorwith codebroadcast_not_found.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
broadcasts.list_all_recipients
Collect everybody a broadcast went to into one array
list_all_recipients(id, filter: nil, q: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list_recipients and returns every copy of the broadcast, sorted by address. One request per page, with the same filter: and q: on each.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.filterStringKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.OpenEmail::BROADCAST_RECIPIENT_FILTERSnames them.qStringSearches the address and the name, ignoring case.
limitIntegerPage size for each request, from 1 to 200. The server defaults to 50.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Devolve
An Array of Hashes holding every copy that matches, each shaped like an item of list_recipients.
Exemplo
unopened = client.broadcasts.list_all_recipients("brd_5a8c1e3f7b2d94a06c8e1f3b", filter: "not_opened") p unopened.map { |copy| copy[:email] }Notas
If any page fails the call raises, and the rows already fetched are discarded.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
broadcasts.iterate_recipients
Walk everybody a broadcast went to, one copy at a time
iterate_recipients(id, filter: nil, q: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Yields every copy of the broadcast to the block one at a time, sorted by address, or returns an Enumerator of them when no block is given. It fetches the next page only when the loop asks for it, and breaking out of the loop stops the requests.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.filterStringKeeps one group:
pending,sent,delivered,opened,not_opened(sent and never opened),clicked,bounced,complained,failed(failed or cancelled) orunsubscribed.OpenEmail::BROADCAST_RECIPIENT_FILTERSnames them.qStringSearches the address and the name, ignoring case.
limitIntegerPage size for each request, from 1 to 200. The server defaults to 50.
cursorStringStarts after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Devolve
An Enumerator of Hashes, one copy per step, each shaped like an item of list_recipients, or yields each one to a block.
Exemplo
client.broadcasts.iterate_recipients("brd_5a8c1e3f7b2d94a06c8e1f3b", filter: "clicked") do |copy| puts "#{copy[:email]} #{copy[:clicks]}"endNotas
Memory stays flat however large the broadcast, because only one page is held at a time.
A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
broadcasts.get_recipient
Read one person's copy of a broadcast
get_recipient(id, email_id, api_key: nil) -> HashReturns one copy: the same row list_recipients gives, plus the subject, html and text exactly as that person received them, with the merge fields filled in and their own unsubscribe link. The HTML is from before open and click tracking was added.
Parâmetros
idStringObrigatórioA
brd_id fromsendorlist.email_idStringObrigatórioThe
emailIdof the copy, fromlist_recipients.api_keyStringOverrides the client API key for this call only.
Devolve
A Hash with emailId, contactId, email, name, status, sentAt, deliveredAt, bouncedAt, complainedAt, failure, opens, firstOpenAt, clicks, firstClickAt and unsubscribedAt, plus subject, html and text.
Exemplo
copy = client.broadcasts.get_recipient("brd_5a8c1e3f7b2d94a06c8e1f3b", "msg_01dad25067bc4dac966d515d") puts copy[:subject], copy[:deliveredAt]Notas
An
email_idthat is not a copy of this broadcast raises with coderecipient_not_found.A key limited to particular addresses or domains reads only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.
Também disponível em
broadcasts.cancel
Stop a broadcast that is scheduled, queued or still sending
cancel(id, api_key: nil) -> HashStops a broadcast that is scheduled, queued or sending, including one that has reached everybody while some copies are still waiting to go. Nobody else is added, and every copy still waiting is cancelled. A copy already being handed over finishes, and copies that have gone cannot be recalled, so counts.sent keeps them and counts.cancelled shows what was stopped.
Once every copy has gone out there is nothing left to stop, and the call raises 409 broadcast_not_cancellable. A failed broadcast with copies still waiting can be cancelled to stop them, and one with nothing waiting is refused the same way. Cancelling a broadcast that is already cancelled returns it as it stands, so the call is safe to repeat, and the SDK retries it after a network failure.
Parâmetros
idStringObrigatórioThe
brd_id to cancel.api_keyStringCancels with this key instead of the client's.
Devolve
A Hash, the broadcast as get returns it in its new state: status cancelled with cancelledAt set and the copies counted by where each one ended up.
Exemplo
scheduled = client.broadcasts.send( audienceIds: ["aud_4c1b8e2a7d9f05c36b4e8a71"], from: "[email protected]", subject: "Doors open on Friday", text: "Hi {{firstName|there}}, doors open at nine.", scheduledAt: "P1D") cancelled = client.broadcasts.cancel(scheduled[:id]) puts cancelled[:status], cancelled[:counts][:cancelled]Notas
Cancelling a scheduled broadcast before
scheduledAtsends nothing at all.A cancelled broadcast stays cancelled. There is no resume, so send again to the audiences that still need it.
A key limited to particular addresses or domains cancels only broadcasts sent from an address or domain it holds. Any other id raises
broadcast_not_found, as if the broadcast did not exist.