Skip to main content
PATCH
/
v1
/
monitoring
/
schedules
/
{id}
Update a schedule
curl --request PATCH \
  --url https://api.rightfoot.com/v1/monitoring/schedules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Weekly Balance Check",
  "interval_days": 7,
  "time_of_day": "14:30"
}
'
{
  "schedule_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Weekly Balance Check",
  "message": "Schedule updated successfully",
  "expires_at": "2025-03-15T00:00:00Z",
  "next_run_at": "2024-12-19T14:30:00Z"
}

​
Update Schedule

Modify the scheduling parameters of an existing scheduled balance request. You can update the interval, time of day, or expiration date.

​
Use Cases

  • Change how frequently balance checks run (e.g., from weekly to daily)
  • Adjust the time of day when scheduled checks execute
  • Extend or shorten the schedule’s expiration date

​
Request Fields

All fields are optional, but at least one must be provided.
FieldDescription
nameUpdate the schedule name. Must be unique. Max 255 characters
interval_daysUpdate how often the schedule runs (1-30 days)
time_of_dayUpdate the time to run in HH:mm format (24-hour, UTC). Example: “14:30” for 2:30 PM UTC
expires_atUpdate the schedule expiration date. A final job runs at this time, after which no more jobs will run. Must be in the future. ISO 8601 format

​
Response Fields

FieldDescription
schedule_idThe unique identifier for the schedule
nameThe name of the schedule, if one was provided
messageConfirmation message indicating the update was successful
expires_atThe updated expiration date for the schedule
next_run_atThe next scheduled run time. May be null if the schedule is disabled or completed

​
Important Notes

  • The schedule must be in ACTIVE status to be updated
  • At least one update field must be provided in the request
  • The expires_at value must be a future timestamp
  • If you provide a name that already exists for another schedule, a 409 Conflict error is returned

Authorizations

​
Authorization
string
header
required

Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Path Parameters

​
id
string<uuid>
required

The schedule ID (UUID) returned when creating the scheduled balance request.

Body

application/json
​
name
string

Update the schedule name. Must be unique. Max 255 characters.

Maximum string length: 255
​
interval_days
integer

Update the schedule to run every N days (1-30).

Required range: 1 <= x <= 30
​
time_of_day
string

Update the time of day to run in HH:mm format (24-hour, UTC).

​
expires_at
string<date-time>

Update the schedule expiration date. Must be in the future.

Response

Schedule updated successfully

​
schedule_id
string<uuid>

Unique identifier for the schedule.

​
name
string

The name of the schedule.

​
message
string

Confirmation message.

​
expires_at
string<date-time>

ISO 8601 timestamp when the schedule will expire.

​
next_run_at
string<date-time>

ISO 8601 timestamp of the next scheduled run.