Update a configuration

​

Updates a configuration's top-level fields — name, description, and is_active — without resending the whole document. This is the endpoint to park or retire a configuration (is_active: false removes it from selection for new sessions without deleting it) or bring it back. To change the operators or actions, use replace (PUT). Renaming to a name already in use returns 409.

Required scope: intelligence:write

Path Parameters
  • uuid
    Type: string · Uuid
    required

    The configuration's stable uuid — unchanged across version bumps and edits.

Body·
required
application/json

Partial update of a configuration's top-level fields. Omitted fields are left unchanged.

  • description
    Type: string · Descriptionnullable

    New description.

  • is_active
    Type: boolean · Is Activenullable

    Set false to park or retire the configuration (it stops being selectable for new sessions).

  • name
    Type: string · Namenullable

    New human label (must stay unique within your account).

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/configurations/{uuid}
curl 'https://api.simwood.com/intelligence/v1/configurations/{uuid}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "description": "",
  "is_active": true
}'

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "version": 1,
  "template_id": 1,
  "is_active": true,
  "sync_state": "live",
  "created_at": "string",
  "updated_at": "string",
  "operators": [
    {
      "name": "string",
      "version": 1,
      "current_version": 1,
      "upgrade_available": false,
      "output_type": "string",
      "model_tier": "string",
      "granularity": {
        "additionalProperty": "anything"
      },
      "context_window": 1,
      "include_prior_results": false,
      "prior_results_window": 3,
      "include_operator_results": [
        "string"
      ],
      "operator_results_window": 1,
      "parameters": {
        "additionalProperty": "anything"
      }
    }
  ],
  "actions": [
    {
      "additionalProperty": "anything"
    }
  ]
}

Successful Response

Simwood API Documentation