curl --request PUT \
--url "https://au.api.plerion.com/v1/organization/users/7a3f9d8e-1b2c-4d5e-8f90-123456789abc/preferences/home-dashboard?tenantId=65a72929-0e61-4c9c-b7a8-8abe6886fd6c" \
--header "Authorization: Bearer $PLERION_ORGANIZATION_API_KEY" \
--header "Content-Type: application/json" \
--data '{"homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"}'import requests
url = "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard"
payload = { "homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({homeReportId: '3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f'})
};
fetch('https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'homeReportId' => '3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard"
payload := strings.NewReader("{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tenantId": "65a72929-0e61-4c9c-b7a8-8abe6886fd6c",
"homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f",
"updatedAt": "2026-10-05T04:12:00.000Z"
}
}{
"errors": [
{
"code": "ReportNotFound",
"message": "Custom report 3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f was not found in tenant 65a72929-0e61-4c9c-b7a8-8abe6886fd6c"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
]
}{
"errors": [
{
"code": "RoleNotFound",
"message": "role not found"
}
]
}Set a user's home dashboard
Replaces the user’s home dashboard in the tenant. The dashboard must exist in that tenant (GET /v1/tenant/custom-reports on a tenant key lists them), otherwise the answer is 400 ReportNotFound.
Requires an organization API key with read and write access.
curl --request PUT \
--url "https://au.api.plerion.com/v1/organization/users/7a3f9d8e-1b2c-4d5e-8f90-123456789abc/preferences/home-dashboard?tenantId=65a72929-0e61-4c9c-b7a8-8abe6886fd6c" \
--header "Authorization: Bearer $PLERION_ORGANIZATION_API_KEY" \
--header "Content-Type: application/json" \
--data '{"homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"}'import requests
url = "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard"
payload = { "homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({homeReportId: '3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f'})
};
fetch('https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'homeReportId' => '3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard"
payload := strings.NewReader("{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{region}.api.plerion.com/v1/organization/users/{userId}/preferences/home-dashboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"homeReportId\": \"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tenantId": "65a72929-0e61-4c9c-b7a8-8abe6886fd6c",
"homeReportId": "3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f",
"updatedAt": "2026-10-05T04:12:00.000Z"
}
}{
"errors": [
{
"code": "ReportNotFound",
"message": "Custom report 3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f was not found in tenant 65a72929-0e61-4c9c-b7a8-8abe6886fd6c"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
]
}{
"errors": [
{
"code": "RoleNotFound",
"message": "role not found"
}
]
}Authorizations
Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion app.
Path Parameters
The user id.
Query Parameters
The tenant the preference applies in. A PUT checks it belongs to the key's organization and answers 400 TenantNotFound otherwise; a GET or DELETE for a tenant outside the organization finds no row and answers 404 PreferenceNotFound.
Body
A custom dashboard id, from GET /v1/tenant/custom-reports on a tenant key.
"3f1c7d2e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"
Response
The stored preference.
Show child attributes
Show child attributes
Was this page helpful?