Update cron job

Partially update a cron job. Only provided fields are modified.

PATCH /api/captain/agents/{id}/cron/{jobId}

Update cron job

cURL

curl --request PATCH \
  --url http://localhost:63372/api/captain/agents/{id}/cron/{jobId} \
  --header 'Content-Type: application/json' \
  --cookie captain_session= \
  --data '
{
  "name": "<string>",
  "message": "<string>",
  "schedule": {
    "every": "24h",
    "cron": "0 0 9 * * 1-5 *",
    "at": "2025-12-31T09:00:00Z"
  },
  "delivery_connector": "<string>",
  "delivery_channel": "<string>"
}
'

200

{
  "ok": true
}

Authorizations

cookieAuthbearerAuth

captain_session · string · cookie · required

HMAC-signed session cookie returned by /api/captain/auth/login. Valid for 7 days. Invalidated when password changes.

Path Parameters

id · string · required

Agent ID

jobId · string · required

Cron job ID

Body

application/json

name · string

message · string

schedule · object

Exactly one of 'every', 'cron', or 'at' must be set.

Show child attributes

delivery_connector · string

delivery_channel · string

Response

200

application/json

Success

ok · boolean · required

Example:

true