Brand profile
update_brand_profile write
Section titled “update_brand_profile ”Update the restaurant’s public profile — the same fields as the dashboard ‘Restaurant settings’ + ‘Look & feel’ pages. Use this when an owner says things like ‘change our name to …’, ‘update our phone number’, ‘set our timezone to Sydney’, ‘change the About paragraph’, ‘update the phone greeting’, or ‘make our brand colour …’. Pass ONLY the fields you want to change. To change the LOGO or BANNER image, use set_brand_image instead. (Opening hours are edited separately.)
Required scope: brand.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug (e.g. ‘il-caminetto’). Optional in JWT mode (auto-resolved); required in API-key mode when the key grants multiple brands. |
name |
string | no | Public display name of the restaurant. |
description |
string | no | Short “About” paragraph shown on the public booking page (≤500 chars). |
contactNumber |
string | no | Public contact phone number. |
address |
string | no | Physical street address. |
websiteUrl |
string | no | Website URL. |
timezone |
string | no | IANA timezone (e.g. ‘Australia/Sydney’). Changing it re-anchors existing reservations to the new local day. |
language |
string | no | Default language code, ISO 639-1 (e.g. ‘en’). |
welcomeMessage |
string | no | Phone-call greeting. Supports {{customer_name}} and {{restaurant_name}} variables. |
primaryColor |
string | no | Brand primary colour as a hex code (e.g. “#B91C1C”) — used by the booking page, menu, and widget. |
idempotencyKey |
string | no | Optional dedup key (UUID); a retry within 24h returns the original result. |
set_brand_image write
Section titled “set_brand_image ”Set the restaurant’s LOGO or BANNER image from a public image URL. Use this when an owner says ‘update our logo’ or ‘change the cover photo’ and gives you a link. Pass target=‘logo’ or ‘banner’ and a direct URL to a JPEG, PNG, or WebP (≤10MB). We download the image, host it on our own CDN, and set it on the brand — you don’t need to upload a file.
Required scope: brand.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |
target |
enum | yes | Which image to set: ‘logo’ (the round brand mark) or ‘banner’ (the wide cover photo). |
imageUrl |
string | yes | Direct, publicly-reachable URL to a JPEG/PNG/WebP image (≤10MB). |
idempotencyKey |
string | no |