Delete collection

  • Updated on Jun 30, 2021
  • Published on Oct 31, 2020
  • 1 minute(s) read
Prev Next

Delete Collection

DELETE /collections/{externalId}

Header

Name Data Type Description
Content-type: application/json for all requests
Authorization: EAPI {token} for all requests

Request Parameters

Parameters indicated with a * are mandatory

Parameter Type Description max length
externalId* String The external ID of a user that needs to be fetched

Sample successfull Response

{
    "Content": {
        "ExternalId": "ColExt1",
        "Errors": null
    },
    "Success": true,
    "Errors": null
}

Sample unsuccessfull Response

{
    "Success": false,
    "Errors": "Collection with externalId [ColExt12345] is not found."
}

Responses

Code Description
200 Successful operation
400 Possible errors:
ExternalId parameter can not be null or empty
Collection with ExternalId [{externalId}] is not found
Collection with externalId [{externalId}] has been deleted
Collection contains items that used in assessments
403 Not allowed to use external API
500 Internal server error