Update Room User

Livepeer Studio API endpoint

PUT /room/{id}/user/{userId}

Go

Go

package main

import(
	livepeergo "github.com/livepeer/livepeer-go"
	"context"
	"github.com/livepeer/livepeer-go/models/components"
	"log"
)

func main() {
    s := livepeergo.New(
        livepeergo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Room.UpdateUser(ctx, "<id>", "<value>", components.RoomUserUpdatePayload{
        CanPublish: livepeergo.Bool(true),
        CanPublishData: livepeergo.Bool(true),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

default

{
  "errors": [
    [
      "id not provided",
      "Account not found"
    ]
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

userId · string · required

Body

application/json

canPublish · boolean · default: true · required

Whether a user is allowed to publish audio/video tracks (i.e. their microphone and webcam)

Example:

true

canPublishData · boolean · default: true

Whether a user is allowed to publish data messages to the room

Example:

true

metadata · string

User defined payload to store for the participant

Response

204

Success