Skip to main content
PUT
/
api
/
v2
/
users
Update user
curl --request PUT \
  --url https://api.example.com/api/v2/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "tenantId": "<string>",
  "userId": "<string>",
  "email": "<string>",
  "isOwner": true
}
'
import requests

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

payload = {
"displayName": "<string>",
"tenantId": "<string>",
"userId": "<string>",
"email": "<string>",
"isOwner": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
tenantId: '<string>',
userId: '<string>',
email: '<string>',
isOwner: true
})
};

fetch('https://api.example.com/api/v2/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/api/v2/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => '<string>',
'tenantId' => '<string>',
'userId' => '<string>',
'email' => '<string>',
'isOwner' => 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/api/v2/users"

payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"userId\": \"<string>\",\n \"email\": \"<string>\",\n \"isOwner\": true\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v2/users")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"userId\": \"<string>\",\n \"email\": \"<string>\",\n \"isOwner\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/users")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"userId\": \"<string>\",\n \"email\": \"<string>\",\n \"isOwner\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": true,
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}

Body

application/json
displayName
null | string
tenantId
null | string
userId
null | string
organizationalRole
enum<string>
Available options:
Admin,
UserAdmin,
WorkspaceAdmin,
AgentAdmin,
Member
email
null | string
isOwner
boolean

Response

OK

Standard v2 API response envelope for single-item responses.

data
boolean
meta
object