---
title: "Star or unstar a sequence"
method: PUT
path: "/sequences/{sequence_id}/favorite/"
tags: ["sequences"]
---

# Star or unstar a sequence

`PUT /sequences/{sequence_id}/favorite/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/sequences/{sequence_id}/favorite/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Set whether the CALLING USER has this sequence starred, which is what the Sequences list's Favorites holds. Per person: starring a sequence does not star it for a teammate.

## Path parameters

- `sequence_id` string, uuid, required

## Request body

- SequenceFavoriteUpdateSchema: Request body for starring or unstarring a sequence.
  - `is_favorite` boolean, required: Whether this person wants the sequence starred.

## Response `200`

Successful Response

- SequenceUserPrefsReadSchema: One person's relationship with one sequence. Per PERSON: two people in the same organisation are meant to disagree about what they have starred.
  - `is_favorite` boolean, required: Whether this person starred the sequence.
  - `last_viewed_at` string, date-time, nullable, required: When this person last opened the sequence; null means never.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)
