Skip to main content
PUT
cURL
Guide: Brand widget and tenant branding. Errors: Errors and limits.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant
string
required

Your reference for the customer (for example the restaurant id). 1 to 64 letters, digits, . _ : -.

Example:

"restaurant_4812"

Body

application/json

Only the fields you send are written. null clears a field.

displayName
string | null

Name the guests know. Shown on the unsubscribe and preferences pages.

Example:

"Trattoria da Mario"

logoUrl
string | null

Public https URL of the logo.

locale
string | null

Language of the restaurant's pages, for example it or it-IT.

Example:

"it"

Legal name of the data controller (the restaurant).

Example:

"Trattoria da Mario S.r.l."

address
string | null

Postal address of the data controller.

privacyUrl
string | null

Public https URL of the privacy policy.

website
string | null

Public https URL, up to 500 characters. Shown in the email footer.

Example:

"https://trattoriadamario.example"

phone
string | null

6 to 15 digits, up to 32 characters. Shown in the footer.

Example:

"+39 02 1234 5678"

email
string | null

Contact email shown in the footer.

Example:

"info@trattoriadamario.example"

socials
object | null

https links on their network (facebook.com, instagram.com, linkedin.com, x.com or twitter.com, youtube.com or youtu.be, tiktok.com). Only the keys you send are written; null clears one.

Example:
brandColor
string | null

Hex color #RRGGBB, not near-white. Used for the title band and buttons of your master templates sent for this restaurant.

Example:

"#1F5E5B"

Response

The saved profile

data
object