Delete a project
Log in to add to favouritesDeletes a project resource.
delete(id: string): Promise<void>
Returns
A Promise that will resolve with an empty object.
Example
client.projects.delete('website')
.then(result => {
console.log('API call result: ', result);
})
.catch(error => {
console.log('API call fetch error: ', error);
});Validations
Single project
A project cannot be deleted if it is the only project in a Contensis instance. If you attempt to delete all projects in a Contensis instance, you will get the following response.
{
"logId": "00000000-0000-0000-0000-000000000000",
"message": "There are validation errors deleting the project 'movieDb'",
"data": [
{
"field": "",
"message": "The specified project is the only project and therefore cannot be deleted"
}
],
"type": "Validation"
}A project containing content
In order to delete a project it has to be empty. This is a safeguard to stop people deleting projects which are in use. If you attempt to delete a project which contains content types, you will get the following response.
{
"logId": "5fca7986-5ba3-4eb4-9cea-b5f25aaaed09",
"message": "There are validation errors deleting the project 'movieDb'",
"data": [
{
"field": "",
"message": "The project has associated content types so cannot be deleted"
}
],
"type": "Validation"
}