Rename burst
- 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
PATCH https://api.rollstack.com/public/v1/bursts/{id}
Renames a burst and answers it, and with renameVariants its reports too. Only the burst's owner and admins may.
Requires the slide_decks:write scope.
Operation ID: renameBurst.
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
name(string, required): The burst's new name.renameVariants(boolean): Whether to rename every report in the burst after the new name too, asvariantNamingbuilds each name, the template included. A Rollstack report's burst renames the template, which is the report the burst was made from. Defaults tofalse.renameFiles(boolean): For a burst of Google Slides, Google Docs, PowerPoint or Word reports: whether to also rename the burst's folders, and withrenameVariantseach report's file, in Google Drive or OneDrive. It goes on after the answer. Defaults tofalse.
Response 200
Success
application/json
id(string, required): Unique identifier for the burst. Pass it asidto the other/bursts/{id}endpoints.name(string, required): Name of the burst, as members see it in Rollstack. It is the template report's name when the burst is created, and is part of each variant report's name unlessvariantNamingissameName.folderId(string or null, required): The folder the burst is in, by itsidinlistFolders.nullwhen the burst is at the top level.owner(object, required): The member who owns the burst: whoever created it, unless ownership has since been transferred in the app.id(number, required): The owner's user id, the same as theiridinlistMembers.name(string, required): The owner's name, as shown in Rollstack.email(string, required): The owner's email address.
templateReportId(string or null, required): The template report, which every variant was copied from when it was added, by itsidforgetReportand the other/reports/{id}endpoints. Changes to the template reach existing variants only when pushed from the app; variants added later copy it as it is then.nullif the template was deleted.variantNaming(string, required): How each variant's report is named from the burst's name and the name the variant is added with,EMEAin a burst namedRegional Review:suffixgivesRegional Review - EMEA,prefixgivesEMEA - Regional Review, andsameNamegivesEMEA. It applies to variants added from then on. One ofsameName,prefix,suffix.kind(string, required): What the variants differ by.parameters: report parameters of a Rollstack report, listed inparametersand set withparametersinaddBurstVariants.filters: filters of an older report's syncs, such as a Google Slides or PowerPoint file, listed infiltersand set withfiltersinaddBurstVariants. One ofparameters,filters.reportType(string, required): The type of report the burst copies, astypeinlistReports:SlideDeckfor a Rollstack report, which bursts byparameters, any other type for an older report, which bursts byfilters. One ofGoogleDocs,GoogleSlides,MicrosoftPowerPoint,MicrosoftWord,Email,UploadedPPTXFile,SlideDeck.parameters(array of object, required): The template report's parameters the variants differ by, in the order their values name a variant. Each variant holds its own value of each, which its datasheets' filters read. Empty for a burst byfilters.id(string, required): The report parameter's id on the template report. Use it as a key ofparametersinaddBurstVariants.name(string, required): The report parameter's name, as shown in Rollstack.value(object or null, required): The template's value of the parameter, which a variant keeps when it doesn't set one.nullwhen the template has none. A value of a report parameter, in the shape of its type. Copy the shape of the parameter'svalueinlistBursts, or of a variant's inlistBurstVariants:- A list of values:
{ "type": "categorical", "values": ["EMEA"] }, with at least one value.operatorcan also beis_not,containsordoesnt_contain; it isiswhen left out. - A number:
{ "type": "number", "value": 10 }. Text:{ "type": "text", "value": "EMEA" }. - A date range:
{ "type": "date", "subtype": "date_range", "startDate": "2026-01-01", "endDate": "2026-03-31" }. One date:{ "type": "date", "subtype": "date_single", "date": "2026-03-31" }. - A month or a quarter:
{ "type": "date", "subtype": "date_month_year", "month": 3, "year": 2026 }(months 1 to 12),{ "type": "date", "subtype": "date_quarter_year", "quarter": 1, "year": 2026 }. - A relative period:
{ "type": "date", "subtype": "date_relative", "rangeType": "lastN", "rangeN": 3, "periodType": "months" }.rangeTypeiscurrent,lastNornextN;periodTypeisdays,weeks,months,quartersoryears, orcompleteDaysthroughcompleteYearsfor whole periods only. - When
typeiscategoricaltype(categorical, required)values(array of string or number, required)operator(string): One ofis,is_not,contains,doesnt_contain.
- When
typeisdateandsubtypeisdate_rangetype(date, required)subtype(date_range, required)startDate(string, required)endDate(string, required)
- When
typeisdateandsubtypeisdate_relativetype(date, required)subtype(date_relative, required)rangeType(string, required): One ofcurrent,lastN,nextN.rangeN(number, required)periodType(string, required): One ofdays,weeks,months,quarters,years,completeDays,completeWeeks,completeMonths,completeQuarters,completeYears.
- When
typeisdateandsubtypeisdate_month_yeartype(date, required)subtype(date_month_year, required)month(number, required)year(number, required)
- When
typeisdateandsubtypeisdate_quarter_yeartype(date, required)subtype(date_quarter_year, required)quarter(number, required)year(number, required)
- When
typeisdateandsubtypeisdate_singletype(date, required)subtype(date_single, required)date(string, required)
- When
typeisdateandsubtypeisdate_nulltype(date, required)subtype(date_null, required)
- When
typeisnumbertype(number, required)value(number, required)
- When
typeistexttype(text, required)value(string, required)
- A list of values:
filters(array of object, required): The filters of the template report's syncs that the variants differ by, primary ones first in the order their values name a variant. Each variant holds its own value of each, applied to the syncs that read the filter's dashboard. Empty for a burst byparameters.id(string, required): The filter's id. Use it as a key offiltersinaddBurstVariants.name(string, required): The filter's name on its dashboard, as shown in Rollstack.primary(boolean, required): Whether the filter names the variants: a variant added without anameis named after its primary filters' values, in order. A secondary filter only narrows what each variant shows.valueType(string or null, required): The kind of value the filter takes, and so thetypeof a variant's value of it.nullwhen Rollstack doesn't know the filter's editor: copy the shape of a variant's value instead. One ofcategorical,date,number,text.
variantCount(number, required): How many variants the burst has, including any you can't open.appUrl(string (uri), required): Link that opens the burst in Rollstack.createdAt(string (date-time), required): When the burst was created.listBurstsreturns the newest first.updatedAt(string (date-time), required): When the burst's details last changed.