Users
Update
Update a user
PATCH
/
users
/
{id}
Update
curl --request PATCH \
--url http://localhost:44442/api/v1/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"alias": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"role": "<string>",
"email": "<string>",
"avatar": "<string>",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"signin_required": true
}
'import requests
url = "http://localhost:44442/api/v1/users/{id}"
payload = {
"name": "<string>",
"alias": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"role": "<string>",
"email": "<string>",
"avatar": "<string>",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"signin_required": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
alias: '<string>',
first_name: '<string>',
last_name: '<string>',
role: '<string>',
email: '<string>',
avatar: '<string>',
group_id: '68b1f0c2a4d3e5f6a7b8c9d0',
signin_required: true
})
};
fetch('http://localhost:44442/api/v1/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'alias' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'role' => '<string>',
'email' => '<string>',
'avatar' => '<string>',
'group_id' => '68b1f0c2a4d3e5f6a7b8c9d0',
'signin_required' => true
]),
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 := "http://localhost:44442/api/v1/users/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:44442/api/v1/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"principal": "<string>",
"name": "<string>",
"alias": null,
"first_name": null,
"last_name": null,
"role": null,
"email": null,
"avatar": null,
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"created_at": 1785846207000,
"updated_at": 1785846207000,
"signin_required": true,
"signed_in_from": [
"<string>"
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}Authorizations
An API key from Settings, API Keys. A caller on this machine needs none.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Body
application/json
Required string length:
1 - 200Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
64Maximum string length:
320Maximum string length:
2000Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Needs an email to sign in as
Response
The updated user
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
OS account the user is identified by
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Example:
1785846207000
Example:
1785846207000
They sign in with pulze.io, as the account with their email, before RenderFlow lets them in
The OS accounts they are signed in at now, as each login's principal. Listed by GET /users only
Was this page helpful?
⌘I
Update
curl --request PATCH \
--url http://localhost:44442/api/v1/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"alias": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"role": "<string>",
"email": "<string>",
"avatar": "<string>",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"signin_required": true
}
'import requests
url = "http://localhost:44442/api/v1/users/{id}"
payload = {
"name": "<string>",
"alias": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"role": "<string>",
"email": "<string>",
"avatar": "<string>",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"signin_required": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
alias: '<string>',
first_name: '<string>',
last_name: '<string>',
role: '<string>',
email: '<string>',
avatar: '<string>',
group_id: '68b1f0c2a4d3e5f6a7b8c9d0',
signin_required: true
})
};
fetch('http://localhost:44442/api/v1/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'alias' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'role' => '<string>',
'email' => '<string>',
'avatar' => '<string>',
'group_id' => '68b1f0c2a4d3e5f6a7b8c9d0',
'signin_required' => true
]),
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 := "http://localhost:44442/api/v1/users/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:44442/api/v1/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"alias\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"<string>\",\n \"email\": \"<string>\",\n \"avatar\": \"<string>\",\n \"group_id\": \"68b1f0c2a4d3e5f6a7b8c9d0\",\n \"signin_required\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"principal": "<string>",
"name": "<string>",
"alias": null,
"first_name": null,
"last_name": null,
"role": null,
"email": null,
"avatar": null,
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"created_at": 1785846207000,
"updated_at": 1785846207000,
"signin_required": true,
"signed_in_from": [
"<string>"
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}