Proposals

Create Proposal

Changed on

Creates a proposal for a design based on a proposal template provided.


[block:callout] { "type": "warning", "body": "If you are creating a proposal for a Partner-owned project, please ensure the proposal template used is assigned to that Partner." } [/block] [block:callout] { "type": "warning", "body": "Please ensure the proposal template you're using to create a proposal has been enabled." } [/block]

If a proposal template id is not provided, the proposal will be created from the default proposal template specified by the Administrator or Partner.

post/tenants/{tenant_id}/designs/{design_id}/proposals/default

Request

  • Base URL
    https://api-sandbox.aurorasolar.com
  • URL
    https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/designs/{design_id}/proposals/default
  • Auth
    HTTP bearer

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 create a default proposal for.

Request body

Example request

{
  "proposal": {
    "proposal_template_id": "YourId123"
  }
}

Response

Design Default Proposal successfully created.

Example response

{
  "proposal": {
    "proposal_link": "https://v2.aurorasolar.com/projects/ae98052f-9fed-40c9-a373-55f2aeaa6e87/designs/36a69994-6029-4835-8b1a-ab5fcb26bd18/document-proposal/9d7a162c-a287-4e0d-a026-5f3ea4821cfd"
  }
}

Changes