Jump to

• Request
• Response

Delete the list of Cohorts corresponding to the cohort identifiers

delete

/ohfapi/cg/v3.3/cohorts

This endpoint deletes the cohorts corresponding to the cohort ids provided. Returns error if there is no privilege to delete any cohort.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• id: array
  Collection Format: multi

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Cohort Identifiers

  • [0]: integer(int64)

  {
      "name":"id",
      "in":"query",
      "description":"Cohort Identifiers",
      "required":true,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi",
      "maxItems":2147483647,
      "minItems":1
  }

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

204 Response

Cohort successfully deleted.

400 Response

Invalid Identifier

Back to Top