---
title: "Update a playlist"
method: PUT
path: "/v1/playlists/{playlist_id}/"
---

# Update a playlist

`PUT /v1/playlists/{playlist_id}/`

## Request

- Base URL: `https://app.iconik.io/API/assets`
- URL: `https://app.iconik.io/API/assets/v1/playlists/{playlist_id}/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/playlists/:playlist_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Required roles:
 - can_write_playlists

## Path parameters

- `playlist_id` string, required

## Query parameters

- `index_immediately` boolean
- `low_priority_indexing` boolean

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Request body

- PlaylistSchema
  - `created_by_user` string, uuid
  - `custom_keyframe` string, uuid, nullable
  - `custom_poster` string, uuid, nullable
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `id` string, uuid
  - `item_count` integer
  - `keyframe_asset_ids` string[]
  - `keyframes` object[]
  - `name` string, required
  - `playlist_items` PlaylistItemSchema[]
    - `id` string, uuid
    - `object_id` string, uuid, required
    - `object_type` 'assets' | 'sequences', required
    - `time_end_milliseconds` integer, nullable
    - `time_start_milliseconds` integer, nullable
    - `version_id` string, nullable: Version selector for this playlist item. Accepts: omitted/null/empty (all versions); "latest" (latest version only); a single UUID1; or a comma-separated list of UUID1s (e.g. "uuid1,uuid2,uuid3") with no whitespace and no duplicates.
  - `project_id` string, uuid
  - `status` 'HIDDEN'
  - `system_domain_id` string, uuid

## Response `200`

Returns an updated playlist

- PlaylistSchema
  - `created_by_user` string, uuid
  - `custom_keyframe` string, uuid, nullable
  - `custom_poster` string, uuid, nullable
  - `date_created` string, date-time
  - `date_modified` string, date-time
  - `id` string, uuid
  - `item_count` integer
  - `keyframe_asset_ids` string[]
  - `keyframes` object[]
  - `name` string, required
  - `playlist_items` PlaylistItemSchema[]
    - `id` string, uuid
    - `object_id` string, uuid, required
    - `object_type` 'assets' | 'sequences', required
    - `time_end_milliseconds` integer, nullable
    - `time_start_milliseconds` integer, nullable
    - `version_id` string, nullable: Version selector for this playlist item. Accepts: omitted/null/empty (all versions); "latest" (latest version only); a single UUID1; or a comma-separated list of UUID1s (e.g. "uuid1,uuid2,uuid3") with no whitespace and no duplicates.
  - `project_id` string, uuid
  - `status` 'HIDDEN'
  - `system_domain_id` string, uuid

## Other responses

- `400`: Bad request
- `401`: Token is invalid
- `404`: Playlist does not exist
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)