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 event property metadata

Updates metadata on an event property. Returns 422 not_in_schema if
the property is ingested-only (is_in_schema: false); promote it via
POST first. Field absent means leave unchanged; field with null
clears (where allowed). enum_values and classifications replace the
array entirely — there is no per-item add/remove.

patch/v1/projects/{project_id}/events/{event_id}/event-properties/{event_property_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

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

Public event identifier. This value is the event type name (the string used when sending the event to Amplitude).

Constraints:min length: 1
event_property_idstringrequired

Public event 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
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
regexstring
Constraints:nullable
Other properties4
is_array_typeboolean
enum_valuesstring[]
is_hiddenboolean
classificationsstring[]

Response

application/json
200· Event property updated.
dataobjectrequired
Show child attributes
idstringrequired

Stable resource identifier. Equal to property_name.

objectstringrequired

Resource-type discriminator. Always event_property.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
event_typestringrequired

Event this property is bound to.

property_namestringrequired
descriptionstring
Constraints:nullable
is_hiddenbooleanrequired

Hidden from default UI surfaces and API listings.

is_in_schemabooleanrequired

Whether this property is part of the project's curated tracking plan. false means ingested-only (seen via SDK calls but never formally added). Properties with is_in_schema: false cannot be modified — PATCH returns 422 not_in_schema and metadata writes are rejected. POST implicitly transitions a property to is_in_schema: true.

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

Data Access Controls (DAC) tags. Examples include PII, SENSITIVE, INTERNAL.

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

Was this helpful?