Share reports in a batch
- 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/reports/batch-share
Shares up to 50 reports of any type with the same members, with the same permission, as shareReport does for one. Each member gets one email listing the reports newly shared with them. Answers one result per report, each naming its id: a report you may not share fails on its own and the others are still shared, but a member who is not in the organization, or yourself, fails the whole call with nothing shared.
Requires the slide_decks:write scope.
Operation ID: batchShareReports.
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
ids(array of string, required): The reports to act on, of anytype, by theiridfromlistReports. From 1 to 50 ids; an id listed twice is acted on once.userIds(array of integer, required): The members to share every report with, by their useridfromlistMembers. Each must be an active member of the organization other than you, or the whole call fails with nothing shared. From 1 to 50 ids.permission(string, required): What the member can do with the report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. If the report is already shared with the member, this replaces their permission and they aren't notified again. On a report that updates a file in Google Drive or OneDrive, Rollstack also shares the file with them, as the app does. One ofview,comment,edit.
Response 200
Success
application/json
results(array of object, required): One result per report, each naming itsid.- When
statusisdoneid(string, required): The report, by itsidfromids.status(done, required): The call succeeded on this report.result(array of object, required): The members the report is now shared with, one for each ofuserIds.userId(number, required): The member the report is now shared with: theuserIdfrom the path.permission(string, required): What the member can now do with the report: thepermissionyou sent. One ofview,comment,edit.
- When
statusisfailedid(string, required): The report, by itsidfromids.status(failed, required): The call failed on this report and changed nothing on it. The other reports are unaffected.error(object, required): Why this report failed, as the endpoint for one report would answer. Retry only these reports.code(string, required): A stable, machine-readable code for the error, such asapi-key-missing-scopeordata-validation-error. Use it, rather thanmessage, to handle specific errors in your code.message(string, required): A human-readable explanation of what went wrong, to log or show to people. When the request's path parameters, query or body are invalid (data-validation-error), it lists each invalid field by its path, with the problem, such asbody.emails.0: Invalid email address.statusCode(number, required): The HTTP status the same call on this report alone would answer, such as404or403.
- When