Skip to main content
POST
cURL
Guide: Embedded domain connect. Errors: Errors and limits.

Authorizations

Authorization
string
header
required

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

Body

application/json
domain
string
required

The domain the restaurant connects. An existing domain of your workspace is reused.

Example:

"pizzeria-mario.example"

role
enum<string>
default:transactional

Role if the domain is added now.

Available options:
transactional,
marketing
tenant
string

Your reference for the restaurant. Sent back in every popup event.

Example:

"restaurant_4812"

locale
enum<string>
default:en
Available options:
en,
it
returnUrl
string

Where "Continue" goes when the popup is opened as a full page. Must be on an allowed origin.

Example:

"https://app.example.com/settings/email"

poweredBy
boolean
default:true

Show the small Minimo line in the popup footer.

expiresInMinutes
integer
default:30

Session lifetime.

Required range: 5 <= x <= 60

Response

The popup URL

data
object