Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Video API, gRPC: PlaylistService.Update

Written by
Updated at August 8, 2025

Updates an existing playlist's metadata and items.
Only fields specified in the field_mask will be updated.

gRPC request

rpc Update (UpdatePlaylistRequest) returns (operation.Operation)

UpdatePlaylistRequest

{
  "playlist_id": "string",
  "field_mask": "google.protobuf.FieldMask",
  "title": "string",
  "description": "string",
  "items": [
    {
      // Includes only one of the fields `video_id`, `episode_id`
      "video_id": "string",
      "episode_id": "string",
      // end of the list of possible fields
      "position": "int64"
    }
  ],
  "style_preset_id": "string"
}

Field

Description

playlist_id

string

Required field. ID of the playlist to update.

field_mask

google.protobuf.FieldMask

Required field. Field mask specifying which fields of the playlist should be updated.
Only fields specified in this mask will be modified;
all other fields will retain their current values.
This allows for partial updates.

title

string

New title for the playlist.

description

string

New description for the playlist.
Optional field that can provide additional information about the playlist.

items[]

PlaylistItem

New list of items to include in the playlist.
This completely replaces the existing items if specified in the field mask.
The order of items in this list determines the playback order.

style_preset_id

string

New ID of the style preset to be applied to the playlist player.

PlaylistItem

Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.

Field

Description

video_id

string

Identifier of a video included in the playlist.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

episode_id

string

Identifier of an episode included in the playlist.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

position

int64

Position of this item in the playlist sequence (zero-indexed).
Determines the playback order of content in the playlist.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "playlist_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "channel_id": "string",
    "title": "string",
    "description": "string",
    "items": [
      {
        // Includes only one of the fields `video_id`, `episode_id`
        "video_id": "string",
        "episode_id": "string",
        // end of the list of possible fields
        "position": "int64"
      }
    ],
    "style_preset_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdatePlaylistMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Playlist

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdatePlaylistMetadata

Field

Description

playlist_id

string

ID of the playlist being updated.

Playlist

Entity representing an ordered collection of videos or episodes.
Playlists allow organizing content into sequences for improved user experience.

Field

Description

id

string

Unique identifier of the playlist.

channel_id

string

Identifier of the channel where this playlist is created and managed.

title

string

Title of the playlist displayed in interfaces and players.

description

string

Detailed description of the playlist's content and purpose.

items[]

PlaylistItem

Ordered list of content items included in this playlist.

style_preset_id

string

Identifier of the style preset used in the player during playlist playback.

created_at

google.protobuf.Timestamp

Timestamp when the playlist was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the playlist or its metadata.

PlaylistItem

Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.

Field

Description

video_id

string

Identifier of a video included in the playlist.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

episode_id

string

Identifier of an episode included in the playlist.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

position

int64

Position of this item in the playlist sequence (zero-indexed).
Determines the playback order of content in the playlist.
Previous
Create
Next
Delete