How to Delete a Pinboard Using Bold BI REST API

Users who have created a pinboard can delete that pinboard. This article provides a comprehensive guide on how to delete a pinboard from 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.

CodeAuthorization: bearer <token>

Endpoints

Self-Hosted Server
https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/pinboard/{name}

Bold BI Cloud Server
```
https://{yourdomain}/bi/api/v6.0/pinboard/{name}
```
Make sure that {Name} is replaced with the correct name of the pinboard intended for deletion. Find the list of Pinboard names and details in this knowledge base article.

Request Type

DELETE: This request type is used to delete the pinboard.

Steps to Delete a Pinboard Using the REST API

To delete a pinboard, follow the steps outlined below:

Configure the Endpoint

In your API client, set the request to DELETE and use the endpoint:
```
https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/pinboard/{name}
```
2. Add the Authorization Header
Include the access token in the request headers:
```
Authorization: bearer <token>
```

3. Send the Request

Execute the request by pressing Send icon. If the request is successful, the pinboard will be deleted and will no longer appear in the pinboard Page in the Bold BI UI.

deletepinboard

Responses

204 - No content.
400 - Item name is empty.
401 - Access denied.
405 - Request type was not DELETE.
417 - Failed to delete the pinboard details.

Additional References

Was this article useful?

Dislike

Written by Sammanasu Mary Jesuraj

Updated:

Comments (0)