Present Proposal Layout

Changed on

Generates a PDF/HTML rendering of a proposal's layout. Requires the company's layout_template policy to be enabled, the estimate must have is_proposal: true, and have a layout association configured. Runs fully synchronously (PDF generation + upload happen in-request, no job queue).

If the proposal has already reached APPROVED or AWAIT_SIGNATURE, only proposal_options marked is_accepted: true are rendered (post-approval, present shows only the winning option).

send_buffer: true bypasses the normal JSON envelope entirely and returns raw HTML directly.

post/estimate/{estimate_uid}/present

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • Auth
    API key in header x-api-key

Path parameters

estimate_uidstring required

Request body

send_htmlboolean

Returns JSON with pages/meta populated instead of a signed PDF URL.

send_bufferboolean

Returns raw HTML (Content-Type: text/html) instead of the standard JSON response.

Response

200

statusboolean
typestring

Example response

{
  "status": true,
  "type": "success"
}

Changes