Sign in
user

Create User

Create user within workspace

post/users

Request body

user_idstring required

ID of the user. Will override exisiting user if the specified ID already being used.

namestring

Name of the user.

nicknamestring

Default display name of the user in the room

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

{
  "user_id": "external_user_102932",
  "name": "scotty",
  "nickname": "scotty_the_guest",
  "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",
    "nickname": "scotty_the_guest",
    "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"
  }
}

Changes