Skip to main content

Update burst email configuration

PATCH https://api.rollstack.com/public/v1/bursts/{id}/email-configs/{configId}

Changes the fields passed of a burst's email configuration and answers it. Sends nothing. Only the burst's owner and admins may.

Requires the slide_decks:email scope.

Operation ID: updateBurstEmailConfig.

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/.
  • configId (string, required): The email configuration, by its id from listBurstEmailConfigs.

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 their id in listBurstVariants. Empty includes every variant, also those added later.
  • 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. 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.
  • 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, from listSmtpConnections; null sends 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 200

Success

application/json

  • id (string, required): Identifies the configuration. Pass it as configId to 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 their id in listBurstVariants. Empty includes every variant, also those added later.
  • sharingFormat (string, required): 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. One of link, pdf, ppt, cloudLink.
  • sendAttachmentAsLink (boolean, required): 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.
  • 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, from listSmtpConnections; null sends 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.