Request a restaurant

Creates an onboarding request for one restaurant. The reservation software partner that serves the restaurant processes it; you track the result with Get a request.

POST /v1/bc/onboarding-requests
Authorization: Bearer <token>
Content-Type: application/json

Request body

Name	Type	Required	Notes
rms	string	yes	Reservation software code, as provided by Mozrest (for example ZENCHEF)
venueRmsId	string	yes	The restaurant's reference in that reservation software. Used to match the restaurant
venueBcId	string	yes	Your own reference for the restaurant. One request per venueBcId
venueName	string	yes	Restaurant name, shown to the reservation software partner
venueAddress	string	yes	Restaurant address, shown to the reservation software partner
notes	string	no	Free text for the reservation software partner

{
  "rms": "ZENCHEF",
  "venueRmsId": "12345",
  "venueBcId": "voice-restaurant-77",
  "venueName": "Trattoria da Mario",
  "venueAddress": "12 Rue de la Paix, 75002 Paris",
  "notes": "Caller asked for the Paris branch"
}

Response - 200 OK

{
  "id": "7f1c2a9e-5d1b-4c0e-9f3a-2b8d6e4c1a90",
  "reference": "A1B2C3D4",
  "status": "pending",
  "rms": {"code": "ZENCHEF", "name": "Zenchef"},
  "venueRmsId": "12345",
  "venueBcId": "voice-restaurant-77",
  "venueName": "Trattoria da Mario",
  "venueAddress": "12 Rue de la Paix, 75002 Paris",
  "notes": "Caller asked for the Paris branch",
  "referenceMatched": true,
  "venue": {"id": "60e5a3ed409541da3650bd90", "name": "Trattoria da Mario"},
  "rejectReason": null,
  "requestedAt": "2026-10-29T10:12:00+00:00",
  "liveAt": null,
  "rejectedAt": null,
  "updatedAt": "2026-10-29T10:12:00+00:00"
}

Field	Meaning
id	Request identifier, use it with Get a request
reference	Short reference shared with the reservation software partner
status	pending, live, rejected or closed, see Getting started
referenceMatched	true when venueRmsId matched a restaurant. false means the request was accepted and the reservation software partner resolves the reference by hand
venue	The matched restaurant, null until matched. venue.id is the identifier used by the Booking Channel API once the request is live

Errors

Code	When
400	A required field is missing (form.errors lists them), or a request already exists for this venueBcId or for this restaurant on this software (the message carries the existing reference)
403	The software is not available to your channel, see Errors
404	Unknown rms code