Skip to main content
POST
/
v1
/
users
Create a new user
curl --request POST \
  --url https://api.example.com/v1/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "email": "<string>",
    "username": "<string>",
    "auth_method": "<string>",
    "password": "<string>"
  },
  "send_welcome_email": true
}
'
import requests

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

payload = {
"user": {
"email": "<string>",
"username": "<string>",
"auth_method": "<string>",
"password": "<string>"
},
"send_welcome_email": True
}
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({
user: {
email: '<string>',
username: '<string>',
auth_method: '<string>',
password: '<string>'
},
send_welcome_email: true
})
};

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([
'user' => [
'email' => '<string>',
'username' => '<string>',
'auth_method' => '<string>',
'password' => '<string>'
],
'send_welcome_email' => true
]),
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 \"user\": {\n \"email\": \"<string>\",\n \"username\": \"<string>\",\n \"auth_method\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"send_welcome_email\": true\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 \"user\": {\n \"email\": \"<string>\",\n \"username\": \"<string>\",\n \"auth_method\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"send_welcome_email\": true\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 \"user\": {\n \"email\": \"<string>\",\n \"username\": \"<string>\",\n \"auth_method\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"send_welcome_email\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "username": "<string>",
    "auth_method": "<string>",
    "password_needs_reset": true,
    "password": "<string>"
  }
}
"<string>"
"<string>"
"<string>"
"<string>"

Body

application/json
user
LocalUserData · object
required
send_welcome_email
boolean
default:true

Response

The newly created user.

data
LocalUser · object
required