Create user property
Creates a user property and adds it to the project's tracking plan.
Same idempotency semantics as creating an event property.
/v1/projects/{project_id}/user-propertiesAuthorizations
Authorizationstringrequiredhttp
Path parameters
project_idstringrequiredAmplitude project identifier, backed by the canonical app ID.
12345pattern: ^[0-9]+$Header parameters
Idempotency-KeystringrequiredRequired on write operations. Keys aren't stored yet, so retrying a write with the same key performs it again; a retried create makes another resource. Check whether the first attempt succeeded before you retry.
min length: 8max length: 255Body
application/jsonproperty_namestringrequiredmin length: 1display_namestringnullabledescriptionstringnullabledata_typestringLogical data type of a property. null means untyped at the source;
clients should treat it as string for ingestion.
stringnumberbooleanobjectenumanynullnullableis_array_typebooleanfalseregexstringnullableis_hiddenbooleanfalseenum_valuesstring[]classificationsstring[]Response
application/jsondataobjectrequiredShow child attributes
idstringrequiredStable resource identifier. Equal to property_name.
objectstringrequiredResource-type discriminator. Always user_property.
project_idstringrequiredpattern: ^[0-9]+$property_namestringrequireddisplay_namestringnullabledescriptionstringnullableis_officialbooleanCurated/official flag. null ⇒ inherited / unset upstream.
nullableis_hiddenbooleanrequiredis_in_schemabooleanrequiredWhether this property is part of the project's curated tracking
plan. Same semantics as EventProperty.is_in_schema.
data_typestringLogical data type of a property. null means untyped at the source;
clients should treat it as string for ingestion.
stringnumberbooleanobjectenumanynullnullableis_array_typebooleanrequiredenum_valuesstring[]requiredregexstringnullableclassificationsstring[]requiredWas this helpful?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.