businessreports/reports/{id}/pin (PUT)
Pin or unpin a report. A pinned report is moved to the top of the list of all reports.
Note that pinning is remembered individually per user.
URL
(PUT) /api/businessreports/reports/{id}/pin?on={on}PARAMETERS
URL parameters are:
id | The unique ID of the report. A default report is prefixed "S" such as in "S500". A custom report is prefixed with "C" such as in "C1002" | string, Mandatory |
| on | true: Pin report false: Unpin report | bool, Mandatory |
RESULTS
The API method returns a boolean with the new "pin" status:
- true: Report is pinned
- false: Report is not pinned