Conditions

Update Condition

POST
/api/condition/update

Update a Condition by ID. Each update creates a new immutable revision.

Only the fields you provide are updated. Omit environment_ids, policy_ids, and metric_ids to preserve existing attachments; provide an empty array to clear the corresponding attachments.

Set state to Active to reactivate an inactive Condition.

Authorizations

  • Authorizationstringheaderrequired

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

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2026-06-01"

Body

application/json

  • idstring<uuid>required

  • namestring | null

  • 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