Misc · Todo · Topics
Create todo topic
Creates a todo topic and its available workflows for an organization. It takes an identifier, name, color, description, nullable custom fields, and a review-before-completion flag, and returns the new topic’s _id.
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
todoTopic.insertpermission.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
identifierstringrequired1–4 characters
-
namestringrequired1–80 characters
-
colorstringrequired22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
descriptionstringrequiredat most 10000 characters
-
customFieldsobjectrequirednullable5 properties
-
groupsobject[]required12 properties
-
idstringrequired1–24 characters
-
pageIdstring1–24 characters
-
labelstringrequiredat most 140 characters
-
hintstringat most 280 characters
-
fieldsobject[]required -
disabledboolean | object2 properties
-
operatorstringrequiredandor -
conditions(object (recursive) | object)[]requiredat least 1 items
4 properties
-
leftobject | object of anyrequiredVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
cmpFuncstringrequired15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
negateboolean
-
-
-
hiddenboolean | object2 properties
-
operatorstringrequiredandor -
conditions(object (recursive) | object)[]requiredat least 1 items
4 properties
-
leftobject | object of anyrequiredVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
cmpFuncstringrequired15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
negateboolean
-
-
-
minItemsintegerat least 0
-
maxItemsinteger -
addItemCaptionstringat most 64 characters
-
itemCaptionstringat most 100 characters
-
itemModestringnoHeaderdraggable
-
-
pagesobject[]3 properties
-
idstringrequired1–24 characters
-
labelstringrequired1–40 characters
-
hintstringat most 280 characters
-
-
submitCaptionstring -
appearanceobject5 properties
-
accentColorstring -
accentTextColorstring -
boxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
groupBoxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
inputBoxobject8 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
labelFontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
heightnumberat least 0
-
-
-
validationsobject[]2 properties
-
conditionobjectrequired2 properties
-
operatorstringrequiredandor -
conditions(object (recursive) | object)[]requiredat least 1 items
4 properties
-
leftobject | object of anyrequiredVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
cmpFuncstringrequired15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
negateboolean
-
-
-
messagestring1–500 characters
-
-
-
reviewBeforeCompletionbooleanrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics", {
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', 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
Content-Type: application/json
-
_idid
{
"_id": "000000000000000000000001"
}
What else happens
- Inserts the topic into
todoTopics.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 409 | This topic identifier is already in use. | If the insert fails with a duplicate-key error, the endpoint returns HTTP 409 with key routes.misc.todo.errors.identifierInUse. |
Errors nearly every request can meet are listed under Errors.