Skip to main content
POST
/
admin
/
users
Invite an accountant user
curl --request POST \
  --url https://api.steuerboard.com/v1/admin/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "frida@example.com",
  "role": "admin"
}
'
import requests

url = "https://api.steuerboard.com/v1/admin/users"

payload = {
"email": "frida@example.com",
"role": "admin"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'frida@example.com', role: 'admin'})
};

fetch('https://api.steuerboard.com/v1/admin/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.steuerboard.com/v1/admin/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' => 'frida@example.com',
'role' => 'admin'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.steuerboard.com/v1/admin/users"

payload := strings.NewReader("{\n \"email\": \"frida@example.com\",\n \"role\": \"admin\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.steuerboard.com/v1/admin/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"frida@example.com\",\n \"role\": \"admin\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"frida@example.com\",\n \"role\": \"admin\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "cmf41ajzv003706un4i99q1b1",
  "createdAt": "2024-08-20T12:34:56Z",
  "email": "alex@example.com",
  "firstName": "Alex",
  "lastName": "Müller",
  "roles": [
    {
      "id": "cmf41ajzv003706un4i99q1a0",
      "name": "accountant_admin",
      "customName": "Head of Accounting"
    }
  ]
}
{
"status_code": 401,
"type": "auth_error",
"code": "unauthorized",
"message": "<string>"
}
{
"type": "auth_error",
"message": "<string>"
}
{
"status_code": 404,
"type": "not_found",
"code": "not_found",
"message": "<string>"
}
{
"status_code": 409,
"type": "conflict",
"code": "conflict",
"message": "<string>"
}
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "invalid_type",
"path": [
"email"
],
"message": "Required"
},
{
"code": "invalid_union",
"path": [
"role"
],
"message": "Invalid input"
}
]
}
}
{
"status_code": 429,
"type": "rate_limit",
"code": "too_many_requests",
"message": "<string>"
}
This response has no body data.
This endpoint only works with the Accountant API key. More information here

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

Invite accountant user

email
string<email>
required

Email address that should receive the invitation.

Example:

"frida@example.com"

role
required

Role to assign to the invited user. Can be 'admin', 'user', or a custom role ID.

Available options:
admin,
user
Example:

"admin"

Response

Accountant user invited

id
string<cuid>
required

Identifier of the accountant user.

Example:

"cmf41ajzv003706un4i99q1b1"

createdAt
string<date-time>
required

ISO 8601 timestamp when the accountant user record was created.

Example:

"2024-08-20T12:34:56Z"

email
string<email>
required

Email address of the accountant user.

Example:

"alex@example.com"

firstName
string | null
required

First name of the accountant user, if provided.

Example:

"Alex"

lastName
string | null
required

Last name of the accountant user, if provided.

Example:

"Müller"

roles
object[]
required

Roles assigned to the accountant user.