Update flag rules | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.features.updateFlagRules("flag_id", {
        rules: [
            {
                conditionGroups: [
                    {
                        conditions: [
                            {
                                conditionType: "company",
                                operator: "eq",
                                resourceIds: [
                                    "company_12345",
                                ],
                            },
                        ],
                    },
                ],
                conditions: [
                    {
                        conditionType: "company",
                        operator: "eq",
                        resourceIds: [
                            "company_12345",
                        ],
                    },
                ],
                name: "Enable feature for VIP companies",
                priority: 10,
                value: true,
            },
        ],
    });
}
main();

{
  "data": {
    "rules": [
      {
        "condition_groups": [
          {
            "conditions": [
              {
                "condition_type": "company",
                "created_at": "2024-01-15T09:30:00Z",
                "environment_id": "env_prod",
                "id": "cond_2001",
                "operator": "gte",
                "resource_ids": [
                  "company_12345"
                ],
                "resources": [
                  {
                    "id": "company_12345",
                    "name": "Acme Corp",
                    "description": "VIP customer company",
                    "image_url": "https://example.com/images/company_12345.png"
                  }
                ],
                "rule_id": "rule_3001",
                "trait_value": "true",
                "updated_at": "2024-01-15T09:30:00Z",
                "comparison_trait": {
                  "created_at": "2023-12-01T08:00:00Z",
                  "display_name": "Is VIP Customer",
                  "entity_type": "company",
                  "hierarchy": [
                    "company",
                    "enterprise"
                  ],
                  "id": "trait_001",
                  "trait_type": "boolean",
                  "updated_at": "2024-01-10T12:00:00Z"
                },
                "comparison_trait_id": "trait_002",
                "condition_group_id": "cg_1001",
                "event_subtype": "subscription_upgrade",
                "flag_id": "flag_54321",
                "metric_period": "all_time",
                "metric_period_month_reset": "first_of_month",
                "metric_value": 100,
                "trait": {
                  "created_at": "2023-12-01T08:00:00Z",
                  "display_name": "Is VIP Customer",
                  "entity_type": "company",
                  "hierarchy": [
                    "company",
                    "enterprise"
                  ],
                  "id": "trait_001",
                  "trait_type": "boolean",
                  "updated_at": "2024-01-10T12:00:00Z"
                },
                "trait_entity_type": "company",
                "trait_id": "trait_001"
              }
            ],
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "env_prod",
            "id": "cg_1001",
            "rule_id": "rule_3001",
            "updated_at": "2024-01-15T09:30:00Z",
            "flag_id": "flag_54321"
          }
        ],
        "conditions": [
          {
            "condition_type": "company",
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "env_prod",
            "id": "cond_2002",
            "operator": "gte",
            "resource_ids": [
              "company_12345"
            ],
            "resources": [
              {
                "id": "company_12345",
                "name": "Acme Corp",
                "description": "VIP customer company",
                "image_url": "https://example.com/images/company_12345.png"
              }
            ],
            "rule_id": "rule_3001",
            "trait_value": "true",
            "updated_at": "2024-01-15T09:30:00Z",
            "comparison_trait": {
              "created_at": "2023-12-01T08:00:00Z",
              "display_name": "Is VIP Customer",
              "entity_type": "company",
              "hierarchy": [
                "company",
                "enterprise"
              ],
              "id": "trait_001",
              "trait_type": "boolean",
              "updated_at": "2024-01-10T12:00:00Z"
            },
            "comparison_trait_id": "trait_002",
            "condition_group_id": "cg_1001",
            "event_subtype": "subscription_upgrade",
            "flag_id": "flag_54321",
            "metric_period": "all_time",
            "metric_period_month_reset": "first_of_month",
            "metric_value": 100,
            "trait": {
              "created_at": "2023-12-01T08:00:00Z",
              "display_name": "Is VIP Customer",
              "entity_type": "company",
              "hierarchy": [
                "company",
                "enterprise"
              ],
              "id": "trait_001",
              "trait_type": "boolean",
              "updated_at": "2024-01-10T12:00:00Z"
            },
            "trait_entity_type": "company",
            "trait_id": "trait_001"
          }
        ],
        "created_at": "2024-01-15T09:30:00Z",
        "environment_id": "env_prod",
        "id": "rule_3001",
        "name": "VIP Company Rule",
        "priority": 10,
        "rule_type": "standard",
        "updated_at": "2024-01-15T09:30:00Z",
        "value": true,
        "flag_id": "flag_54321"
      }
    ],
    "flag": {
      "created_at": "2024-01-15T09:30:00Z",
      "default_value": false,
      "description": "Feature flag to enable new dashboard UI",
      "flag_type": "boolean",
      "id": "flag_54321",
      "key": "new_dashboard_ui",
      "name": "New Dashboard UI Flag",
      "updated_at": "2024-01-15T09:30:00Z",
      "feature_id": "feature_98765",
      "maintainer_id": "user_112233"
    }
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

flag_idstringRequired

flag_id

Request

This endpoint expects an object.

ruleslist of objectsRequired

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error