Skip to main content

Send burst email configuration test

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

Sends a burst's email configuration to you alone, to check how it looks before sending it. Only the burst's owner and admins may. Sends have a low rate limit.

Requires the slide_decks:email scope.

Operation ID: sendBurstEmailConfigTest.

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.

Response 200

Success

application/json

  • id (string, required): The email configuration.
  • name (string or null, required): The email configuration's name.