Skip to main content

Set variant recipients

PUT https://api.rollstack.com/public/v1/bursts/{id}/variants/recipients

Sets who each variant's email goes to, replacing its to, cc and bcc. Its other email settings, such as its sender and which runs send it, stay as copied from the template; a variant without email settings gets the defaults. Sends no email. As in the app, the burst's owner and admins can set any variant's recipients, other members only those of variants they own or can edit; the others are skipped, as is a variant with several recipient groups, which the app asks to reconcile first.

Requires the slide_decks:email scope.

Operation ID: updateBurstVariantRecipients.

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

  • variants (array of object, required): The variants whose recipients to replace, 1 to 500. The other variants, and the rest of each variant's email settings, stay as they are.
    • id (string, required): The variant, by its id in listBurstVariants.
    • to (array of string (email), required): The addresses to send the variant's email to. If empty, no one receives it. At most 100 addresses across to, cc and bcc.
    • cc (array of string (email)): The addresses to copy on the variant's email, which every recipient can see. If omitted, no one is copied. Defaults to [].
    • bcc (array of string (email)): The addresses to also send the variant's email to without the other recipients seeing them. If omitted, no one is blind-copied. Defaults to [].

Response 200

Success

application/json

  • updated (array of string, required): The variants whose recipients were replaced, by their id.
  • skipped (array of string, required): The variants passed that were left as they were, by their id: those you can't edit, since you only contribute to the burst, and ids that aren't variants of it.