Misc · Todo · Items
Update todo item
Updates the editable details of a todo item
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
todoItem.edit
Also checked, depending on the request and the records it touches
conversation.read
Request
Path parameters
-
organizationIdidrequired -
itemIdidrequired
Body
Content-Type: application/json
-
titlestringrequired1–140 characters
-
descriptionstringrequired1–10000 characters
-
customFieldsobject of one of 7 types | object of one of 7 types | object (recursive)[] | (one of 7 types)[][]requiredThe answers of a form, by the ID of each field. A repeating group holds a list of its entries under its own ID.
-
tagsstring[]requiredat most 20 items · each 1–40 characters
-
dueDatestring · date-timerequirednullable -
projectIdidnullable -
expectedUpdatedAtstring · date-timerequirednullable -
parentItemIdidrequirednullable -
attachmentsobject[]requiredat most 10 items
3 properties
-
fileNamestringat most 128 characters
-
resourcestringrequired -
idstringexactly 6 characters
-
-
contextobjectrequirednullableVariant 1: 2 properties
-
typestringrequired -
teamIdidrequirednullable
Variant 2: 2 properties
-
typestringrequired -
eventIdidrequirednullable
Variant 3: 2 properties
-
typestringrequired -
resourceIdidrequirednullable
Variant 4: 2 properties
-
typestringrequired -
conversationIdidrequirednullable
-
-
assignees(object)[]at most 100 items
Variant 1: 2 properties
-
typestringrequired -
userIdstringrequired16–64 characters
Variant 2: 2 properties
-
typestringrequired -
contactIdidrequired
-
-
reviewerUserIdstringnullable16–64 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/items/YOUR_ITEM_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_ID", {
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/items/YOUR_ITEM_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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.