How to Update a Pinboard Using Bold BI REST API

Published:

This article provides a comprehensive guide on how to update an existing pinboard on a specific site using the REST API.

Authorization

To perform this action, an access token must be included in the request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Endpoints

Self-Hosted Server:

https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/pinboard/<pinboard_name>

Bold BI Cloud Server:

https://{yourdomain}/bi/api/v5.0/pinboard/<pinboard_name>

Request Type

PUT: This request type is used to update the pinboard details.

Update Pinboard Using the REST API

To update a pinboard, follow the steps outlined below:

Configure the Endpoint
- In your API client (e.g., Postman), set the request to PUT and use the endpoint:
```
https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/pinboard/<pinboard_name>
```
Add the Authorization Header
- Include the access token in the request headers:
```
Authorization: bearer <Your_token>
```
Set Up the Request Body
- In the Body tab, select raw and set the format to JSON. Provide the details in the following structure:
```
{
  "SetDefault": true,
  "Pininfo": [
    {
      "WidgetId": "widget_id",
      "WidgetName": "widget_name",
      "DashboardId": "dashboard_id"
    }
  ]
}
```
- Adjust SetDefault to true andfalse according to whether you want the pinboard to be set as default.
- Replace widget_id, widget_name, and dashboard_id with your actual values.
- You can retrieve these details using the following KB articles:
  - How to retrieve widget information from a dashboard.
  - How to get dashboard details.
Send the Request
- Execute the request by pressing Send. If successful, the response will indicate that the pinboard has been updated with a status code of 200.