Operations
Operations

Update alert

Edit an alert rule, the threshold-tuning workflow. Pause/resume with `enabled`, drop a noisy trend rule to sensitivityPreset 'conservative' (or raise minBreaches / windowCalls to debounce), re-bound a threshold rule (condition + thresholdValue/Low/High), change direction, or repoint the rule onto a different metric. Pass only the fields to change. Requires workspace-admin rights, same as creating an alert (delivery can reach Slack/email).

POST
/operations/update_alert

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/operations/update_alert" \  -H "Content-Type: application/json" \  -d '{    "alertId": "string",    "agent": "string"  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}

Update settings POST

Update the agent's privacy and call settings in one call: recording and AI disclosure, PII scrubbing, call-data retention, telemetry content, call recording and whether it continues after a transfer (recordAfterTransfer), post-call analysis (which metrics run is set_metric_activation), the silence check-in, the timezone, phoneMatchLowRisk and the overflow number. Pass only the fields to change; null on a tri-state field inherits the workspace default. It clears readiness risks such as 'recording-disclosure-missing'. Call handling, answering hours, guardrails and the widget theme have their own tools: set_call_handling, set_answering_hours, set_safety_guardrails and set_widget_theme.

Update call alert POST

Update ANY call alert by id, a built-in reason alert (new_lead/urgent/missed/message_taken/booking/all_calls) or a free-form custom one. For a built-in row, name/description can still be edited, but its reason itself can never change and it can never be deleted, use `enabled: false` to turn it off (or set its recipient array(s), emailAddresses, smsNumbers, slackChannelIds, to an empty list to stop it firing on just that channel without disabling the whole alert). Every field besides `id` is optional; pass only what changed. Same {{variable}} token vocabulary as create_call_alert. SCOPE: this op moves the agent scope only when you ask it to. Send `agentIds` to replace the list, or `allAgents: true` to widen it to the whole workspace. Editing any other field leaves the scope untouched. That is the opposite of create_call_alert, which scopes a new alert to the agent you addressed.