Reference · Courses
Create a course
/v1/sites/{siteId}/coursesAdds a course to a site. The response is the course, with the code to use from then on.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Idempotency-KeyA value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.
string · at most 255 characters
Body
namerequiredThe course's name.
string · 1–200 characters
activeFalse to create it retired. Defaults to true.
boolean
holdByDefaultHold this course on the kitchen screens until it is fired. Defaults to false.
boolean
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
201 Created
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