- 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
Who a report's email goes to and how it is sent: its recipients, the sender it goes out through, whether it carries the report as a link, a PDF or a PowerPoint file, and which successful runs send it on their own. Set it up once, then send it now or let the report's runs send it.
Send a test email to yourself to check how it looks first. Every send emails all the recipients, so sends have a low rate limit.
List sent emails of all reports
GET https://api.rollstack.com/public/v1/emails
The emails every report the user can see sent, of any type, newest first, each with its report, as the app's Email sends page lists them: pass status failed and since to find the ones that didn't go out, and burstId for one burst's. Same fields as listReportEmails. Answers up to limit emails, 20 by default and 200 at most, and a nextCursor: pass it as cursor for the next page, until it is null.
Requires the slide_decks:read scope.
Operation ID: listEmails.
Query parameters
limit(integer): Maximum number of emails to return on this page, from 1 to 200. Defaults to20.cursor(string): Where to continue the list: pass thenextCursorreturned with the previous page to get the next one. Omit it for the first page. Example:6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.status(string): Only the emails in this state, as the Email sends page filters them:failedthe ones that could not be sent,openedthe ones a recipient opened, anddeliveredthe ones the email server accepted, opened or not. If omitted, every email. One ofdelivered,failed,opened.since(string (date-time)): Only what happened at or after this time, as an ISO 8601 date and time in UTC, such as2026-11-08T18:00:00Z. If omitted, from the start. Example:2026-11-08T18:00:00Z.burstId(string): Only the emails of this burst, by itsidfromlistBursts: each variant's own emails, and the emails its email configurations sent, which list its template as their report. If omitted, every report's.
Response 200
Success
application/json
data(array of object, required): The emails every report you can see sent, of any type, newest first, with what the Email sends page hides from you left empty. To find the emails that failed, passstatusfailedandsince.id(string, required): Identifies the sent email.sentAt(string (date-time), required): When it was sent.status(string, required):deliveredwhen the email server accepted it,failedwhen it could not be sent (errorsays why), andopenedonce a recipient opened it, which Rollstack sees only when the organization has email analytics on. One ofdelivered,failed,opened.trigger(string or null, required):scheduledwhen a scheduled run of the report sent it;manualwhen someone sent it, in the app or withsendReportEmail.nullwhen it was not recorded. One ofmanual,scheduled.sender(object, required): The member it was sent as: who sent it, or whose run sent it.name(string or null, required)email(string, required)
subject(string or null, required): The email's subject.nullunless you own the report or it is shared with you directly, as on the Email sends page.to(array of string, required): The addresses it was sent to. Empty unless you own the report, it is shared with you directly, or you are an owner or admin of the organization.cc(array of string, required): The addresses copied on it, under the same rule asto.bcc(array of string, required): The addresses it was blind-copied to, under the same rule asto.error(string or null, required): Why it could not be sent, when itfailed.nullotherwise, or when you may not see itssubject.report(object, required): The report that sent it.id(string, required): The report'sid, to pass to the/reports/{id}endpoints, such asgetReport.name(string or null, required): The report's name.
nextCursor(string or null, required): Pass it ascursorto get the next page of emails.nullwhen there are no more.
Get email settings
GET https://api.rollstack.com/public/v1/reports/{id}/email-config
Who a report's email goes to and how it is sent, for a report of any type. Answers 404 until its email is set up, as on a burst's variant that sends no email of its own. For a burst, read listBurstVariants, which has every variant's recipients, and listBurstEmailConfigs rather than calling this on each variant. On an older report that sends to several recipient groups, to, cc, bcc and replyTo list every group's addresses together.
Requires the slide_decks:read scope.
Operation ID: getReportEmailConfig.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
Response 200
Success
application/json
to(array of string, required): The addresses the report's email is sent to. When empty, no one receives it: the report's runs send no email andsendReportEmailreturns 400.cc(array of string, required): The addresses copied on the report's email, which every recipient can see.bcc(array of string, required): The addresses that also receive the report's email without the other recipients seeing them.replyTo(array of string, required): The addresses recipients' replies go to instead of the sender. They don't receive the email themselves. Empty when replies go to the sender.groupRecipients(boolean, required): Whether all the addresses intoreceive one email together. Whenfalse, each address intogets its own email with the samecc,bccandreplyTo, so the addresses inccandbccreceive one copy per address into.smtpServerId(string or null, required): The SMTP connection the report's email is sent through, fromlistSmtpConnections; recipients see itsfromaddress as the sender.nullwhen the email is sent from Rollstack's own address.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.trigger(string, required): 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. One ofall,none,scheduled.ignoredFailureStatusMessages(array of string, required): The failures that don't stop a run from emailing the report (seetrigger). A run with failures still sends the email when all of them are in this list. On a slide deck, a run in which every datasheet fails never does. A slide deck's run records each failed datasheet asinternal_server_error, so on a slide deck that is the only value with an effect. An older report's run records each failed sync's own reason, theerror.codelistReportSyncsshows.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, required): Whether Rollstack tracks when recipients open the report's email; opened emails show as Opened in the report's Email sends panel in the app. Opens are tracked only while email analytics is also on for the organization (emailAnalyticsEnabledfromgetOrganization). Rollstack detects them through an invisible image in the email.createdAt(string (date-time), required): When the report's email settings were created. Until they exist,getReportEmailConfigreturns 404.updatedAt(string (date-time), required): When the report's email settings were last saved. Changes the slides agent makes to the recipients alone don't update it.
Replace email settings
PUT https://api.rollstack.com/public/v1/reports/{id}/email-config
Sets who a report's email goes to and how it is sent, for a report of any type, replacing the settings this endpoint covers; Drive sharing, attachment folders and the email's subject and body stay as set in the app. Only its editors may. The sender must be the user's own or shared with the organization. A report that sends to several recipient groups returns 400: change those in the app.
Requires the slide_decks:email scope.
Operation ID: updateReportEmailConfig.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
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
to(array of string, required): The addresses to send the report's email to. If empty, no one receives it: the report's runs send no email andsendReportEmailreturns 400. At most 100 addresses acrossto,ccandbcc.cc(array of string): The addresses to copy on the report's email, which every recipient can see. If omitted, no one is copied. Counts toward the 100 addresses allowed acrossto,ccandbcc. Defaults to[].bcc(array of string): The addresses to also send the report's email to without the other recipients seeing them. If omitted, no one is blind-copied. Counts toward the 100 addresses allowed acrossto,ccandbcc. Defaults to[].replyTo(array of string): The addresses recipients' replies should go to instead of the sender. They don't receive the email themselves. If omitted, replies go to the sender. Defaults to[].groupRecipients(boolean): Whether to send one email to all the addresses intotogether. Set it tofalseto send each address intoits own email with the samecc,bccandreplyTo; the addresses inccandbccthen receive one copy per address into. Defaults totrue.smtpServerId(string or null): The SMTP connection to send the report's email through, fromlistSmtpConnections; recipients see itsfromaddress as the sender. Ifnullor omitted, the email is sent from Rollstack's own address. A connectionlistSmtpConnectionsdoesn't list, or a Google or Microsoft account Rollstack can no longer send from, returns 403 unless it is already the report's sender. Defaults tonull. Example:9f8e7d6c-5b4a-4392-8170-6f5e4d3c2b1a.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.cloudLinkon an older report,linkon a slide deck, orppton a Google Docs or Word report returns 400. ForcloudLink, set up the export in the report's Update runs settings in the app first. If omitted, keeps the current format, or for a report whose email isn't set up yet,pdfon a slide deck andlinkon an older report. 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, keeps the current setting, or for a report whose email isn't set up yet,trueon a slide deck andfalseon an older report.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. Defaults toall. One ofall,none,scheduled.ignoredFailureStatusMessages(array of string): The failures that shouldn't stop a run from emailing the report (seetrigger). A run with failures still sends the email when all of them are in this list. On a slide deck, a run in which every datasheet fails never does. On a slide deck, includeinternal_server_errorto email the report even when some of its datasheets fail. On an older report, include theerror.codevalues fromlistReportSyncsto ignore. Defaults toslide_not_foundalone, so by default a slide deck's run with any failed datasheet sends no email, and an older report's run still emails when only syncs on a missing slide fail.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.
Defaults to
["slide_not_found"].emailAnalyticsEnabled(boolean): Whether to track when recipients open the report's email; opened emails show as Opened in the report's Email sends panel in the app. Setting it totruereturns 403 unless email analytics is on for the organization (emailAnalyticsEnabledfromgetOrganization). Defaults tofalse.
Response 200
Success
application/json
to(array of string, required): The addresses the report's email is sent to. When empty, no one receives it: the report's runs send no email andsendReportEmailreturns 400.cc(array of string, required): The addresses copied on the report's email, which every recipient can see.bcc(array of string, required): The addresses that also receive the report's email without the other recipients seeing them.replyTo(array of string, required): The addresses recipients' replies go to instead of the sender. They don't receive the email themselves. Empty when replies go to the sender.groupRecipients(boolean, required): Whether all the addresses intoreceive one email together. Whenfalse, each address intogets its own email with the samecc,bccandreplyTo, so the addresses inccandbccreceive one copy per address into.smtpServerId(string or null, required): The SMTP connection the report's email is sent through, fromlistSmtpConnections; recipients see itsfromaddress as the sender.nullwhen the email is sent from Rollstack's own address.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.trigger(string, required): 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. One ofall,none,scheduled.ignoredFailureStatusMessages(array of string, required): The failures that don't stop a run from emailing the report (seetrigger). A run with failures still sends the email when all of them are in this list. On a slide deck, a run in which every datasheet fails never does. A slide deck's run records each failed datasheet asinternal_server_error, so on a slide deck that is the only value with an effect. An older report's run records each failed sync's own reason, theerror.codelistReportSyncsshows.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, required): Whether Rollstack tracks when recipients open the report's email; opened emails show as Opened in the report's Email sends panel in the app. Opens are tracked only while email analytics is also on for the organization (emailAnalyticsEnabledfromgetOrganization). Rollstack detects them through an invisible image in the email.createdAt(string (date-time), required): When the report's email settings were created. Until they exist,getReportEmailConfigreturns 404.updatedAt(string (date-time), required): When the report's email settings were last saved. Changes the slides agent makes to the recipients alone don't update it.
List sent emails
GET https://api.rollstack.com/public/v1/reports/{id}/emails
The emails a report of any type sent, newest first: when, how, to whom, and whether each was delivered, failed or opened. To check many reports, call listEmails instead, which lists every report's emails with their report, and a burst's with its burstId. Answers up to limit emails, 20 by default and 200 at most, and a nextCursor: pass it as cursor for the next page, until it is null.
Requires the slide_decks:read scope.
Operation ID: listReportEmails.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
Query parameters
limit(integer): Maximum number of emails to return on this page, from 1 to 200. Defaults to20.cursor(string): Where to continue the list: pass thenextCursorreturned with the previous page to get the next one. Omit it for the first page. Example:6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.
Response 200
Success
application/json
data(array of object, required): The emails the report sent, newest first: the ones sent withsendReportEmailor from the app, and the ones its schedules' runs sent. Set up who gets them withupdateReportEmailConfig.id(string, required): Identifies the sent email.sentAt(string (date-time), required): When it was sent.status(string, required):deliveredwhen the email server accepted it,failedwhen it could not be sent (errorsays why), andopenedonce a recipient opened it, which Rollstack sees only when the organization has email analytics on. One ofdelivered,failed,opened.trigger(string or null, required):scheduledwhen a scheduled run of the report sent it;manualwhen someone sent it, in the app or withsendReportEmail.nullwhen it was not recorded. One ofmanual,scheduled.sender(object, required): The member it was sent as: who sent it, or whose run sent it.name(string or null, required)email(string, required)
subject(string or null, required): The email's subject.nullunless you own the report or it is shared with you directly, as on the Email sends page.to(array of string, required): The addresses it was sent to. Empty unless you own the report, it is shared with you directly, or you are an owner or admin of the organization.cc(array of string, required): The addresses copied on it, under the same rule asto.bcc(array of string, required): The addresses it was blind-copied to, under the same rule asto.error(string or null, required): Why it could not be sent, when itfailed.nullotherwise, or when you may not see itssubject.
nextCursor(string or null, required): Pass it ascursorto get the next page of emails.nullwhen there are no more.
Send email
POST https://api.rollstack.com/public/v1/reports/{id}/emails
Emails a report to its recipients now, as it is. Only its editors may. Answers 400 when it has no recipients. An email report needs its email template set up in the app first. Sends in the background; while the user's send of the report is going, starts nothing. At most 5 sends a minute per user, test sends included. From an AI client, the send only asks the user to confirm it in Rollstack: it answers confirmation-required and runs once they confirm.
Requires the slide_decks:email scope.
Operation ID: sendReportEmail.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
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.
Response 204
Success, no content
Send test email
POST https://api.rollstack.com/public/v1/reports/{id}/emails/test
Sends a report's email to the user only, and waits until it is sent. Only its editors may. Counts against the 5 sends a minute.
Requires the slide_decks:email scope.
Operation ID: sendReportTestEmail.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
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.
Response 204
Success, no content