Sign in

v1

latestOpenAPI 3.0.02026-07-13171730.7 KB
user

Update User

Update user with user id

put/users/{user_id}

Request body

namestring

Name of the user.

profile_urlstring

Profile image of the user

default_member_type'guest' | 'host' | 'monitor'

Type of user in this room

  • guest: The user is guest.
  • host: The user is host. This user has administrator privileges.
  • monitor: The user is observer. Can watch the meeting, but can not join.

Example request

{
  "name": "scotty",
  "profile_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mp&f=y",
  "default_member_type": "guest"
}

Response

Successful operation

Example response

{
  "user": {
    "user_id": "external_user_102932",
    "name": "scotty",
    "profile_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mp&f=y",
    "default_member_type": "guest",
    "access_token": "TfowtRYBs0E_trzoTaCmAXKzB1JxDDhi",
    "created_at": "2023-01-01T01:00:00.000Z",
    "updated_at": "2023-01-01T01:00:00.000Z"
  }
}