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.

Update user property metadata

이 페이지는 아직 귀하의 언어로 번역되지 않았습니다. 현재 작업 중이므로 곧 다시 확인해 주십시오.

Updates metadata on a user property. Returns 422 not_in_schema if the
property is ingested-only. Same patch semantics as updating an event property
(field absent = unchanged, null = clear, arrays replace).

Only display_name, description, is_hidden, and classifications
are mutable via PATCH today. Type/shape fields (data_type,
is_array_type, enum_values, regex) are settable only at creation.
is_official is read-only in this API version.

patch/v1/projects/{project_id}/user-properties/{user_property_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

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

Public user property identifier. Equal to property_name. URL-encode when the property name contains spaces or special characters.

Constraints:min length: 1

Header parameters

Idempotency-Keystringrequired

Unique idempotency key used to safely retry write operations.

Constraints:min length: 8max length: 255

Body

application/json
display_namestring
Constraints:nullable
descriptionstring
Constraints:nullable
Other properties2
is_hiddenboolean
classificationsstring[]

Response

application/json
200· User property updated.
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
422· Property is not part of the project's tracking plan. Returned when attempting to PATCH a property with is_in_schema: false.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable

이 내용이 도움이 되었나요?