Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Body

application/json

Create a population

name
string
required
Minimum string length: 1
datasource
string
required

Id of the Data Source

userIdTypes
string[]
required

Identifier types the population can be joined on. Every step's fact table must support all of them

Minimum array length: 1
steps
object[]
required

Steps a unit must complete, in order, to be included. The steps can read from at most 5 distinct fact tables

Required array length: 1 - 20 elements
description
string
owner
string

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. Optional when authenticating with a Personal Access Token (PAT): when omitted, the owner defaults to the PAT's user. Required when authenticating with an organization secret API key (which has no associated user): omitting it fails with a 400.

projects
string[]

Response

200 - application/json

Resource created

population
object
required