Add services to a round
const url = 'https://example.com/service-schedules/round';const options = { method: 'POST', headers: { cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>', 'Content-Type': 'application/json' }, body: '{"scheduleIds":["019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"],"date":"2026-03-01","roundId":"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/service-schedules/round \ --header 'Content-Type: application/json' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \ --data '{ "scheduleIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "date": "2026-03-01", "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }'Books each service for the day: one order for each door, with no lines, wanted that day and carrying every service booked there in its notes. With roundId each order goes on that round, which must be on the same day and not finished; with null they wait for a round that day, and Plan day picks them up. A service already on an open order, a tracked item no customer holds, and an item with no address in use are skipped and listed. An order that could not go on the round is listed in notMoved and waits for a round that day. Refused while a person is planning that day’s rounds, for an API key or connected app.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Example
2026-03-01UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fResponses
Section titled “Responses”What was booked, and what was skipped and why
object
object
UUID v7
Not_found: no such service. booked: already on an open order. no_customer: a tracked item no customer holds. no_address: the item’s address is removed, or the customer has no address.
Example
{ "orderIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "notMoved": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "booked": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "skipped": [ { "scheduleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "reason": "not_found" } ]}Not signed in
object
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Equipment servicing
object
Example
{ "error": "not_found", "message": "Customer not found"}Not found, or Equipment servicing is not available to this business
object
Example
{ "error": "not_found", "message": "Customer not found"}Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up
object
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
object
object
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}