Skip to main content
PATCH
Update a playlist

Authorizations

Authorization
string
header
required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Path Parameters

id
integer
required

The unique identifier of the playlist.

Query Parameters

lang
string

Response locale. ISO code (e.g. fr, de). When omitted, responds in the company's default locale. On reads an unsupported or unknown locale is ignored — the response comes back in the default locale, never a 422. Any translated field with no value in the requested locale falls back to its en value.

Example:

"fr"

Body

application/json

The wrapper key is library (the resource's legacy name), while the URL resource is playlists — this mismatch is intentional, not a typo. The write payload nests under library; with additionalProperties: false a { playlist: ... } body is rejected.

library
object
required

Response

Updated playlist.

Shared success envelope for list / show / create / update responses: the resource payload is returned alongside a top-level integer status and meta. Composed onto each resource response via allOf.

status
integer
required
Example:

200

meta
object
required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.

playlist
object
required

Authenticated (company-surface) Playlist read shape: the public PlaylistBase plus custom_slug and owner, admin metadata never rendered on the public surface.