CueAPI
Get 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.

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 CueNextDelete a Cue →