Misc · Todo · Topics
Delete todo topic
Deletes a todo topic for an organization. It takes organizationId, topicId, and an optional force flag that defaults to false. Without force, a topic with linked todos cannot be deleted; with force, cleanup of linked todos is queued. The mutation returns no body.
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 organization access.
- The caller needs
todoTopic.remove. - When
forceis true, the caller also needstodoItem.remove.
Request
Path parameters
-
organizationIdidrequired -
topicIdidrequired
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/topics/YOUR_TOPIC_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics/YOUR_TOPIC_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/topics/YOUR_TOPIC_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
- The topic is deleted from
todoTopics. - After the transaction, a
misc.deleteTodoItemsjob is queued onDefaultQueuefor the topic's todos.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The todo topic was not found | If the topic is not found in the organization, the endpoint returns HTTP 404 with key routes.misc.todo.topics.notFound. |
| 409 | This topic has linked todos. Use force deletion to delete the topic and its todos, or archive the topic to keep them. | If the topic has linked todos and force is false, the endpoint returns HTTP 409 with key routes.misc.todo.topics.inUse. |
Errors nearly every request can meet are listed under Errors.