custom_property_sources

put/api/projects/{project_id}/custom_property_sources/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/custom_property_sources/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

source_columnstring

Column in the view whose value is written to the property.

key_columnstring

Column in the view whose value matches an account's external_id.

column_property_mapunknown
column_descriptionsunknown
is_enabledboolean

Whether the source syncs; re-enabling it resets the failure count.

Response

idstring uuid required
definitionstring uuid required

UUID of the custom property definition this source feeds. One source per definition.

saved_querystring uuid nullable

UUID of the data-warehouse saved query to read from. Required for an account source. For a person or group source it must be a materialized view, and is one of the two binding options. Mutually exclusive with external_data_schema.

external_data_schemastring uuid nullable

Person and group sources only: UUID of the warehouse schema (an imported table) to read from. Mutually exclusive with saved_query; a person or group source sets exactly one.

source_columnstring nullable

Account sources only: column in the view whose value is written to the property.

column_property_mapunknown
column_descriptionsunknown
key_columnstring required

Column whose value identifies the target: an account's external_id for account sources, the person's distinct_id for person sources, or the group key for group sources.

is_enabledboolean

Whether the source syncs. Auto-disabled after repeated failures or a missing view; re-enabling resets the failure count.

consecutive_failuresinteger required

Consecutive failed sync runs; the source auto-disables at the cap.

last_synced_atstring date-time nullable required

When the most recent sync run finished.

last_sync_errorstring nullable required

Error summary from the last run, or null if it succeeded.

created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required
sync_frequency_interval_secondsnumber double nullable required

Person and group sources only: how often the bound table or view runs, in seconds. Null for account sources, or when the schedule is unavailable — including a view whose frequency is set on its data-modeling DAG.

next_sync_atstring date-time nullable required

Person and group sources only: approximate time of the next scheduled run (last run + interval). Approximate — drifts if the schedule was paused. Null for account sources, if never run, or when the interval is unavailable.

external_data_sourcestring uuid nullable required

Table-bound person and group sources only: UUID of the warehouse source owning the schema, so the UI can link to the table. Null for account sources, view-bound sources, or when unavailable.

table_namestring nullable required

Person and group sources only: what this source reads, as it is named in HogQL — the imported table, or the view. Null for account sources or when unavailable.

saved_query_namestring nullable required

View-bound person and group sources only: the materialized view's name, so the UI can tell a view-backed source from a table-backed one. Null for account and table-bound sources.

Changes

No recorded changes to this operation across all 1 revision of this API.