PPpplink
user

Create User

Changed on

Create user within workspace

post/users

Request

  • Base URL
    https://api.pagecall.com/v1
  • Auth
    HTTP bearer

Request body

user_idstring required

ID of the user. Will override exisiting user if the specified ID already being used. Please note that id field is only used internally.

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

{
  "user_id": "external_user_102932",
  "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"
  }
}

Changes

  • c53ef2fe7238Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

  • 5c2950789c4cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status