v2

Create cohort

This endpoint allows the creation of a new cohort. The query definition is provided using the Cohort API JSON query definition format.

The cohort will belong to the workspace which owns the provided API key.

post/v2/cohorts

Request

Base URL
https://api.permutive.app
Auth
API key in query parameter k
TypeScript
https://skmtc.dev/permutive/apis/custom-cohort-segmentation-api/docs/v2/cohorts/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

descriptionstring

queryunknown required

tagsstring[]

Response

Cohort in full (including query)

idstring required

codeinteger required

namestring required

descriptionstring

queryunknown required

tagsstring[]

state'Enabled' | 'Disabled' required

workspaceIdstring

createdAtstring date-time required

lastUpdatedAtstring date-time required

Changes

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