Pin Account Properties

Pinning Account Properties #

This guide explains how to pin account properties in the UI using the API. Pinned properties will be prominently displayed in the account details.

How to Pin Properties #

API Endpoint #

To pin account properties, make a PUT request to the following endpoint:

PUT /api/workspace/defaults/pinned_account_properties

Request Body #

Include a JSON object with an array of property names you want to pin:

{
  "pinned_account_properties": ["property1", "property2", "property3"]
}

JavaScript Example #

Here’s how to pin properties using the Fetch API:

fetch("/api/workspace/defaults/pinned_account_properties", {
  method: "PUT",
  body: JSON.stringify({
    pinned_account_properties: ["name", "domain", "unknown"],
  }),
});

Notes #

  • After updating pinned properties, refresh the page to see the changes
  • The order of properties in the array determines their display order in the UI
  • To unpin all properties, send an empty array: `{“pinned_account_properties”: []}