Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Pass your API key as the Bearer token. See Authentication.

Path Parameters

id
string
required

The id of the requested resource

Body

application/json
name
string
Minimum string length: 1
description
string
Maximum string length: 10000
projectIds
string[]
eventTracker
enum<string>

eventForwarder is only accepted unchanged

Available options:
segment,
snowplow,
jitsu,
freshpaint,
ga4,
fullstory,
matomo,
heap,
rudderstack,
amplitude,
mparticle,
mixpanel,
firebase,
keen,
clevertap,
langfuse,
phoenix,
eventForwarder,
custom
identifierTypes
object[]

Replaces the list. An entry matching an existing id keeps its description if left out; send "" to clear it.

assignmentQueries
object[]

Replaces the list. An entry with an existing id keeps description, identifierTypes, includesNameColumns, dimensionColumns, projects and columnMapping if left out; clear the others with "", false or []. Each query is validated against the warehouse.

identifierJoinQueries
object[]

Replaces the list

mixpanelSettings
object
pipelineSettings
object

Merged into the stored settings: fields left out keep their values, but any change must leave allowWriting, mode, writeDataset and unitsTableRetentionHours set, with a non-empty writeDataset when allowWriting is true. Send [] to clear excludedExperimentIds or incrementalOptInExperimentIds, and includedExperimentIds: null to apply the mode to every experiment again ([] applies it to none).

maxConcurrentQueries
integer
Required range: x >= 0
queryCacheTTLMins
integer
Required range: x >= 0

Response

Resource created

dataSource
object
required
eventForwarderWarning
string

Set if the update saved but syncing the Event Forwarder failed