amp user-properties

amp user-properties manages a project's user properties. Read commands require taxonomy:read; create, update, and delete require taxonomy:write.

`amp user-properties list`

bash

amp user-properties list --project <project_id> --limit 5

Use --q to search the project's properties. In an interactive terminal, amp prints a table. Pipe the result or pass --json to get the raw API response.

`amp user-properties create`

bash

amp user-properties create --project <project_id> \
  --property <property_name> --display-name "Property name" --data-type string

Creating a property adds it to the project's tracking plan. If an ingested-only property has the same name, the command promotes it into the plan.

`amp user-properties get`

bash

amp user-properties get --project <project_id> --property <property_name>

`amp user-properties update`

bash

amp user-properties update --project <project_id> \
  --property <property_name> --description "Updated description"

You can update display_name, description, is_hidden, and classifications. Updating an ingested-only property returns 422 with error_code: "not_in_schema"; create it first to promote it. An update to classifications replaces the entire array.

`amp user-properties delete`

bash

amp user-properties delete --project <project_id> --property <property_name> --dry-run
amp user-properties delete --project <project_id> --property <property_name> --yes

Preview the deletion with --dry-run. At a terminal, the delete command asks for confirmation; pass --yes to skip the prompt.

Run amp user-properties <command> --help for pagination, search, property metadata, and other command-specific flags.

Was this helpful?