Skip to content
CLIUnofficial

privy users metadata update

Shallow-merge user custom metadata using a stored app API credential.

Usage

Section titled “Usage”
Terminal window
privy users metadata update [options] <user-id>

Arguments

Section titled “Arguments”
Argument Description
user-id —

Options

Section titled “Options”
Option Description
--dry-run Validate and print the API request without network access or credentials.
--yes Confirm this mutation or export.
--credential <id> App API credential ID in this app/profile OS vault; writes require full access.
--body <json> JSON body, or - to read stdin.
--file <path> JSON body file, or - to read stdin.
--custom-metadata <object> At most 1 KiB UTF-8 JSON; string keys and string/integer/boolean values. Set replaces; update shallow-merges.
--diff Read live state and show changes WITHOUT writing (requires login).
--allow-production Explicitly allow this production mutation; also requires --yes.

Global options such as --app, --account and --profile also apply. See the command reference overview.

Examples

Section titled “Examples”
Terminal window
privy users metadata update <user-id> --custom-metadata '{"purpose":"example"}' --diff
privy users metadata update <user-id> --custom-metadata '{"purpose":"example"}' --credential <stored-full-credential-id> --yes

Behavior

Section titled “Behavior”
  • Changes data: yes. Preview with --dry-run, then run with --yes and any required confirmations.
  • Scope: app
  • Before it runs: Dashboard app environment and exact same-app user; merged metadata size.
  • Production apps: --allow-production and --yes.
  • Verification: Fresh dashboard user metadata comparison.
  • Retries: None.
Section titled “Related guides”

Inspect the full contract locally with privy schema users metadata update.

Privy CLI is an unofficial, community project by Samarth Saxena. Not affiliated with or endorsed by Privy. The Privy name and wordmark belong to Privy. It uses undocumented dashboard APIs that can change.