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

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

Creates an event property and adds it to the project's tracking plan
(is_in_schema: true after success). If the property already exists in
the schema, the existing resource is returned without modification.
If the property exists ingested-only (is_in_schema: false), this call
promotes it into the schema with the metadata supplied here.

post/v1/projects/{project_id}/events/{event_id}/event-properties

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

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
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· Event property created.
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.

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