How to Delete a Specific User Attribute at the Site Level Using the Bold BI REST API

This article provides guidance on how to delete a specific attribute of a user through an API request.

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>/v6.0/attribute/user/{id}

Bold BI Cloud Server

https://{yourdomain}/bi/api/v6.0/attribute/user/{id}

Request Type

• DELETE: This request type is used to delete a user attribute for the current user through an API request.

Steps to DELETE a Specific Attribute of a User Using the Bold BI REST API

1. Configure the Endpoint
   In your API client, set the request to DELETE and use the endpoint. Ensure to provide the respective Attribute ID in the id parameter of the request URL.

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/attribute/user/{id}

2. Add the Authorization Header
   Include the access token in the request headers:

Authorization: bearer <token> 

Responses

• 204 - No content.
• 400 - Attribute ID invalid.
• 405 - Request type was not DELETE.
• 417 - Failed to delete attribute details.

Additional References

• REST API - Attributes