Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Stream

Patch Stream

Partially update a stream.

patch/api/v1/stream/{stream_id}

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

Request body

descriptionstring

The Stream's description.

uidstring nullable

An optional unique identifier for the stream.

metadataobject

Example request

{
  "uid": "unique-identifier"
}

Response

idstring required

The stream's ID.

uidstring nullable

The stream's UID.

namestring nullable

The stream's name.

createdAtstring date-time required
updatedAtstring date-time required
metadataobject required

Example response

{
  "id": "strm_2yZwUhtgs5Ai8T9yRQJXA",
  "uid": "unique-identifier"
}