Update business object

PUT 
/v2/illuminate/business-objects/:id

Updates an existing business object.

Warning: While isActive: true, you can change only name and description. To add or remove fields, set isActive: false first.

Warning: Deactivating a Business Object pauses data collection immediately. Any active decisions using this Business Object must be deactivated first.

Field behavior on PUT

FieldPUT behavior
fields[].idRequired for existing fields — omitting an existing field deletes it. Omit id only for new fields being added.
isActiveSet to false to deactivate; set to true to re-activate (requires at least one subkey)
subkeysMust have at least one entry to set isActive: true

Common errors

CodeCondition
400Modifying fields while isActive: true
400Setting isActive: true with empty subkeys array
400Deactivating while associated decisions are still active

Request​

Example
{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedBy": "string",
  "id": "string",
  "name": "string",
  "isActive": false,
  "description": "string",
  "fields": [
    {
      "id": "string",
      "name": "string",
      "jsonPath": "string",
      "jsonFieldType": "TEXT",
      "isKeyset": false,
      "source": "JSONPATH",
      "derivation": {
        "operation": "TIME_DIFF",
        "params": {}
      }
    }
  ],
  "accountId": "string",
  "subkeys": [
    "string"
  ],
  "metrics": [
    {
      "id": "string",
      "name": "string",
      "measureId": "string",
      "businessObjectId": "string",
      "evaluationWindow": 0,
      "function": "string",
      "dimensionIds": [
        "string"
      ],
      "dimensions": [
        {}
      ],
      "filters": [
        {}
      ]
    }
  ],
  "decisions": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "string",
      "updatedBy": "string",
      "id": "string",
      "name": "string",
      "description": "string",
      "accountId": "string",
      "businessObjectId": "string",
      "sourceType": "BUSINESSOBJECT",
      "sourceId": "string",
      "hitType": "SINGLE",
      "enabled": false,
      "activeFrom": "2024-01-01T00:00:00.000Z",
      "activeUntil": "2024-01-01T00:00:00.000Z",
      "executeOnce": false,
      "executionFrequency": 0,
      "inputFields": [
        {}
      ],
      "outputFields": [
        {}
      ],
      "rules": [
        {}
      ],
      "actions": [
        {}
      ],
      "metric": {
        "id": "string",
        "name": "string",
        "measureId": "string",
        "businessObjectId": "string",
        "evaluationWindow": 0,
        "function": "string",
        "dimensionIds": [],
        "dimensions": [],
        "filters": []
      },
      "query": {
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "createdBy": "string",
        "updatedBy": "string",
        "decisions": [],
        "customer": {},
        "businessObjects": [],
        "id": "string",
        "name": "string",
        "description": "string",
        "definition": {},
        "template": "string",
        "accountId": "string"
      },
      "customer": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "dashboards": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "string",
      "updatedBy": "string",
      "id": "string",
      "name": "string",
      "accountId": "string",
      "dateRange": "30 minutes",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-01-01T00:00:00.000Z",
      "charts": [
        {}
      ],
      "customer": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "queries": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "string",
      "updatedBy": "string",
      "decisions": [
        {}
      ],
      "customer": {
        "id": "string",
        "name": "string"
      },
      "businessObjects": [],
      "id": "string",
      "name": "string",
      "description": "string",
      "definition": {
        "version": "2.0",
        "pipeline": {},
        "meta": {}
      },
      "template": "string",
      "accountId": "string"
    }
  ],
  "customers": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}