Skip to main content
PATCH
Patch Project Data Definition
Closed Beta
Available to a limited set of invited customers. Contact your account team to join. The request and response contract may change before general availability (GA).

Authorizations

Authorization
string
header
required

This endpoint uses Service Account authentication.

Headers

Mixpanel-Version
string
default:2026-08-13

Optional date-based API version pin.

If omitted, the request is served by the latest API version, and the caller accepts that a future release may introduce a breaking change to the response contract. If set to a supported version date, that version's contract is honored and will not receive a breaking change.

Path Parameters

definition_id
string
required
project_id
string
required

The unique identifier for the project.

Body

application/json

The fields to write on the definition. A field left out is unchanged.

description
string | null

The definition's description. null clears it.

display_name
string | null

The name shown in the UI. null clears it.

Maximum string length: 255
tags
DataDefinitionTagsPatch · object

Change the definition's tags.

owners
DataDefinitionOwnersPatch · object

Change the definition's owners.

hidden
boolean

Hide the definition.

blocked
boolean

Block the definition, which drops its incoming data at ingest.

verified
boolean

Verify the definition.

Response

OK

An event or event property, which has no definition body.

id
string
required

Opaque definition ID, stable across renames.

name
string
required

The definition's name.

event_name
string | null
required

The parent event of an event property.

display_name
string | null
required

The name shown in the UI.

description
string | null
required

The definition's description.

status
enum<string>
required

Whether the definition is visible, hidden, or blocked.

Available options:
visible,
hidden,
blocked
verified
boolean
required

Whether the definition is verified.

last_verified_at
string<date-time> | null
required

When the definition was last verified.

last_verified_by
DataDefinitionVerifier · object | null
required

Who last verified the definition.

tags
string[]
required

The definition's tag names.

owners
DataDefinitionOwner · object[]
required

The definition's owners.

merged_into
DataDefinitionSummary · object | null
required

The definition this one is merged into.

first_tracked_at
string<date-time> | null
required

When data for the definition was first seen.

created_at
string<date-time>
required

When the definition was created.

updated_at
string<date-time>
required

When the definition was last updated.

type
enum<string>
required

The kind of definition.

Available options:
event,
event_property
definition
null
required

Always null for this kind of definition.