Skip to main content
PATCH
Update a user

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Path Parameters

user
integer
required

User id.

Body

application/json

Send only the fields you want to change.

name
string
Maximum string length: 255
email
string<email>

Must be unique.

Maximum string length: 255
role
string

Admin role name.

avatar
string | null
Maximum string length: 2048
banner
string | null
Maximum string length: 2048
Maximum string length: 5000
contact_info
object
customer_pin
string | null

Must be unique.

Maximum string length: 255
loyalty_points
integer
Required range: x >= 0
subscribed_to_emails
boolean
email_verified
boolean

true sets email_verified_at to now, false clears it.

phone_verified
boolean
google2fa_enabled
boolean

Only false is useful: it turns two factor authentication off.

discord_id
string | null
Maximum string length: 255
google_id
string | null
Maximum string length: 255
github_id
string | null
Maximum string length: 255
ip
string | null

IPv4 or IPv6 address.

supported_creator_code
string | null
Maximum string length: 255
creator_code_locked
boolean
stripe_id
string | null
Maximum string length: 255
pm_type
string | null
Maximum string length: 255
pm_last_four
string | null
Maximum string length: 4
pm_notes
string | null
Maximum string length: 2000

Response

Success.

data
object
required
meta
object
required
message
string

Human readable confirmation.