Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Auth0 CLI

auth0 agents update

Update an agent.

To update interactively, use auth0 agents update with no arguments.

To update non-interactively, supply the agent ID and the fields to change through the flags. Pass --metadata null to clear all metadata. The external ID cannot be changed.

Use ‘–schema’ to print the request payload schema and exit. Use ‘–data’ to supply the full JSON payload (validated against the schema before sending).

Usage 

auth0 agents update [flags]

Examples 

  auth0 agents update
  auth0 agents update <agent-id> --name "New Name"
  auth0 agents update <agent-id> --metadata '{"team":"platform"}' --json
  auth0 agents update <agent-id> --metadata @metadata.json
  auth0 agents update <agent-id> --metadata null

  # Discover the payload schema
  auth0 agents update --schema

  # JSON input mode (for agents and automation)
  auth0 agents update <agent-id> --data '{"name":"New Name"}'

Flags 

      --data string       JSON payload for the operation, as a JSON string or file path (@file.json). Can also be piped via stdin.
      --json              Output in json format.
      --json-compact      Output in compact json format.
  -m, --metadata string   Metadata for the agent as a JSON object (max 10KB), e.g. '{"team":"ai"}', or a file (@metadata.json). On update, null or {} clears it.
  -n, --name string       Name of the agent (1-255 characters).
      --schema            Print the request payload schema for this command and exit. Use with --json or --json-compact for machine-readable output.

Inherited Flags 

      --agent-mode      Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
      --debug           Enable debug mode.
      --no-color        Disable colors.
      --no-input        Disable interactivity.
      --tenant string   Specific tenant to use.