Conditions

Create Condition

POST
/api/condition/create

Create a Condition and attach it to Environments, Policies, and Metrics.

Use policy_ids for Policies and metric_ids for Metrics.

JSON

{
  "name": "EU users",
  "description": "Apply EU-specific Policies",
  "conditions": {
    "type": "group",
    "conditions": [
      {
        "type": "condition",
        "field": "user.region",
        "operator": "eq",
        "value": "eu"
      }
    ]
  },
  "environment_ids": ["your-environment-id"],
  "policy_ids": ["policy_pii"],
  "metric_ids": ["metric_quality"],
  "state": "Active"
}

See Conditions for the expression format and runtime selection behavior.

Authorizations

  • Authorizationstringheaderrequired

    API Key required. Format: Bearer wc-your-api-key

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2026-06-01"

Body

application/json

  • namestringrequired

  • descriptionstring | null

  • conditionsany

  • environment_idsstring[] | null

  • policy_idsstring[] | null

  • metric_idsstring[] | null

  • statenull | enum<string>

    Available options: Active, Inactive, Draft

Response

application/json

Success

  • idstring<uuid>required

  • revision_idstring<uuid>required

  • namestringrequired

  • descriptionstringrequired

  • conditionsanyrequired

  • stateenum<string>required

    Available options: Active, Inactive, Draft

  • created_atstring<date-time>required

  • updated_atstring<date-time>required

  • environment_idsstring[]required

  • policy_idsstring[]required

  • metric_idsstring[]required