Cohort routes: update, delete

Reference for Cohort, one group of Cohort routes.

Cohort.update

Changes the given properties of a Cohort. Verb page.

Text

PATCH /{namespace}/cohorts/{id}

Path: id. Body, as JSON: the other inputs. Emits Cohort.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Cohort.
`query`	`json`		The Portfolio query that selects its Startups.
`control`	`boolean`		True when the Cohort stays on the prior Version as the control.

Returns

Output	Type	Required	Description
`cohort`	Cohort	required	The Cohort.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/cohorts/cohort_YxPOKnSexq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "cohort": {
    "$id": "https://api.sb/leaseline.app/cohorts/cohort_YxPOKnSexq",
    "$type": "Cohort",
    "query": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Cohort.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Cohort.delete

Deletes a Cohort: a soft delete that keeps its history, undone by Thing.restore. Verb page.