Skip to main content
PATCH
/
v1
/
users
/
{id}
Update a User
curl --request PATCH \
  --url https://api.us.lexful.app/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "account_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "organization_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
import requests

url = "https://api.us.lexful.app/v1/users/{id}"

payload = {
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"account_scopes": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"organization_scopes": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: 'jsmith@example.com',
first_name: '<string>',
last_name: '<string>',
account_scopes: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
organization_scopes: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};

fetch('https://api.us.lexful.app/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_URL => "https://api.us.lexful.app/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([
'email' => 'jsmith@example.com',
'first_name' => '<string>',
'last_name' => '<string>',
'account_scopes' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'organization_scopes' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <api-key>"
],
]);

$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.us.lexful.app/v1/users/{id}"

payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"account_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"organization_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<api-key>")
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("https://api.us.lexful.app/v1/users/{id}")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"account_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"organization_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/users/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"account_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"organization_scopes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "account_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "organization_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "first_name": "<string>",
  "last_name": "<string>",
  "external_ids": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

id
string<uuid>
required

User ID

Body

application/json
email
string<email>

User email address

Maximum string length: 255
first_name
string | null

User first name

Required string length: 1 - 100
last_name
string | null

User last name

Required string length: 1 - 100
role
enum<string>

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer,
organization_viewer
account_scopes
(string<uuid> | enum<string>)[]

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

organization_scopes
(string<uuid> | enum<string>)[]

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

Response

Default Response

id
string<uuid>
required

User unique identifier

account_id
string<uuid>
required

Account ID this user belongs to

email
string<email>
required

User email address

role
enum<string>
required

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer,
organization_viewer
account_scopes
(string<uuid> | enum<string>)[]
required

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

organization_scopes
(string<uuid> | enum<string>)[]
required

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

first_name
string | null

User first name

last_name
string | null

User last name

external_ids
object

External system ID mappings

created_at
string<date-time>

User creation timestamp

updated_at
string<date-time>

Last update timestamp

created_by
string

User ID who created this user

updated_by
string

User ID who last updated this user

deleted_at
string<date-time> | null

Deletion timestamp