Set variant email settings
- 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
PATCH https://api.rollstack.com/public/v1/bursts/{id}/variants/email-settings
Changes how the variants' own emails are sent, as the app's Burst settings in its Emailing tab do: only the settings passed, on the template, whose settings new variants copy, and on the variants. Each keeps its recipients: set them with updateBurstVariantRecipients. Sends no email. Members who only contribute change their own variants. See a report's settings with getReportEmailConfig.
Requires the slide_decks:email scope.
Operation ID: updateBurstVariantEmailSettings.
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
variantIds(array of string): The reports to change, by theirid: variants fromlistBurstVariants, and the burst'stemplateReportId, whose settings new variants copy. If omitted, the template and every variant you can edit.smtpServerId(string or null): The SMTP connection to send the emails through, fromlistSmtpConnections;nullsends from Rollstack's own address. If omitted, each report keeps its own sender.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. If omitted, stays as it is. 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. If omitted, stays as it is.trigger(string): Which of the report's runs email it automatically. A run emails it when it updates everything, or when all its failures are inignoredFailureStatusMessages. On a slide deck,allandscheduledwork the same way: only runs started by its schedules (seegetReportSchedules) send the email, and a slide deck with no datasheets is never emailed by its runs. On an older report,allemails after every run of the whole report, whether started by a schedule, withstartReportRunor in the app, andscheduledonly after runs its schedules start; a run of only some syncs never emails it. Withnone(Manual in the app), no run sends it: the email goes out only when sent withsendReportEmailor from the app. If omitted, stays as it is. One ofall,none,scheduled.groupRecipients(boolean): Whether each variant sends one email to all itstoaddresses together, rather than one email per address. If omitted, stays as it is.ignoredFailureStatusMessages(array of string): The failures that shouldn't stop a run from emailing a variant (seetrigger), such as theerror.codevalues fromlistReportSyncs. If omitted, stays as it is.The other values describe why a sync of an older report failed, and have an effect only on older reports:
dashboard_not_found, or the oldertableau_view_not_found: the dashboard, Tableau workbook, Power BI report or spreadsheet could not be found.dashboard_tab_not_found: the dashboard tab, Tableau view, Power BI report page or spreadsheet sheet could not be found.dashboard_not_ready: the dashboard took too long to load.dashboard_has_errors: the dashboard or spreadsheet failed to load because of an error in the tool it comes from.dashboard_invalid_layout: the dashboard's layout is invalid, and it needs to be saved again.element_not_found, or the oldermetabase_element_not_foundandlooker_element_not_found: the visualization could not be found.slide_not_found, or the oldergoogle_slide_not_found: the slide that shows the visualization could not be found.file_not_found: the spreadsheet file the visualization comes from could not be found.sheet_not_found: the spreadsheet sheet could not be found.sheet_hidden: the spreadsheet sheet is hidden and needs to be unhidden.range_not_found: the spreadsheet range could not be found.duplicate_file_failed: Rollstack could not prepare the spreadsheet file for the update.merged_range_on_filter_range: the visualization has merged cells, which filters can't be applied to.insufficient_permissions: the owner doesn't have edit access to the file.image_cropping_failed: Rollstack could not crop the visualization's image.visualization_not_found: the visualization could not be found in the dashboard.visualization_not_ready: the visualization took too long to load.visualization_has_errors: the visualization failed to load because of an error in the tool it comes from.visualization_empty, or the olderempty_data: the visualization is empty.invalid_credentials: the connection's credentials are invalid.missing_credentials: the connection's credentials were deleted, or the owner's access to it was suspended.instance_unavailable: the data source's instance is temporarily unavailable.column_not_found: a column the native chart uses is missing from its data.fetch_summary_data_error,fetch_visual_specification_error,missing_data,missing_formatted_valueandviz_not_ready: Rollstack could not fetch the data of a native chart.incorrect_data_structure: the native chart's structure doesn't fit its data.malformed_data: Rollstack could not fetch the data of a native chart or, from Snowflake, Databricks or BigQuery, the query is invalid.worksheet_not_found: the Tableau worksheet could not be found.sync_not_found: the visualization was deleted.file_update_failed: the data was fetched but could not be written into the file.
emailAnalyticsEnabled(boolean): Whether to track when recipients open the emails.truereturns 403 unless email analytics is on for the organization. If omitted, stays as it is.
Response 200
Success
application/json
updated(array of object, required): The reports whose email settings changed. Their recipients stay as they were.id(string, required): The report's id.name(string, required): The report's name.