Skip to main content
Portal guides provide guest information in published portal sessions. Published guide changes reach matching customer portals immediately.

​
Status

Guides can be draft, published, or archived. New guides start as draft unless you set status to published. Duplicate Portal Guide creates a draft copy. Restore Portal Guide also restores a guide as a draft.

​
Targeting

Use listingIds or listingGroupIds to limit a guide to matching properties. Use show_after_check_in_only to hide a published guide until the guest completes online check-in. Use visibility_boundary, { "amount", "unit": "minutes" | "hours" | "days" }, to show a guide only from that long before arrival. amount is a whole number of at least 1.

​
Ordering

Reorder Portal Guides sets the display order for all non-archived guides. Include each non-archived guide exactly once. Include its current expected_updated_at value.