Misc · Todo · Topics
Update todo topic details
Updates a todo topic's name, color, and description using its organization ID, topic ID, and expected revision. It also updates the topic name and color on associated todo items when either changes. 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
- Requires organization access and the
todoTopic.editpermission.
Request
Path parameters
-
organizationIdidrequired -
topicIdidrequired
Body
Content-Type: application/json
-
revisionintegerrequiredat least 0
-
namestringrequired1–80 characters
-
colorstringrequired22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
descriptionstringrequiredat most 10000 characters
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics/YOUR_TOPIC_ID/details' \
--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/details", {
method: "POST",
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' => 'POST',
'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/details', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
What else happens
- Updates the topic details and increments its revision.
- If the topic's name or color changes, updates both values on associated todo items in the organization.
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 changed while you were editing it. Reload it and apply your changes again. | If the topic's revision differs from the supplied revision, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed. |
| 409 | This topic changed while you were editing it. Reload it and apply your changes again. | If the topic update no longer matches the expected revision, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed. |
Errors nearly every request can meet are listed under Errors.