Delete a cohort

Deletes a cohort.

Insights, charts and automations that name it no longer can; a dynamic cohort that names it fails until it is changed.

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Cohorts

Something wrong or missing on this page? Tell us by email or on Discord.

On this page

Authorization Path parameters Examples Response body Errors More in Cohorts

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

cohortId*string

The cohort's id, an_cohort_....

Examples

curl -X DELETE "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1" \  -H "Authorization: Bearer vh_sk_..."

Empty

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

{  "error": {    "type": "unavailable",    "code": "string",    "message": "string",    "param": "string"  }}

Delete a cohort

Errors

More in Cohorts

Delete a cohort

Errors

More in Cohorts

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Delete a cohort

Delete a cohort

204

400application/json

401application/json

403application/json

404application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`