Overview
A portal is the page that a guest opens before a stay. Its content comes from workspace configuration that you manage through API methods:Verification rules
What has to be collected or signed before check-in. Deposits, agreements, arrival details, questions.
Offers
The things that can be bought or requested. Late checkout, mid-stay clean, airport pickup.
Templates
The page itself: branding, layout blocks, and which offers appear where.
Guides
Published guest information that can appear in matching portals.
Brand kit
Workspace branding defaults for future portal sessions.
Sessions
Guest progress, submitted check-in fields, orders, tickets, and stored assets.
Before you start
All timestamps are epoch milliseconds. All money is whole cents (
25000 is $250.00) paired with a lowercase currency code.End to end
Build a portal with a deposit for long stays:1
Create the offers
Use Create Portal Offer for each item. Keep each returned
id.2
Create the verification rules
Use Create Verification Rule for the deposit and arrival details. New rules are enabled and appended.
3
Fix the order
Use Reorder Verification Rules. Put specific rules above general rules.
4
Build the template
Use Create Portal Template. Reference the offer IDs from step 1 in
layout.5
Activate
Use Update Portal Template with
status: "active" and the current expected_version.API methods
Errors
Read the current value before you retry a
409 response. A retry with the same lock value fails again.