Skip to main content

Set variant email settings

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 its id from listBursts. 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 their id: variants from listBurstVariants, and the burst's templateReportId, 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, from listSmtpConnections; null sends from Rollstack's own address. If omitted, each report keeps its own sender.
  • sharingFormat (string): How the email delivers the report. pdf and ppt send it as a PDF or PowerPoint file, attached or behind a download button (see sendAttachmentAsLink); a slide deck leaves its hidden slides out. link sends 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 contain link is 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 in to, cc and bcc with 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 of link, pdf, ppt, cloudLink.
  • sendAttachmentAsLink (boolean): Whether the email puts the pdf or ppt file behind a Download PDF or Download PPT button instead of attaching it. When false, the file is attached. Has no effect with cloudLink. 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 in ignoredFailureStatusMessages. On a slide deck, all and scheduled work the same way: only runs started by its schedules (see getReportSchedules) send the email, and a slide deck with no datasheets is never emailed by its runs. On an older report, all emails after every run of the whole report, whether started by a schedule, with startReportRun or in the app, and scheduled only after runs its schedules start; a run of only some syncs never emails it. With none (Manual in the app), no run sends it: the email goes out only when sent with sendReportEmail or from the app. If omitted, stays as it is. One of all, none, scheduled.
  • groupRecipients (boolean): Whether each variant sends one email to all its to addresses 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 (see trigger), such as the error.code values from listReportSyncs. 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 older tableau_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 older metabase_element_not_found and looker_element_not_found: the visualization could not be found.
    • slide_not_found, or the older google_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 older empty_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_value and viz_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. true returns 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.