Skip to main content
PATCH
/
cohorts
/
{cohortId}
Update cohort definition
curl --request PATCH \
  --url https://api.recurr.dev/v1/cohorts/{cohortId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "definition": {
    "status": [],
    "tenure_days_min": 123,
    "tenure_days_max": 123,
    "plan_ids": [
      "<string>"
    ],
    "tags_include": [
      "<string>"
    ],
    "tags_exclude": [
      "<string>"
    ],
    "engagement_score_min": 123
  }
}
'
{
  "id": "cohort_01HQX...",
  "name": "High-LTV annual subs",
  "definition": {
    "status": [],
    "tenure_days_min": 123,
    "tenure_days_max": 123,
    "plan_ids": [
      "<string>"
    ],
    "tags_include": [
      "<string>"
    ],
    "tags_exclude": [
      "<string>"
    ],
    "engagement_score_min": 123
  },
  "member_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "used_by_motions": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Your Recurr secret API key as a Bearer token: Authorization: Bearer rk_live_….

Keys are environment-scoped — rk_live_ operates on live data, rk_test_ on isolated test data (see Test mode). Create, scope, and rotate keys in your dashboard (Settings → API keys, developer role). Secret keys are server-side only — never ship them in an app binary or client JavaScript.

Headers

​
Idempotency-Key
string

Idempotency key for safe retries on write operations. Pass a unique key per logical request; Recurr returns the original response for duplicate keys within a 24-hour window.

Maximum string length: 255

Path Parameters

​
cohortId
string
required

Body

application/json
​
name
string
​
description
string
​
definition
object

Query criteria defining cohort membership. Evaluated at query time, so membership reflects current subscriber state.

Response

200 - application/json

Updated cohort

​
id
string
required
Example:

"cohort_01HQX..."

​
name
string
required
Example:

"High-LTV annual subs"

​
definition
object
required

Query criteria defining cohort membership. Evaluated at query time, so membership reflects current subscriber state.

​
member_count
integer
required

Approximate count of subscribers currently matching the definition.

​
created_at
string<date-time>
required
​
description
string | null
​
used_by_motions
string[]

Motion IDs that reference this cohort.

​
updated_at
string<date-time>