Update outlet

View as MarkdownOpen in Claude

Updates an existing outlet with new data received from the third-party POS system

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

outletIdstringRequired

Headers

X-Tenant-IDstringOptional
Tenant identifier

Request

This endpoint expects an object.
namestringRequired
externalIdstringRequired
internalNamestringRequired
addressobjectRequired
contactobjectRequired
timezonestringRequired
channelLinkIdstringRequired
locationIdstringRequired
visiblebooleanRequired

Response

OK
idstring
namestring
statusstring
externalIdstring
internalNamestring
slugstring
refCodestring
imageUrlstringformat: "uri"
addressobject
contactobject
isOpenboolean
isBusyboolean
visibleboolean
timezonestring
openingHourslist of objects
capabilitiesobject
locationIdstring
channelLinkIdstring
showStartDatetimedatetime
createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
404
Not Found Error