Guards

Update Guard

Updates an existing guard by ID.

Only the fields provided in the request body will be updated.

Requires a token with the admin:write scope.

patch/api/guards

Request

  • Base URL: https://app.withwillow.ai
  • URL: https://app.withwillow.ai/api/guards
  • Auth: HTTP bearer

Query parameters

idstring required

The ID of the guard to update

Request body

namestring
slugstring
descriptionstring
thresholdnumber
action'redact' | 'warn' | 'warn_user' | 'block'
messagestring nullable

Message shown to the user when this guard blocks or warns a call. Set to null to clear it.

status'active' | 'draft'
scope'buildtime' | 'runtime'

Example request

{
  "checks": [
    {
      "id": "regex-email",
      "name": "Email Address",
      "certainty": 10
    }
  ]
}

Response

Guard updated successfully

Example response

{
  "data": {
    "id": "guard_abc123",
    "slug": "email-detection",
    "name": "Email Detection",
    "description": "Detects email addresses in content",
    "checks": [
      {
        "id": "regex-email",
        "name": "Email Address",
        "certainty": 10
      }
    ],
    "threshold": 5,
    "action": "warn",
    "status": "active",
    "created_at": "2026-01-15T09:30:00Z",
    "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated_at": "2026-01-15T09:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.