Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

POST/{organizationId}/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.insert permission.

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • identifierstringrequired

    1–4 characters

  • namestringrequired

    1–80 characters

  • colorstringrequired
    22 values
    slate gray zinc neutral stone red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose
  • descriptionstringrequired

    at most 10000 characters

  • customFieldsobjectrequirednullable
    5 properties
    • groupsobject[]required
      12 properties
      • idstringrequired

        1–24 characters

      • pageIdstring

        1–24 characters

      • labelstringrequired

        at most 140 characters

      • hintstring

        at most 280 characters

      • fieldsobject[]required
      • disabledboolean | object
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • hiddenboolean | object
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • minItemsinteger

        at least 0

      • maxItemsinteger
      • addItemCaptionstring

        at most 64 characters

      • itemCaptionstring

        at most 100 characters

      • itemModestring
        noHeader draggable
    • pagesobject[]
      3 properties
      • idstringrequired

        1–24 characters

      • labelstringrequired

        1–40 characters

      • hintstring

        at most 280 characters

    • submitCaptionstring
    • appearanceobject
      5 properties
      • accentColorstring
      • accentTextColorstring
      • boxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • groupBoxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • inputBoxobject
        8 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • labelFontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • heightnumber

          at least 0

    • validationsobject[]
      2 properties
      • conditionobjectrequired
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • messagestring

        1–500 characters

  • reviewBeforeCompletionbooleanrequired
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' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • _idid
Response200
{
  "_id": "000000000000000000000001"
}

What else happens

  • Inserts the topic into todoTopics.

Errors

Other errors

StatusErrorWhen
409This 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.