Skip to content
Getting StartedReference

api_users_update

PUT
/api/users/{username}/
curl --request PUT \
--url https://example.com/api/users/example/ \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "username": "example", "email": "hello@example.com", "name": "example" }'
username
required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

string
object
username
required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

string
>= 1 characters <= 150 characters /^[\w.@+-]+$/
email
Email address
One of:
string format: email
<= 254 characters
name
Name of User
string
<= 255 characters

Example generated

{
"username": "example",
"email": "hello@example.com",
"name": "example"
}
Media typeapplication/json
object
username
required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

string
<= 150 characters /^[\w.@+-]+$/
email
Email address
One of:
string format: email
<= 254 characters
name
Name of User
string
<= 255 characters
url
required
string format: uri

Example generated

{
"username": "example",
"email": "hello@example.com",
"name": "example"
}