Skip to main content
PATCH
/
api
/
v1
/
projects
/
{projectUuid}
/
pinned-lists
/
{pinnedListUuid}
/
items
/
order
cURL
curl --request PATCH \
  --url http://api/v1/projects/{projectUuid}/pinned-lists/{pinnedListUuid}/items/order \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "data": {
      "uuid": "<string>",
      "pinnedListOrder": 123
    },
    "type": "chart"
  }
]
'
{
  "results": [
    {
      "category": "mostPopular",
      "data": {
        "description": "<string>",
        "name": "<string>",
        "uuid": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "spaceUuid": "<string>",
        "pinnedListUuid": "<string>",
        "pinnedListOrder": 123,
        "updatedByUser": {
          "userUuid": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "views": 123,
        "firstViewedAt": "<string>",
        "validationErrors": [
          {
            "createdAt": "2023-11-07T05:31:56Z",
            "error": "<string>",
            "validationId": 123
          }
        ]
      },
      "type": "dashboard"
    }
  ],
  "status": "ok"
}

Path Parameters

​
projectUuid
string
required

project uuid

​
pinnedListUuid
string
required

the list uuid for the pinned items

Body

application/json · object[]

the new order of the pinned items

the new order of the pinned items

​
data
object
required

From T, pick a set of properties whose keys are in the union K

​
type
enum<string>
required
Available options:
chart,
dashboard,
space

Response

Success

​
results
object[]
required
  • Option 1
  • Option 2
  • Option 3
​
status
enum<string>
required
Available options:
ok