Update me view preferences

PUT/workspaces/{organizationId}/me/view-preferences

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

defaultViewIdstring | null

hiddenSurfacesstring[] | null

favoritesobject[] | null

Show properties

Array of object

typestringrequired

Allowed:issuedocument

idstringrequired

titlestringrequired

identifierstring | null

addedAtstringrequired

displayobject | null

Responses

200

View preferences updated

defaultViewIdstring | nullrequired

hiddenSurfacesstring[] | nullrequired

favoritesobject[] | nullrequired

Show properties

Array of object

typestringrequired

Allowed:issuedocument

idstringrequired

titlestringrequired

identifierstring | null

addedAtstringrequired

displayobject | nullrequired

404

Saved view not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X PUT 'https://pile.nyc/workspaces/string/me/view-preferences' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "defaultViewId": "string",
  "hiddenSurfaces": [
    "string"
  ],
  "favorites": [
    {
      "type": "issue",
      "id": "string",
      "title": "string",
      "identifier": "string",
      "addedAt": "string"
    }
  ],
  "display": {
    "property1": {
      "sheetColors": {
        "property1": "string",
        "property2": "string"
      },
      "density": "comfortable",
      "hiddenColumns": [
        "string"
      ]
    },
    "property2": {
      "sheetColors": {
        "property1": "string",
        "property2": "string"
      },
      "density": "comfortable",
      "hiddenColumns": [
        "string"
      ]
    }
  }
}'

const response = await fetch("https://pile.nyc/workspaces/string/me/view-preferences", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"defaultViewId\": \"string\",\n  \"hiddenSurfaces\": [\n    \"string\"\n  ],\n  \"favorites\": [\n    {\n      \"type\": \"issue\",\n      \"id\": \"string\",\n      \"title\": \"string\",\n      \"identifier\": \"string\",\n      \"addedAt\": \"string\"\n    }\n  ],\n  \"display\": {\n    \"property1\": {\n      \"sheetColors\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"density\": \"comfortable\",\n      \"hiddenColumns\": [\n        \"string\"\n      ]\n    },\n    \"property2\": {\n      \"sheetColors\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"density\": \"comfortable\",\n      \"hiddenColumns\": [\n        \"string\"\n      ]\n    }\n  }\n}"
});

import requests

response = requests.put(
    "https://pile.nyc/workspaces/string/me/view-preferences",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"defaultViewId\": \"string\",\n  \"hiddenSurfaces\": [\n    \"string\"\n  ],\n  \"favorites\": [\n    {\n      \"type\": \"issue\",\n      \"id\": \"string\",\n      \"title\": \"string\",\n      \"identifier\": \"string\",\n      \"addedAt\": \"string\"\n    }\n  ],\n  \"display\": {\n    \"property1\": {\n      \"sheetColors\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"density\": \"comfortable\",\n      \"hiddenColumns\": [\n        \"string\"\n      ]\n    },\n    \"property2\": {\n      \"sheetColors\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"density\": \"comfortable\",\n      \"hiddenColumns\": [\n        \"string\"\n      ]\n    }\n  }\n}",
)

Response

{
  "defaultViewId": "string",
  "hiddenSurfaces": [
    "string"
  ],
  "favorites": [
    {
      "type": "issue",
      "id": "string",
      "title": "string",
      "identifier": "string",
      "addedAt": "string"
    }
  ],
  "display": {
    "property1": {
      "sheetColors": {
        "property1": "string",
        "property2": "string"
      },
      "density": "comfortable",
      "hiddenColumns": [
        "string"
      ]
    },
    "property2": {
      "sheetColors": {
        "property1": "string",
        "property2": "string"
      },
      "density": "comfortable",
      "hiddenColumns": [
        "string"
      ]
    }
  }
}