How to Get Email Settings Details of a Specific Site Using the REST API

This article provides guidance on how to retrieve the email settings details of the specific site if the user has administrative rights for the email settings.

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/settings/email

Bold BI Cloud Server

https://{yourdomain}/bi/api/v6.0/settings/email

Request Type

• GET: This request type is used to get the email settings details of the specific site using REST API.

Steps to Get Email Settings Details of a Specific Site Using the REST API

1. Configure the Endpoint
   In your API client, set the request to GET and use the endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/settings/email

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, it will return the response as follows:

Responses

• 200 - Email settings details have been retrieved successfully.
• 401 - Access denied.
• 405 - Request type was not GET.
• 417 - Failed to retrieve email settings.

Additional References

• REST API - Settings