List burst email configurations
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/bursts/{id}/email-configs
A burst's email configurations, as the app's Burst email settings show them: each one email to its own recipients that includes every variant it selects, sent only when you send it. Unlike each variant's own email, which its runs send to its own recipients. What both sent is in listEmails with burstId.
Requires the slide_decks:read scope.
Operation ID: listBurstEmailConfigs.
Path parameters
id(string, required): The burst to act on, by itsidfromlistBursts. You can also copy it from the burst's link in Rollstack: it's the part right after/collections/.
Response 200
Success
application/json: array of object
id(string, required): Identifies the configuration. Pass it asconfigIdto the other/email-configs/{configId}endpoints.name(string or null, required): The configuration's name, as shown in the burst's Emailing tab in the app.variantIds(array of string, required): The variants the email includes, by theiridinlistBurstVariants. Empty includes every variant, also those added later.sharingFormat(string, required): How the email delivers the report.pdfandpptsend it as a PDF or PowerPoint file, attached or behind a download button (seesendAttachmentAsLink); a slide deck leaves its hidden slides out.linksends a link to the Google Drive or OneDrive file an older report updates, shared with the recipients as set in the app; an email report sends its content in the email itself, and a slide deck has no such file, so one whose settings still containlinkis emailed as a PDF behind a download button.cloudLink(Exported link in the app), for slide decks only, sends a link to the copy exported to Google Drive or OneDrive and shares it with the addresses into,ccandbccwith the sharing permission set in the app, viewer unless changed there; if no permission is set, as after PDF or PPT was picked in the app, the copy isn't shared with them. One oflink,pdf,ppt,cloudLink.sendAttachmentAsLink(boolean, required): Whether the email puts thepdforpptfile behind a Download PDF or Download PPT button instead of attaching it. Whenfalse, the file is attached. Has no effect withcloudLink.zipAttachments(boolean, required): Whether the variants' files come in one zip file, with a file format.emailAnalyticsEnabled(boolean, required): Whether opens of the email are tracked.smtpServerId(string or null, required): The SMTP connection the email is sent through, fromlistSmtpConnections;nullsends from Rollstack's own address.to(array of string, required): The addresses the email goes to.cc(array of string, required): The addresses copied on the email, which every recipient can see.bcc(array of string, required): The addresses that also receive the email without the others seeing them.replyTo(array of string, required): Where replies to the email go.createdAt(string (date-time), required): When the configuration was created.updatedAt(string (date-time), required): When the configuration last changed.