Skip to main content
PATCH
Update the authenticated user's profile.

Authorizations

Authorization
string
header
required

Bearer and DPoP tokens are supported depending on the API configuration

Headers

x-correlation-id
string

A client-provided unique identifier for a single operation, used to correlate the request across Auth0 systems. The value is surfaced under references.correlation_id in tenant logs and echoed back on the response's x-correlation-id header. Invalid or oversized values are silently dropped and replaced by a generated UUID v4. Avoid including personally identifiable information (PII).

traceparent
string

A W3C Trace Context header used to correlate the request across distributed traces. When supplied, the inbound trace is continued and a fresh child span is echoed back on the response's traceparent header; the trace ID is also surfaced under references.trace_id in tenant logs. Malformed values are ignored.

Body

application/json
given_name
string
Required string length: 1 - 150
Pattern: \S
family_name
string
Required string length: 1 - 150
Pattern: \S
name
string
Required string length: 1 - 300
Pattern: \S
nickname
string
Required string length: 1 - 300
Pattern: \S
picture
string<uri>
Required string length: 1 - 2048
Pattern: ^https://

Response

Profile updated successfully.

The authenticated user's updated profile attributes, with a per-field access policy indicating read/write eligibility.

given_name
string

Given name/first name/forename of this user.

family_name
string

Family name/last name/surname of this user.

name
string

Name of this user.

nickname
string

Preferred nickname or alias of this user.

picture
string

URL to picture, photo, or avatar of this user.

email
string<email>
read-only

Read-only. To manage email, use /me/v1/identifiers.

phone_number
string
read-only

Read-only. To manage phone number, use /me/v1/identifiers.

username
string
read-only

Read-only. To manage username, use /me/v1/identifiers.

user_metadata
object
read-only

Read-only in this version. user_metadata write support is available in a future release.

created_at
string<date-time>
read-only

Date and time when this user was created.

updated_at
string<date-time>
read-only

Date and time when this user was last updated/modified.

profile_policy
object
read-only

Per-field write-eligibility keyed by RFC 6901 JSON Pointer (e.g. /email).