provider usersusers PUT /api/users/{uuid}/
@utdk/posthog /api/users/{uuid}/
users_update
Replace the authenticated user's profile and settings. Pass `@me` as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.
uuid path required
string

Try it

Authentication
Configure credentials for PostHog API
usersUpdate
PUT/api/users/{uuid}/
Replace the authenticated user's profile and settings. Pass `@me` as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.

Parameters

required

Input

required
required
required
required
required
required

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.

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

required
required

Designates whether the user can log into this admin site.

required
required
required
required
required
required
required
required

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

required
required
required
required

* `engineering` - Engineering * `data` - Data * `product` - Product Management * `founder` - Founder * `leadership` - Leadership * `marketing` - Marketing * `sales` - Sales / Success * `other` - Other

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

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

required
required
required
required
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.

required
required
required

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

required
required

True if the user has at least one Personal API Key or passkey and has not yet acknowledged their existing credentials. 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.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.usersUpdate()