Skip to main content
PATCH
Update partially routing schedule by ID

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

scheduleId
string
required

Unique identifier of the routing schedule, generated by the system. Example: 66f0a1b2c3d4e5f600000001

Body

application/json

Any subset of the schedule fields. Repetition fields are best sent together, because the timetable is rebuilt from them.

configurationId
string

The Configuration Profile every run of this schedule uses. The hub and the vehicles of the run are taken from this profile, so neither is sent here. Editing the profile changes the next run without editing the schedule. Example: 65c3a1b2c3d4e5f600000009

name
string

Name of the schedule. It is also the prefix of the name given to every routing result the schedule produces. Example: Morning Routing Jakarta

autoDispatch
boolean
default:false

When true, every vehicle on the optimized result is dispatched to its field user as soon as the optimization finishes. When false, the result waits in Routing → Result for a manual dispatch.

periode
enum<string>

How often the schedule repeats. Example: daily

Available options:
daily,
weekly,
monthly,
byDate,
custom
frequency
enum<string>

Unit the interval counts, required when periode is custom and ignored otherwise. Example: monthly

Available options:
daily,
weekly,
monthly
interval
integer

How many frequency units pass between two runs, required when periode is custom and ignored otherwise. 2 with a monthly frequency means every second month. Example: 2

Required range: 1 <= x <= 99
startTime
string

Start of the active window, in Y-m-d H:i format. The schedule does not run before it. Not used when periode is byDate, because those entries already carry absolute dates. Example: 2026-09-10 00:00

endTime
string

End of the active window, in Y-m-d H:i format. The schedule stops running after it. Not used when periode is byDate. Example: 2026-12-31 23:59

schedules
object[]

Repetition entries for this schedule. Every entry carries at least one time value in H:i format.

Response

Success

status
boolean

Shows if the request was successful.

message
string

Message of API response.

data
object

The routing schedule document.