Skip to main content
PATCH
Update a cohort

Authorizations

X-Api-Key
string
header
required

API key issued for programmatic access.

Path Parameters

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

Body

application/json
description
string
groups
Criteria group · object[]

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

Minimum array length: 1
match
enum<string>

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

Available options:
AND,
OR
title
string
Minimum string length: 1

Response

cohort updated

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.