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.

Create user property

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

Creates a user property and adds it to the project's tracking plan.
Same idempotency semantics as creating an event property.

post/v1/projects/{project_id}/user-properties

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Header parameters

Idempotency-Keystringrequired

Unique idempotency key used to safely retry write operations.

Constraints:min length: 8max length: 255

Body

application/json
property_namestringrequired
Constraints:min length: 1
display_namestring
Constraints:nullable
descriptionstring
Constraints:nullable
data_typestring

Logical data type of a property. null means untyped at the source; clients should treat it as string for ingestion.

Allowed values:stringnumberbooleanobjectenumanynull
Constraints:nullable
is_array_typeboolean
Default:false
regexstring
Constraints:nullable
is_hiddenboolean
Default:false
Other properties2
enum_valuesstring[]
classificationsstring[]

Response

application/json
201· User property created.
dataobjectrequired
Show child attributes
idstringrequired

Stable resource identifier. Equal to property_name.

objectstringrequired

Resource-type discriminator. Always user_property.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
property_namestringrequired
display_namestring
Constraints:nullable
descriptionstring
Constraints:nullable
is_officialboolean

Curated/official flag. null ⇒ inherited / unset upstream.

Constraints:nullable
is_hiddenbooleanrequired
is_in_schemabooleanrequired

Whether this property is part of the project's curated tracking plan. Same semantics as EventProperty.is_in_schema.

data_typestring

Logical data type of a property. null means untyped at the source; clients should treat it as string for ingestion.

Allowed values:stringnumberbooleanobjectenumanynull
Constraints:nullable
is_array_typebooleanrequired
enum_valuesstring[]required
regexstring
Constraints:nullable
classificationsstring[]required

これは役に立ちましたか？