Change the status of a user
curl --request PATCH \
--url http://localhost:{port}/users/{id-or-identifier} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "inactive",
"review_comment": "User is suspended due to abuse of the system."
}
'import requests
url = "http://localhost:{port}/users/{id-or-identifier}"
payload = {
"status": "inactive",
"review_comment": "User is suspended due to abuse of the system."
}
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({
status: 'inactive',
review_comment: 'User is suspended due to abuse of the system.'
})
};
fetch('http://localhost:{port}/users/{id-or-identifier}', 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 => "62437",
CURLOPT_URL => "http://localhost:{port}/users/{id-or-identifier}",
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([
'status' => 'inactive',
'review_comment' => 'User is suspended due to abuse of the system.'
]),
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:{port}/users/{id-or-identifier}"
payload := strings.NewReader("{\n \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\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:{port}/users/{id-or-identifier}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:{port}/users/{id-or-identifier}")
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 \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\n}"
response = http.request(request)
puts response.read_body{
"id": "d4add56e-c345-4ac9-b392-7a890a60559a",
"identifier": "ben",
"name": "Benjamin Zhang",
"email": "z@benwk.com",
"user_type": "saas_admin",
"status": "active",
"created_at": "2023-05-06T00:00:00Z",
"updated_at": "2023-05-06T00:00:00Z",
"created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
"updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
}User
Change the status of a user
PATCH
/
users
/
{id-or-identifier}
Change the status of a user
curl --request PATCH \
--url http://localhost:{port}/users/{id-or-identifier} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "inactive",
"review_comment": "User is suspended due to abuse of the system."
}
'import requests
url = "http://localhost:{port}/users/{id-or-identifier}"
payload = {
"status": "inactive",
"review_comment": "User is suspended due to abuse of the system."
}
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({
status: 'inactive',
review_comment: 'User is suspended due to abuse of the system.'
})
};
fetch('http://localhost:{port}/users/{id-or-identifier}', 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 => "62437",
CURLOPT_URL => "http://localhost:{port}/users/{id-or-identifier}",
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([
'status' => 'inactive',
'review_comment' => 'User is suspended due to abuse of the system.'
]),
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:{port}/users/{id-or-identifier}"
payload := strings.NewReader("{\n \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\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:{port}/users/{id-or-identifier}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:{port}/users/{id-or-identifier}")
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 \"status\": \"inactive\",\n \"review_comment\": \"User is suspended due to abuse of the system.\"\n}"
response = http.request(request)
puts response.read_body{
"id": "d4add56e-c345-4ac9-b392-7a890a60559a",
"identifier": "ben",
"name": "Benjamin Zhang",
"email": "z@benwk.com",
"user_type": "saas_admin",
"status": "active",
"created_at": "2023-05-06T00:00:00Z",
"updated_at": "2023-05-06T00:00:00Z",
"created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
"updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Your API version
Available options:
v1 Available options:
application/json, application/xml, application/x-www-form-urlencoded, application/octet-stream, application/pdf, text/plain, text/html, multipart/form-data Path Parameters
Body
application/json
Response
Success
Example:
"98d91cd7-860d-4869-937a-5af32eff2f4a"
Example:
"delay"
Example:
"Delay Technologies"
Available options:
single_user, multi_user Example:
"multi_user"
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
REQUIRE metadata permissions
Example:
"98d91cd7-860d-4869-937a-5af32eff2f4a"
REQUIRE metadata permissions
Example:
"98d91cd7-860d-4869-937a-5af32eff2f4a"
Was this page helpful?