Skip to main content
POST
Create a presentation

Authorizations

session
string
cookie
required

Session cookie obtained from POST /api/auth/login.

Path Parameters

deckId
string<uuid>
required

UUID of the deck

Body

application/json
homeowner
object
prospect_id
string<uuid>

Prospect to attach the presentation to. Alone, homeowner data is fetched from the prospect's journey; with homeowner, the prospect is attached and the supplied data is used as-is. Must be visible to your credential.

voice_settings
object
language_settings
object
price_inputs
object

Values for deck-level price variables (used to evaluate formulas). Optional — omitted variables result in deferred pricing rather than an error.

measurement_strategy
enum<string>
default:manual

Set to auto to resolve measurement-backed price variables from automated roof measurements instead of supplying them in price_inputs. Only variables referenced by a formula on the deck's product-pricing slides are deferred to measurements.

Available options:
manual,
auto

Response

Presentation created

deck_presentation_id
string<uuid>
url
string<uri>

Shareable presentation URL

status
enum<string>
Available options:
not_started,
pending,
processing,
ready,
failed