SVsvix
Stream

Patch Stream

Changed on

Partially update a stream.

patch/api/v1/stream/{stream_id}

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/stream/{stream_id}
  • Auth
    HTTP bearer

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

Request body

descriptionstring

The Stream's description.

metadataobject
uidstring nullable

An optional unique identifier for the stream.

Example request

{
  "uid": "unique-identifier"
}

Response

createdAtstring date-time required
idstring required

The stream's ID.

metadataobject required
namestring nullable

The stream's name.

uidstring nullable

The stream's UID.

updatedAtstring date-time required

Example response

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

Changes

  • 36b59828b304Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 512

  • cca56e67e5a4Revision changes
    • info

      added the required property to the response with the status