Update a cohort
curl --request PATCH \
--url https://api.example.com/api/v1/cohorts/{cohortId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"groups": [
{
"criteria": [
{
"condition": {
"value": 123
},
"measure": {},
"table": "activity",
"timeRange": {
"since": "2023-12-25"
},
"filter": [
{
"value": 123
}
],
"negative": true
}
]
}
],
"title": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/cohorts/{cohortId}"
payload = {
"description": "<string>",
"groups": [{ "criteria": [
{
"condition": { "value": 123 },
"measure": {},
"table": "activity",
"timeRange": { "since": "2023-12-25" },
"filter": [{ "value": 123 }],
"negative": True
}
] }],
"title": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
groups: [
{
criteria: [
{
condition: {value: 123},
measure: {},
table: 'activity',
timeRange: {since: '2023-12-25'},
filter: [{value: 123}],
negative: true
}
]
}
],
title: '<string>'
})
};
fetch('https://api.example.com/api/v1/cohorts/{cohortId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/cohorts/{cohortId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'groups' => [
[
'criteria' => [
[
'condition' => [
'value' => 123
],
'measure' => [
],
'table' => 'activity',
'timeRange' => [
'since' => '2023-12-25'
],
'filter' => [
[
'value' => 123
]
],
'negative' => true
]
]
]
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/cohorts/{cohortId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/cohorts/{cohortId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cohorts/{cohortId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cohortId": "<string>",
"executionId": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Cohorts
Update a cohort
Changes a cohort’s name or replaces its criteria. Only the fields sent are changed; supplying groups replaces the criteria wholesale and rebuilds the cohort.
PATCH
/
api
/
v1
/
cohorts
/
{cohortId}
Update a cohort
curl --request PATCH \
--url https://api.example.com/api/v1/cohorts/{cohortId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"groups": [
{
"criteria": [
{
"condition": {
"value": 123
},
"measure": {},
"table": "activity",
"timeRange": {
"since": "2023-12-25"
},
"filter": [
{
"value": 123
}
],
"negative": true
}
]
}
],
"title": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/cohorts/{cohortId}"
payload = {
"description": "<string>",
"groups": [{ "criteria": [
{
"condition": { "value": 123 },
"measure": {},
"table": "activity",
"timeRange": { "since": "2023-12-25" },
"filter": [{ "value": 123 }],
"negative": True
}
] }],
"title": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
groups: [
{
criteria: [
{
condition: {value: 123},
measure: {},
table: 'activity',
timeRange: {since: '2023-12-25'},
filter: [{value: 123}],
negative: true
}
]
}
],
title: '<string>'
})
};
fetch('https://api.example.com/api/v1/cohorts/{cohortId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/cohorts/{cohortId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'groups' => [
[
'criteria' => [
[
'condition' => [
'value' => 123
],
'measure' => [
],
'table' => 'activity',
'timeRange' => [
'since' => '2023-12-25'
],
'filter' => [
[
'value' => 123
]
],
'negative' => true
]
]
]
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/cohorts/{cohortId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/cohorts/{cohortId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cohorts/{cohortId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"criteria\": [\n {\n \"condition\": {\n \"value\": 123\n },\n \"measure\": {},\n \"table\": \"activity\",\n \"timeRange\": {\n \"since\": \"2023-12-25\"\n },\n \"filter\": [\n {\n \"value\": 123\n }\n ],\n \"negative\": true\n }\n ]\n }\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"cohortId": "<string>",
"executionId": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
API key issued for programmatic access.
Path Parameters
Pattern:
^[0-9A-HJ-KM-NP-TV-Z]{13}$Body
application/json
Groups of criteria, combined with match. A wallet joins the cohort when the groups it satisfies satisfy that combination.
Minimum array length:
1Show child attributes
Show child attributes
How the members combine. Required when there is more than one.
Available options:
AND, OR Minimum string length:
1⌘I