Accounts
Update account
Updates the authenticated user’s account details.
PATCH
/
account
/
Update account
curl --request PATCH \
--url https://api.example.com/account/ \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>"
}
'import requests
url = "https://api.example.com/account/"
payload = {
"displayName": "<string>",
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
emailAddress: '[email protected]',
password: '<string>',
username: '<string>'
})
};
fetch('https://api.example.com/account/', 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/account/",
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([
'displayName' => '<string>',
'emailAddress' => '[email protected]',
'password' => '<string>',
'username' => '<string>'
]),
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/account/"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/account/")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/account/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"isActivated": true,
"isAdmin": true,
"isSuspended": true,
"updatedAt": "2023-11-07T05:31:56Z",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"Body
application/json
Request payload to update an account.
Request payload to update an account.
New display name (2-32 characters).
Required string length:
2 - 32New email address (must be valid email format).
Required string length:
5 - 254New password (will be hashed before storage).
Required string length:
8 - 128New account handle.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Response
Represents an account.
Represents an account.
Timestamp when the account was created.
Email address associated with the account.
Whether the account email has been verified.
Whether the account has administrator privileges.
Whether the account is currently suspended.
Timestamp when the account was last updated.
Public handle of the account.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Serve path of the account's avatar, when set.
Display name of the account holder, when set.
Update account
curl --request PATCH \
--url https://api.example.com/account/ \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>"
}
'import requests
url = "https://api.example.com/account/"
payload = {
"displayName": "<string>",
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
emailAddress: '[email protected]',
password: '<string>',
username: '<string>'
})
};
fetch('https://api.example.com/account/', 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/account/",
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([
'displayName' => '<string>',
'emailAddress' => '[email protected]',
'password' => '<string>',
'username' => '<string>'
]),
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/account/"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/account/")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/account/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"isActivated": true,
"isAdmin": true,
"isSuspended": true,
"updatedAt": "2023-11-07T05:31:56Z",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"