v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Designs

Run Proposal PDF Generation

Run a proposal pdf generation job on a design.


Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

post/tenants/{tenant_id}/designs/{design_id}/proposal_pdf_generation/run

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design is part of.

design_idstring uuid required

The ID of the design to generate proposal pdf from.

Request body

Example request

{
  "proposal_pdf_generation_job": {
    "timezone": "America/New_York"
  }
}

Response

Proposal PDF Generation job accepted.

Example response

{
  "proposal_pdf_generation_job": {
    "status": "succeeded"
  }
}