Skip to main content
POST
Create a cohort

Authorizations

X-Api-Key
string
header
required

API key issued for programmatic access.

Body

application/json
groups
Criteria group · object[]
required

Groups of criteria, combined with match. A wallet joins the cohort when the groups it satisfies satisfy that combination.

Minimum array length: 1
title
string
required
Minimum string length: 1
description
string
match
enum<string>

How the members combine. Required when there is more than one.

Available options:
AND,
OR

Response

cohort accepted for building

cohortId
string
required
Pattern: ^[0-9A-HJ-KM-NP-TV-Z]{13}$
executionId
string

The run building the cohort. Poll GET until status is ready.