Skip to main content
PUT
/
advertisers
/
{advertiserId}
/
test-cohorts
/
{cohortId}
Update test cohort
curl --request PUT \
  --url https://api.agentic.scope3.com/api/v2/buyer/advertisers/{advertiserId}/test-cohorts/{cohortId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "cohort": {
    "id": "cohort_abc123",
    "advertiserId": "12345",
    "name": "West Coast Treatment Group",
    "cohortType": "geographic",
    "role": "TREATMENT",
    "definition": {
      "type": "zip_code"
    },
    "isActive": true,
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-20T14:45:00Z",
    "description": "<string>",
    "estimatedSize": 50000
  }
}

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

cohortId
string
required

Unique identifier for the test cohort

Minimum string length: 1
Example:

"cohort_abc123"

Body

application/json

Request body for updating a test cohort (all fields optional)

name
string

Updated name of the test cohort

Required string length: 1 - 255
Example:

"West Coast Treatment Group - Updated"

description
string

Updated description of the test cohort

Maximum string length: 1000
cohortType
string

Updated type classification for the cohort

Minimum string length: 1
role
enum<string>

Updated role of the cohort in the test

Available options:
TREATMENT,
CONTROL,
OBSERVATION
definition
object

Updated cohort targeting definition

estimatedSize
integer

Updated estimated number of users in this cohort

Required range: 0 <= x <= 9007199254740991

Response

Update test cohort

Response containing a single test cohort

cohort
object
required

Test cohort resource representation