Skip to main content
POST
/
users
/
batch
Create a new batch of users
curl --request POST \
  --url https://production.runalloy.com/users/batch \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "users": [
    {
      "username": "demo@runalloy.com",
      "fullName": "Gregg Mojica"
    }
  ]
}
'
import requests

url = "https://production.runalloy.com/users/batch"

payload = { "users": [
        {
            "username": "demo@runalloy.com",
            "fullName": "Gregg Mojica"
        }
    ] }
headers = {
    "Authorization": "<authorization>",
    "x-api-version": "<x-api-version>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    Authorization: '<authorization>',
    'x-api-version': '<x-api-version>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({users: [{username: 'demo@runalloy.com', fullName: 'Gregg Mojica'}]})
};

fetch('https://production.runalloy.com/users/batch', 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://production.runalloy.com/users/batch",
  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([
    'users' => [
        [
                'username' => 'demo@runalloy.com',
                'fullName' => 'Gregg Mojica'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json",
    "x-api-version: <x-api-version>"
  ],
]);

$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://production.runalloy.com/users/batch"

	payload := strings.NewReader("{\n  \"users\": [\n    {\n      \"username\": \"demo@runalloy.com\",\n      \"fullName\": \"Gregg Mojica\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("x-api-version", "<x-api-version>")
	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://production.runalloy.com/users/batch")
  .header("Authorization", "<authorization>")
  .header("x-api-version", "<x-api-version>")
  .header("Content-Type", "application/json")
  .body("{\n  \"users\": [\n    {\n      \"username\": \"demo@runalloy.com\",\n      \"fullName\": \"Gregg Mojica\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://production.runalloy.com/users/batch")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["x-api-version"] = '<x-api-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"users\": [\n    {\n      \"username\": \"demo@runalloy.com\",\n      \"fullName\": \"Gregg Mojica\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "message": "success",
  "invalidUsers": [
    {
      "fullName": "Missing Username"
    },
    {
      "username": "alreadyexists123"
    }
  ]
}
{
  "message": "No valid users provided"
}
"{}"

Headers

Authorization
string
default:bearer YOUR_API_KEY
required

Your Embedded API key for authorization

x-api-version
string
default:2025-09
required

The version of the API to use. The current API version is 2025-09.

Body

application/json
users
object[]
required

An array of user objects to be created. Each object must contain a username (mandatory) and an optional fullName. Limited to 1000 users at a time.

Response

200

message
string
Example:

"success"

invalidUsers
object[]