Misc · Todo · Projects
Delete todo project
Deletes a todo project identified by organizationId and projectId. By default, deletion is blocked if the project has linked todos; set force to true to delete the project and queue cleanup of its linked todos. The endpoint returns no content.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have access to the organization.
- The caller needs the
todoProject.removepermission. - When
forceis true, the caller also needs thetodoItem.removepermission.
Request
Path parameters
-
organizationIdidrequired -
projectIdidrequired
Query parameters
-
forcebooleandefault
false
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request DELETE 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects/YOUR_PROJECT_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects/YOUR_PROJECT_ID", {
method: "DELETE",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'DELETE',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects/YOUR_PROJECT_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
No response body is specified.
What else happens
- Deletes the project from
todoProjectswhen the checks pass. - Queues a
misc.deleteTodoItemsjob onDefaultQueueafter the transaction to clean up todos linked to the project.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The todo project was not found | If the project is not found in the organization, the endpoint returns NOT_FOUND (404) with key routes.misc.todo.projects.notFound. |
| 409 | This project has linked todos. Use force deletion to delete the project and its todos, or archive the project to keep them. | If the project has linked todos and force is false, the endpoint returns CONFLICT (409) with key routes.misc.todo.projects.inUse. |
Errors nearly every request can meet are listed under Errors.