Remove burst variants
- 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
POST https://api.rollstack.com/public/v1/bursts/{id}/variants/remove
Removes variants of a burst by their ids, and deletes their reports. Find the ids with listBurstVariants, which shows each variant's parameter or filter values, and confirm them with the user. An older report's variant file stays in Google Drive or OneDrive. The user must be able to edit every variant passed, or nothing is removed: the burst's owner and admins can edit them all, other members only their own. From an AI client, the removal only asks the user to confirm it in Rollstack: it answers confirmation-required and runs once they confirm.
Requires the slide_decks:write scope.
Operation ID: removeBurstVariants.
Path parameters
id(string, required): The burst to act on, by itsidfromlistBursts. 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
variantIds(array of string, required): The variants to remove, by theiridinlistBurstVariants, which shows each one's parameter or filter values. Each must be a variant of this burst. 1 to 500 ids.
Response 200
Success
application/json
removed(array of object, required): The variants removed, whose reports are deleted.id(string, required): The removed variant's report id.name(string, required): The removed variant's report name.