Enable a schedule

Enables a schedule and registers it with pg_cron. The schedule must belong to the authenticated user’s organization. If the schedule is already enabled, this operation is idempotent.

PATCH /utils/schedules/{schedule_id}/enable

Enable a schedule

cURL

curl --request PATCH \
  --url https://api.example.com/utils/schedules/{schedule_id}/enable \
  --header 'Authorization: Bearer <token>'

200

{
  "schedule_id": "<string>",
  "schedule_name": "<string>",
  "schedule": {
    "type": "<string>",
    "cron": "<string>",
    "timezone": "<string>"
  },
  "reference_id": "<string>",
  "config": {
    "type": "<string>",
    "topic": "<string>",
    "extra_data": {}
  },
  "enabled": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Project-ID · string | null

Path Parameters

schedule_id · string · required

ID of the schedule to enable

Response

200

application/json

Successful Response

Response body for a schedule.

Schedule values are returned in their original timezone for user-friendly display.

schedule_id · string · required

ID of the schedule

schedule_name · string · required

Unique human readable name for the schedule

schedule · CronScheduleResponse · object · required

Cron-based schedule response with timezone-aware values.

The cron expression is dynamically converted from UTC back to the original timezone specified by the user for display purposes.

CronScheduleResponse

OneOffScheduleResponse

Show child attributes

reference_id · string · required

Reference ID (e.g. workflow config ID) held in Data Readiness resources

config · NotificationConfig · object · required

Schedule configuration (currently only NOTIFICATION is supported)

Show child attributes

enabled · boolean · required

Whether the schedule is ready to be triggered