Skip to main content
POST
/
users
Create User
curl --request POST \
  --url https://api.pagecall.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "external_user_102932",
  "name": "scotty",
  "profile_url": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mp&f=y",
  "default_member_type": "guest"
}
'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
user_id
string
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.

Example:

"external_user_102932"

​
name
string

Name of the user.

Example:

"scotty"

​
profile_url
string

Profile image of the user

Example:

"https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mp&f=y"

​
default_member_type
enum<string>
default:guest

Default type of member when invited to room

Available options:
guest,
host,
monitor
Example:

"guest"

Response

Successful operation

​
user
object