Skip to main content
PATCH
Update a scheduled job

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The task id. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
title
string

1–200 characters.

prompt
string

1–8000 characters.

enabled
boolean

False parks the job without cancelling it.

targetChannel
string | null

null clears it.

scheduleKind
enum<string>

Switching kinds re-arms every target.

Available options:
once,
cron
runAt
string | null

ISO instant, or null.

cronExpr
string | null

Five-field cron expression, or null.

timezone
string | null

IANA zone, or null.

Response

Success.

data
object
required