Create burst email configuration
- 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
POST https://api.rollstack.com/public/v1/bursts/{id}/email-configs
Adds an email configuration to a burst and answers it: one email to its recipients with the variants it selects, every variant by default. Sends nothing. Only the burst's owner and admins may.
Requires the slide_decks:email scope.
Operation ID: createBurstEmailConfig.
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/.
Headers
Idempotency-Key(string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.
Request body, required
application/json
name(string or null): The configuration's name, as shown in the burst's Emailing tab in the app.variantIds(array of string): The variants the email includes, by theiridinlistBurstVariants. Empty includes every variant, also those added later.sharingFormat(string): 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): 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): Whether the variants' files come in one zip file, with a file format.emailAnalyticsEnabled(boolean): Whether opens of the email are tracked.smtpServerId(string or null): The SMTP connection the email is sent through, fromlistSmtpConnections;nullsends from Rollstack's own address.to(array of string (email)): The addresses the email goes to.cc(array of string (email)): The addresses copied on the email, which every recipient can see.bcc(array of string (email)): The addresses that also receive the email without the others seeing them.replyTo(array of string (email)): Where replies to the email go.
Response 201
Success
application/json
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.