Skip to main content
POST
/
v1
/
users
Create a user
curl --request POST \
  --url https://api.example.com/v1/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "name": "<string>",
  "role": {},
  "external_id": "<string>",
  "metadata": {}
}
'
import requests

url = "https://api.example.com/v1/users"

payload = {
"email": "<string>",
"name": "<string>",
"role": {},
"external_id": "<string>",
"metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
name: '<string>',
role: {},
external_id: '<string>',
metadata: {}
})
};

fetch('https://api.example.com/v1/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'name' => '<string>',
'role' => [

],
'external_id' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/users"

payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": {},\n \"external_id\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/users")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": {},\n \"external_id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": {},\n \"external_id\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

Body

email
string
required
name
string
required
role
enum
required
student | teacher | manager | admin.
external_id
string
Your LMS’ user ID. Highly recommended.
metadata
object

Examples

const ada = await hk.users.create({
  email: "ada@example.edu",
  name: "Ada Lovelace",
  role: "student",
  external_id: "canvas_user_42",
});
$ada = $hk->users->create([
    'email' => 'ada@example.edu',
    'name' => 'Ada Lovelace',
    'role' => 'student',
    'external_id' => 'canvas_user_42',
]);

Returns

A User.
Creating a user does not enroll them in a cohort. Use cohorts.bulk() or the cohort enrollment endpoint to do that.