Reference · Courses
Update a course
PATCH
/v1/sites/{siteId}/courses/{code}Changes a course. Only the fields sent change. Nothing is deleted: retire it with active false.
Needs Catalogue: writeChanges live data
Path
siteIdrequiredThe site, from GET /v1/sites.
string
coderequiredThe record's code.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Body
activeFalse to retire it, true to bring it back.
boolean
holdByDefaultHold this course until it is fired, or start it on arrival.
boolean
nameA new name.
string · 1–200 characters
Responses
- bad_requestinvalid_cursoridempotency_key_required
- missing_keyinvalid_keykey_expired+1 more
- key_revokedassistant_keykey_without_access+7 more
- site_not_foundnot_found
- idempotency_key_reusedrequest_in_progress
- invalid_requestnot_a_modifier_group
- rate_limited
- server_error
- upstream_unavailable
200 OK
activerequiredFalse for a retired course.
boolean
coderequiredThe course's code.
string
holdByDefaultrequiredWhether the kitchen holds this course until it is fired, rather than starting it on arrival.
boolean
namerequiredThe course's name.
string
orderrequiredWhere the course comes, lowest first.
integer
updatedAtWhen the course last changed.
string · date-time