provider custom_property_definitions PATCH /api/environments/{environment_id}/custom_property_definitions/{id}/
@utdk/posthog /api/environments/{environment_id}/custom_property_definitions/{id}/
environments_custom_property_definitions_partial_update
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
string

Try it

Authentication
Configure credentials for PostHog API
environmentsCustomPropertyDefinitionsPartialUpdate
PATCH/api/environments/{environment_id}/custom_property_definitions/{id}/

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

Input

Human-readable name of the custom property. Unique within the team.

Optional description of what the property represents.

How the property is interpreted and rendered: 'text', 'number', 'currency', 'percent', 'date', 'datetime', 'boolean', or 'select'. * `text` - text * `number` - number * `currency` - currency * `percent` - percent * `date` - date * `datetime` - datetime * `boolean` - boolean * `select` - select

Abbreviate large numbers (e.g. 10,000 → 10K). Only applies to numeric properties.

For select properties: the allowed options. Required (non-empty) when display_type is 'select'; cleared server-side for other types.

The data-warehouse view-sync binding feeding this property, or null when values are set manually.

Workflows that use this property, resolved by definition id.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsCustomPropertyDefinitionsPartialUpdate({
  "is_big_number": false
})