Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

POST/{organizationId}/misc/todo/topics/{topicId}/fields

Update todo topic fields

Updates the custom fields of a todo topic in an organization. Supply the topic ID, current revision, custom fields, and confirmation if removing existing fields. The mutation returns no value.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • Callers must have organization access and the todoTopic.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • topicIdidrequired

Body

Content-Type: application/json

  • revisionintegerrequired

    at least 0

  • 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

  • confirmFieldRemovalboolean

    default false

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/fields' \
  --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

No response body is specified.

What else happens

  • On success, the topic's customFields are updated and its revision is increased by one.
  • After a successful update that removes existing fields, the endpoint queues common.deleteCustomFieldsFromEntities on DefaultQueue to remove those fields from todos using the topic.

Errors

Other errors

StatusErrorWhen
400Confirm the removal of existing Todo fields.If existing fields are removed without confirmFieldRemoval, the endpoint returns HTTP 400 with key routes.misc.todo.topics.confirmFieldRemoval.
400Required fields cannot be added or changed after Todos already use this topic.If a required field is added or a field's required setting changes to a truthy value while todos use the topic, the endpoint returns HTTP 400 with key routes.misc.todo.topics.requiredFieldWithExistingItems.
404The todo topic was not foundIf the topic is not found in the organization, the endpoint returns HTTP 404 with key routes.misc.todo.topics.notFound.
409This topic changed while you were editing it. Reload it and apply your changes again.If the supplied revision does not match the topic's revision, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed.
409This topic changed while you were editing it. Reload it and apply your changes again.If the topic no longer matches the expected revision when the update is applied, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed.

Errors nearly every request can meet are listed under Errors.