Contents x
- Developers
- Getting Started
- REST API Reference
- Using Cirrus REST API
- Users
- Hierarchies (Groups)
- Collections
- Assessments
- Scheduling
- Attempts
- Marking Settings
- Candidate Review Sessions
- Results
- Webhooks
- Change log
- Integrations
- LTI
- Single Sign-On
Delete collection
- Updated on 30 Jun 2021
- 1 Minute to read
- Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback
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
}
JSON
Sample unsuccessfull Response
{
"Success": false,
"Errors": "Collection with externalId [ColExt12345] is not found."
}
JSON
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 |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
How can we improve this article?
Your feedback
Comment
Comment (Optional)
Character limit : 500
Please enter your comment
Email (Optional)
Email
Please enter a valid email