workflow_people_imports

Create or update people from rows and add them to a new static cohort

Changed on
post/api/projects/{project_id}/workflow_people_imports/

Request

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

Path parameters

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

namestring required

Name of the static cohort that holds the imported people.

rowsobject[] required

One object per person. Each needs "email". An optional "distinct_id" picks the person to update or create, and an "id" column counts as the distinct_id when there is no "distinct_id" column. Without either, the row updates the person with that email, or creates one keyed by the email. Every other key is set as a person property.

Response

cohort_idinteger required

The static cohort that fills with the imported people.

row_countinteger required

People created or updated.

new_peopleinteger required

Rows that create a person who isn't in PostHog yet.

columnsstring[] required

Person properties the rows set.

dropped_invalid_emailinteger required

Rows dropped for a missing or invalid email.

dropped_duplicate_emailinteger required

Rows dropped because an earlier row had the email or distinct ID.

dropped_too_largeinteger required

Rows dropped for holding more than 4KB of data.

Changes