Skip to main content
PATCH
/
v1
/
api
/
schedules
/
{id}
Update a schedule
curl --request PATCH \
  --url https://api.hq.zone/v1/api/schedules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": {},
  "trigger": {},
  "description": "<string>",
  "name": "<string>"
}
'
{
  "ok": true
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

id
string<uuid>
required

Schedule id

Body

application/json
args
object
required
trigger
object
required
description
string | null

null clears, omitted keeps current.

name
string | null

Response

Updated

ok
boolean
required