Skip to main content
POST
Create a new user on your platform with specified details and optional group/course assignments.

Request Headers

string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

Request Body

string
required
Full name of the user
string
required
Email of the user (must be unique across the site)
string
required
User password
string
required
Alias or identifier of role to assign to user
string
User ID (alphanumeric unique identifier). Generated automatically if not provided.
string
Optional bio description for About me section
string
Optional job title
string
Optional location
string
Timezone name in TZ format (e.g. “Europe/London”)
boolean
default:"true"
When true, user data can only be edited via API. Set false to allow web interface editing.
integer[]
List of course IDs to assign to the user
integer
Timestamp for course assignment deadline
integer[]
List of group IDs to add the user to
object
Custom user attributes specific to your site

Response

string
required
User ID
string
required
Full name
string
required
Interface language (de, en, es, fr, pl, pt, ru)
string
Job title
string
Location
string
required
Timezone
string
required
Email address
boolean
required
Ban status
string
required
User role
boolean
required
API management status
object
User avatar
object
Custom attributes

Error Responses

object
Returned when request validation fails