Skip to main content

Send variant emails

POST https://api.rollstack.com/public/v1/bursts/{id}/variants/emails

Sends each variant's own email now, to its own recipients, as the app's Send does: every variant, or those passed. The template sends nothing. Every recipient gets an email. Only the burst's owner and admins may. Sends have a low rate limit. 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: sendBurstVariantEmails.

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

application/json

  • variantIds (array of string): The variants to act on, by their id in listBurstVariants, instead of every variant. Each must be a variant of this burst. 1 to 500 ids.

Response 202

Success

application/json

  • sending (array of object, required): The variants whose email is going out now, each to its own recipients. See each one's sends with listReportEmails.
    • id (string, required): The report's id.
    • name (string, required): The report's name.
  • skipped (array of object, required): The variants left out since their email has no one in to. Set them with updateBurstVariantRecipients.
    • id (string, required): The report's id.
    • name (string, required): The report's name.