Update Cohort
PATCH /v2/partner/cohorts/{id}
Required scopes
partner:cohorts:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | updateCohort |
| Tags | Audience |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | cohort |
| team_id * | id | UUID v4. |
| name * | string | |
| description | string | |
| predicate * | predicate | |
| predicate_hash * | string | |
| estimated_count | integer | |
| estimated_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | cohort |
| team_id * | id | UUID v4. |
| name * | string | |
| description | string | |
| predicate * | predicate | |
| predicate_hash * | string | |
| estimated_count | integer | |
| estimated_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
PATCH https://api.digitalonboarding.com/v2/partner/cohorts/{id}
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }