Update Policy

curl -X PATCH https://api.vapi.ai/monitoring/policy/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "name": "High Error Rate Policy",
  "threshold": {
    "type": "percentage",
    "comparator": "gt",
    "value": 50
  },
  "lookbackWindowMinutes": 60,
  "severity": "error",
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "monitorIds": [
    "string"
  ],
  "schedule": {
    "second": 0,
    "minute": 30,
    "hour": 0,
    "dayOfMonth": [
      1,
      15
    ],
    "month": [
      "JANUARY",
      "APRIL",
      "JULY"
    ],
    "dayOfWeek": [
      "MONDAY",
      "WEDNESDAY",
      "FRIDAY"
    ],
    "year": 2025
  },
  "lastRunAt": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional<=100 characters

This is the name of the policy.

thresholdobjectOptional

This is the threshold configuration for the policy.

lookbackWindowMinutesdoubleOptional1-1440

This is the lookback window in minutes. The policy will query events from the last N minutes.

severityenumOptional

This is the severity level of issues created by this policy.

Allowed values:

scheduleobjectOptional

This is the schedule configuration for when the policy should run.

monitorIdslist of stringsOptional

These are the monitor IDs to associate with this policy. This creates entries in the monitor-policy join table.

Response

namestring<=100 characters

This is the name of the policy.

thresholdobject

This is the threshold configuration for the policy.

lookbackWindowMinutesdouble1-1440

This is the lookback window in minutes. The policy will query events from the last N minutes.

severityenum

This is the severity level of issues created by this policy.

Allowed values:

idstring

This is the unique identifier for the policy.

orgIdstring

This is the unique identifier for the org that this policy belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the policy was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the policy was last updated.

monitorIdslist of strings or null

These are the monitor IDs associated with this policy. This is only present when retrieving a single policy by ID.

scheduleobject or null

This is the schedule configuration for when the policy should run.

lastRunAtdatetime or null

This is the ISO 8601 date-time string of when the policy was last run.