---
title: "Update a stars order in the sidebar"
method: POST
path: "/stars.update"
tags: ["Stars"]
---

# Update a stars order in the sidebar

`POST /stars.update`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/stars.update`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

Update the position of a starred document in the sidebar. The index parameter determines the display order relative to other starred documents.

## Request body

- object
  - `id` string, uuid, required
  - `index` string, required

## Response `200`

OK

- object
  - `data` Star
    - `id` string, uuid: Unique identifier for the object.
    - `index` string: Index of the star in the list of stars.
    - `documentId` string, uuid, nullable: Unique identifier for the starred document.
    - `collectionId` string, uuid, nullable: Unique identifier for the starred collection.
    - `createdAt` string, date-time: Date and time when this star was created
    - `updatedAt` string, date-time: Date and time when this star was last changed
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## Other responses

- `400`: The request failed one or more validations.
- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `404`: The specified resource was not found.
- `429`: The request was rate limited.

## Changes

- **2026-05-30** `304cd065561b`: 2 breaking, 1 warning, 1 info
  - the response property `data/collectionId` became nullable for the status `200`
  - the response property `data/documentId` became nullable for the status `200`
  - removed the optional property `data/documentUrl` from the response with the `200` status
  - added the optional property `data/updatedAt` to the response with the `200` status
- **2026-02-01** `2b998aa571f9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/stars.update/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)