A template defines a portal page. It contains branding, a header, an ordered layout, and checkout behavior.
Status and versioning
Templates can be draft, active, or paused. Use the archive and restore methods to manage archived templates. New templates start as draft unless you set another valid status.
Template updates use expected_version, an integer, instead of a timestamp.
Template changes do not affect existing portal sessions. Each session keeps the configuration snapshot that it started with.
Layout blocks
layout is an ordered array. Every block needs a unique id.
trustStrip items are secure_checkout, free_cancellation, verified_business, and powered_by_stripe.
Every offerId and each offerIds entry must reference an existing offer. Create offers before you create the template.
Creating a template
Call Create Portal Template with the portal configuration:
Colors are six-character hexadecimal values, with or without a leading #.
Other configuration
listing_data controls property data on the page. Each field has a Boolean value, and enabled controls all fields.
after_payment controls the post-purchase state. confirmation_message controls the follow-up message. smart_lock enables the lock integration.
Lifecycle methods
Duplicate Portal Template creates a new draft.
Archive Portal Template and Restore Portal Template are reversible.
Delete Portal Template is permanent. It requires an exact confirm_name and a template with no recorded sales.