Skip to main content
POST
cURL
Guide: Widget sessions. 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
tenant
string
required

Your reference for the restaurant. 1 to 64 letters, digits, . _ : -. The same value as tenant on the send endpoints.

Example:

"restaurant_4812"

tenantName
string

Name shown in the widgets.

Example:

"Trattoria da Mario"

permissions
enum<string>[]

Widgets this session can open. Default: templates, campaigns, contacts, history, stats. brand and whatsapp are never in the default.

Available options:
templates,
campaigns,
contacts,
history,
stats,
brand,
whatsapp
locale
enum<string>
default:en

Language of the widgets.

Available options:
en,
it
variables
object

Merge values of this restaurant (for example RESTAURANT_NAME, LOGO_URL), used in previews and in its campaigns. At most 30 keys, values up to 500 characters.

Example:
from
string

Sender of the restaurant's campaigns: "Name <address>" or an address under a verified domain of your workspace (422 otherwise). Default: your workspace sender.

Example:

"Trattoria da Mario <news@yoursaas.example>"

replyTo
string

Where guests' replies go: "Name <address>" or an address. Any mailbox. Default: the RESTAURANT_EMAIL variable when it is a valid address.

Maximum string length: 320
Example:

"Trattoria da Mario <owner@trattoriadamario.example>"

expiresInMinutes
integer
default:60

Session lifetime.

Required range: 5 <= x <= 720
poweredBy
boolean
default:true

Show the small Minimo line at the bottom of the widgets. false = no Minimo text in the widgets.

brand
object

Options of the Brand widget.

Response

The session and one URL per widget

data
object