Skip to main content
POST
/
users
cURL
curl --request POST \
  --url https://api.example.com/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "unit": 123,
  "reference": "<string>",
  "userTypes": [
    123
  ],
  "welcome": true
}
'
import requests

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

payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"unit": 123,
"reference": "<string>",
"userTypes": [123],
"welcome": 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({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
unit: 123,
reference: '<string>',
userTypes: [123],
welcome: true
})
};

fetch('https://api.example.com/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/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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'unit' => 123,
'reference' => '<string>',
'userTypes' => [
123
],
'welcome' => 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/users"

payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"unit\": 123,\n \"reference\": \"<string>\",\n \"userTypes\": [\n 123\n ],\n \"welcome\": 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/users")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"unit\": 123,\n \"reference\": \"<string>\",\n \"userTypes\": [\n 123\n ],\n \"welcome\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"unit\": 123,\n \"reference\": \"<string>\",\n \"userTypes\": [\n 123\n ],\n \"welcome\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "content_type": "user",
    "id": 1,
    "reference": "USR-123",
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "title": "Manager",
    "active": true,
    "meta_field_0": "<string>",
    "meta_field_1": "<string>",
    "meta_field_2": "<string>",
    "meta_field_3": "<string>",
    "meta_field_4": "<string>",
    "permissions": {},
    "avatar": {},
    "unit": {},
    "physicalUnit": {},
    "department": {},
    "userTypes": [
      {}
    ],
    "memberGroups": [
      {}
    ],
    "memberUnits": [
      {}
    ],
    "specialties": [
      {}
    ],
    "twoFactor": {},
    "provider": [
      "<string>"
    ],
    "all_integrations": [
      {}
    ],
    "devices": [
      {}
    ],
    "participant_type": "<string>",
    "url": "api/users/1"
  }
}

Body

application/json
first_name
string
required
last_name
string
required
email
string<email>
required
unit
integer
required
reference
string | null
userTypes
integer[]
welcome
boolean
default:true

Send welcome email

Response

User created

data
object