Your API key:

All requests below will use this key. Your API key is sent directly to api.cueapi.ai and never stored by the docs site.

PATCH/v1/cues/{cue_id}

Update Cue

Partially update a cue. Pause, resume, reschedule, or update the payload.

cue_idstringrequiredpath

The cue ID (format: cue_xxxxxxxxxxxx).

statusstringbody

Set to "active" (resume) or "paused" (pause). Only these two values are accepted.

namestringbody

Update the cue name.

scheduleobjectbody

Update the schedule (cron, at, timezone).

callbackobjectbody

Update the callback URL, method, or headers.

payloadobjectbody

Update the payload.

descriptionstringbody

Update the description.

deliveryobjectbody

Two-phase delivery configuration.

timeout_seconds (integer, default: 30) - How long to wait for HTTP 200 ACK (1-3600)
outcome_deadline_seconds (integer, default: 300) - How long to wait for outcome report after ACK (1-3600)

alertsobjectbody

Proactive alerting configuration.

consecutive_failures (integer, default: 3) - Alert after N consecutive failures (1-100)
missed_window_multiplier (integer, default: 2) - Alert when no success in schedule interval x N (1-10)

catch_upstringdefault: run_once_if_missedbody

Behavior when executions are missed during downtime. One of:

skip_missed - Fast-forward to next future window, create no backfill executions
run_once_if_missed - Run once to catch up, then resume normal schedule (default)
replay_all_missed - Create executions for every missed window (capped at 100)

verificationobjectbody

Outcome verification policy. Controls what evidence is required for an outcome to be marked verified_success.

mode (string, default: "none") - One of: none, require_external_id, require_result_url, require_artifacts, manual

Warning

Unknown fields are rejected with 422 Unprocessable Entity. Only send fields you want to change.

Request

bash

curl -X PATCH https://api.cueapi.ai/v1/cues/cue_a1b2c3d4e5f6 \
  -H "Authorization: Bearer cue_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

bash

curl -X PATCH https://api.cueapi.ai/v1/cues/cue_a1b2c3d4e5f6 \
  -H "Authorization: Bearer cue_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'

bash

curl -X PATCH https://api.cueapi.ai/v1/cues/cue_a1b2c3d4e5f6 \
  -H "Authorization: Bearer cue_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"schedule": {"cron": "0 10 * * *"}}'

Response

json

{
  "id": "cue_a1b2c3d4e5f6",
  "name": "daily-sync",
  "status": "paused",
  "next_run": null,
  "schedule": {
    "type": "recurring",
    "cron": "0 9 * * *",
    "timezone": "UTC"
  }
}

json

{
  "detail": [
    {
      "type": "extra_forbidden",
      "msg": "Extra inputs are not permitted",
      "input": "worker"
    }
  ]
}

PATCH/v1/cues/{cue_id}

Try it

Replace path parameters (e.g. {cue_id}) in the URL before sending.

Request Body

Enter your API key above to send requests

Previous← Get a Cue NextDelete a Cue →