CreateProjectRequest

Include at most one of projectType or preselectedEquipmentTypes. Sending both returns a validation error. If neither is sent, the project is created as a default solar project.

  • Properties: 7
  • Email of the sales rep to assign to this project. Must match an existing user in your organization. Can be changed later via PUT /external/v1/projects/:id.

  • Whether to allow creating a project for an existing homeowner

  • Optional co-applicant to associate with the project

    Properties: 4
  • Monthly electric bill amount. Required (along with the other three bill / consumption fields, exactly one of which must be supplied) for solar / battery projects. Optional for home-improvement / roof-only projects — defaults to 400 when omitted.

  • Properties: 2
  • 12 months of consumption in kWh. Required (along with the other three bill / consumption fields, exactly one of which must be supplied) for solar / battery projects. Optional for home-improvement / roof-only projects.

  • 12 months of utility payment amounts. Required (along with the other three bill / consumption fields, exactly one of which must be supplied) for solar / battery projects. Optional for home-improvement / roof-only projects.

  • Required for organizations using external pricing; optional otherwise.

  • When true and projectRadiusM is omitted, infer the radius from available parcel geometry before applying the organization's radius limit. If parcel geometry is unavailable or invalid, Artemis uses 20.

  • Optional payment option for the project

  • Equipment categories used to infer project type (for example solar and battery together imply a solar+battery project) and to add default home-improvement equipment when home-improvement types are included. Each value must be unique. Mutually exclusive with projectType.

    values
    solarinverterbatterywindowdoorhvacinsulationwater-heatermpuroofev-charger
  • Optional parcel radius in meters. The default organization limit is 15-40; organizations with giant parcel size enabled may use up to 150. When omitted, Artemis uses 20 unless inferProjectRadiusM is true.

  • Sets the project type explicitly. Mutually exclusive with preselectedEquipmentTypes.

    values
    solarbatterysolar+batteryhome-improvement
  • Optional team ID to assign the project to

  • Result from utility bill analysis endpoint (applicable when using energyConsumption)

  • UTM campaign parameter for tracking marketing campaigns

  • UTM content parameter for tracking marketing campaigns

  • UTM medium parameter for tracking marketing campaigns

  • UTM source parameter for tracking marketing campaigns

  • UTM term parameter for tracking marketing campaigns

  • Yearly consumption in AC kWh. Required (along with the other three bill / consumption fields, exactly one of which must be supplied) for solar / battery projects. Optional for home-improvement / roof-only projects.