Skip to content
CLIUnofficial

privy accounts invitations create

Invite a dashboard member; can send email and grants account-wide access after acceptance.

Usage

Section titled “Usage”
Terminal window
privy accounts invitations create [options]

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.
--confirm-account <name> Exact account name; this is an account-wide mutation.
--allow-self-impact Explicitly acknowledge changing/removing your own membership; last-admin guard still applies.
--body <json> JSON body, or - to read stdin.
--file <path> JSON body file, or - to read stdin.
--email-address <string> Exact invitation email. Creating an invitation can send an email.
--role <string> Account-wide dashboard role. Not an app-local role.
--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 accounts invitations create --account <account-id> --email-address person@example.invalid --role viewer --dry-run

Behavior

Section titled “Behavior”
  • Changes data: yes. Preview with --dry-run, then run with --yes and any required confirmations.
  • Scope: account
  • Before it runs: Fresh account state; refuse if any protected app; last admin/self-impact/dependency checks.
  • Production apps: Accounts containing production apps require --allow-production.
  • Verification: Fresh account membership/invitation read-back.
  • Retries: None.
Section titled “Related guides”

Inspect the full contract locally with privy schema accounts invitations create.

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.