LIlivepeer
room

Update a room user

Changed on

Update properties for a user.

put/room/{id}/user/{userId}

Request

  • Base URL
    https://livepeer.studio/api
  • URL
    https://livepeer.studio/api/room/{id}/user/{userId}
  • Auth
    HTTP bearer

Path parameters

idstring required
userIdstring required

Request body

canPublishboolean required

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

canPublishDataboolean

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

metadatastring

User defined payload to store for the participant

Example request

{
  "canPublish": true,
  "canPublishData": true
}

Response

Success

Changes