users
users

Update one or more of the authenticated user's profile fields or settings.

patch/api/users/{uuid}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/users/{uuid}/
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

Request body

date_joinedstring date-time
uuidstring uuid
distinct_idstring nullable
first_namestring
last_namestring
emailstring email
pending_emailstring email nullable
is_email_verifiedboolean nullable
notification_settingsobject

Map of notification preferences. Keys include plugin_disabled, all_weekly_report_disabled, project_weekly_digest_disabled, error_tracking_weekly_digest_project_enabled, web_analytics_weekly_digest_project_enabled, organization_member_join_email_disabled, data_pipeline_error_threshold (number between 0.0 and 1.0), and other per-topic switches. Values are either booleans, or (for per-project/per-resource keys) a map of IDs to booleans. Only the keys you send are updated — other preferences stay as-is.

anonymize_databoolean nullable

Whether PostHog should anonymize events captured for this user when identified.

allow_impersonationboolean nullable
has_passwordboolean
idinteger
is_staffboolean

Designates whether the user can log into this admin site.

is_impersonatedboolean nullable
is_impersonated_untilstring nullable
is_impersonated_read_onlyboolean nullable
is_impersonated_reasonstring nullable

The reason the operator gave when the current impersonation session started (or was last up/downgraded). Null when not impersonating.

sensitive_session_expires_atstring nullable
fresh_reauth_expires_atstring nullable

When the last re-authentication stops counting as fresh. Changing email after this needs a new re-authentication. Null when the session has none on record.

set_current_organizationstring
set_current_teamstring
passwordstring
current_passwordstring

The user's current password. Required when changing password if the user already has a usable password set.

events_column_configunknown
is_2fa_enabledboolean
has_social_authboolean
has_sso_enforcementboolean
has_seen_product_intro_forunknown
hedgehog_configunknown
allow_sidebar_suggestionsboolean nullable
role_at_organization'engineering' | 'data' | 'product' | 'founder' | 'leadership' | 'marketing' | 'sales' | 'student' | 'other'
  • engineering - Engineering
  • data - Data
  • product - Product Management
  • founder - Founder
  • leadership - Leadership
  • marketing - Marketing
  • sales - Sales / Success
  • student - Student
  • other - Other
passkeys_enabled_for_2faboolean nullable

Whether passkeys are enabled for 2FA authentication. Users can disable this to use only TOTP for 2FA while keeping passkeys for login.

hide_mcp_hintsboolean

When true, the user has opted out of in-app hints promoting the PostHog MCP integration after taking actions.

ui_configurationunknown
onboarding_skipped_atstring date-time nullable
onboarding_skipped_organization_idstring uuid nullable
onboarding_delegated_to_invitestring uuid nullable
onboarding_delegated_to_organization_idstring uuid nullable

Organization ID of the pending delegation invite, if any. Used by the frontend to scope the 'waiting for teammate' UI to the org where delegation was initiated.

onboarding_delegation_accepted_atstring date-time nullable
is_organization_first_userboolean nullable
active_realtime_notification_typesstring[]

Real-time notification types that currently have a live dispatch site. Drives the in-app notifications settings UI. Read-only.

requires_credential_reviewboolean

True if the user has at least one Personal API Key or passkey, or a third-party OAuth application that can currently act as them, and has not yet acknowledged that access. Used to gate a one-shot review screen on first post-provisioning login. Becomes False once the user POSTs to /api/users/@me/credentials_review_complete/. Read-only.

Response

date_joinedstring date-time required
uuidstring uuid required
distinct_idstring nullable required
first_namestring
last_namestring
emailstring email required
pending_emailstring email nullable required
is_email_verifiedboolean nullable required
notification_settingsobject

Map of notification preferences. Keys include plugin_disabled, all_weekly_report_disabled, project_weekly_digest_disabled, error_tracking_weekly_digest_project_enabled, web_analytics_weekly_digest_project_enabled, organization_member_join_email_disabled, data_pipeline_error_threshold (number between 0.0 and 1.0), and other per-topic switches. Values are either booleans, or (for per-project/per-resource keys) a map of IDs to booleans. Only the keys you send are updated — other preferences stay as-is.

anonymize_databoolean nullable

Whether PostHog should anonymize events captured for this user when identified.

allow_impersonationboolean nullable
has_passwordboolean required
idinteger required
is_staffboolean

Designates whether the user can log into this admin site.

is_impersonatedboolean nullable required
is_impersonated_untilstring nullable required
is_impersonated_read_onlyboolean nullable required
is_impersonated_reasonstring nullable required

The reason the operator gave when the current impersonation session started (or was last up/downgraded). Null when not impersonating.

sensitive_session_expires_atstring nullable required
fresh_reauth_expires_atstring nullable required

When the last re-authentication stops counting as fresh. Changing email after this needs a new re-authentication. Null when the session has none on record.

set_current_organizationstring
set_current_teamstring
passwordstring required
current_passwordstring

The user's current password. Required when changing password if the user already has a usable password set.

events_column_configunknown
is_2fa_enabledboolean required
has_social_authboolean required
has_sso_enforcementboolean required
has_seen_product_intro_forunknown
hedgehog_configunknown
allow_sidebar_suggestionsboolean nullable
role_at_organization'engineering' | 'data' | 'product' | 'founder' | 'leadership' | 'marketing' | 'sales' | 'student' | 'other'
  • engineering - Engineering
  • data - Data
  • product - Product Management
  • founder - Founder
  • leadership - Leadership
  • marketing - Marketing
  • sales - Sales / Success
  • student - Student
  • other - Other
passkeys_enabled_for_2faboolean nullable

Whether passkeys are enabled for 2FA authentication. Users can disable this to use only TOTP for 2FA while keeping passkeys for login.

hide_mcp_hintsboolean

When true, the user has opted out of in-app hints promoting the PostHog MCP integration after taking actions.

ui_configurationunknown
onboarding_skipped_atstring date-time nullable required
onboarding_skipped_organization_idstring uuid nullable required
onboarding_delegated_to_invitestring uuid nullable required
onboarding_delegated_to_organization_idstring uuid nullable required

Organization ID of the pending delegation invite, if any. Used by the frontend to scope the 'waiting for teammate' UI to the org where delegation was initiated.

onboarding_delegation_accepted_atstring date-time nullable required
is_organization_first_userboolean nullable required
active_realtime_notification_typesstring[] required

Real-time notification types that currently have a live dispatch site. Drives the in-app notifications settings UI. Read-only.

requires_credential_reviewboolean required

True if the user has at least one Personal API Key or passkey, or a third-party OAuth application that can currently act as them, and has not yet acknowledged that access. Used to gate a one-shot review screen on first post-provisioning login. Becomes False once the user POSTs to /api/users/@me/credentials_review_complete/. Read-only.

Changes

No recorded changes to this operation across all 1 revision of this API.