Unicat API Reference

Up - API Reference - Home

/api/projects/delete

Requires JWT.

Deletes a project. You must be the owner of this project.

A deleted project can be undeleted unless it was followed by a permanent_delete.

Request

POST /api/projects/delete
Authorization: Bearer <JWT>

{
    "project": "<project gid>"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "project": "<project gid>",
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                "gid": "<project gid>",
                …,
                "status": "deleted",
                …
            }
        }
    }
}

result

project is the project gid you provided.

data

cc.projects is a dictionary with one entry for the project, where the status is set to 'deleted'.

Error responses

400 Bad request - missing argument
401 Unauthorized - missing or expired JWT
403 Forbidden - not the owner of this project
422 Unprocessable Entity - deletion failed