Skip to main content
Jobs

Schedule a pending service plan job

POST
/jobs/{id}/schedule
Authorizationstringheaderrequired

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

idstringrequired

Body

application/json
arrival_windowintegerdefault:0
Required range: 0 <= x <= 1440
assigned_tostring[]
Maximum array length: 20
crew_idinteger
Required range: 0 < x
duration_minutesinteger
Required range: 1 <= x <= 1440
is_anytimebooleandefault:false
notify_assigneesbooleandefault:false
notify_customerbooleandefault:false

Default false: the customer is not notified. Send true to notify them.

startstringrequired

Response

application/json

The scheduled job with its visits

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

amount_receivednumberrequired
balance_duenumberrequired
completed_atstring | nullrequired
created_atstring | nullrequired
customerobject | nullrequired
discountsobject[]required
first_visitobject | nullrequired

Start and end of the first visit; null when none is scheduled.

idstringrequired
in_progress_atstring | nullrequired
job_numberstring | nullrequired
line_itemsobject[]required
property_addressobjectrequired
sequenceinteger | nullrequired
service_plan_idstring | nullrequired

Null for one-time jobs.

statusenum<string>required
Available options: Unscheduled, Pending, Scheduled, In Progress, Completed, Cancelled
techniciansobject[]required
totalnumberrequired
updated_atstring | nullrequired
visit_idsinteger[]required
visitsobject[]