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: 7addressType:required
- assignedType: stringFormat: email
Sales Rep Email requiredEmail 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.
- firstType: string
Name required - phoneType: string
Number required - allowType: boolean
Duplicate Homeowner Whether to allow creating a project for an existing homeowner
- batteryType: string
Model Number min length:1 - coType: object
Applicant Properties: 4Optional co-applicant to associate with the project
- electricType: numberFormat: float
Bill 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.
- emailType: stringFormat: email
- Properties: 2energyType: object
Audit - energyType: array of number 12…12Format: float
Consumption 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.
- energyType: array of number 12…12Format: float
Payment min:012 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.
- externalType: string
Project Id Required for organizations using external pricing; optional otherwise.
- inferType: boolean
Project Radius M 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.
- inverterType: string
Model Number min length:1 - lastType: string
Name - paymentType: "cash" or "financed" or "multi-financing"enum
Option Optional payment option for the project
- preselectedType: array of string 1… unique!enum
Equipment Types 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.valuessolarinverterbatterywindowdoorhvacinsulationwater-heatermpuroofev-charger - projectType: integer
Radius M min:15max:150Optional 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.
- projectType: stringenum
Type Sets the project type explicitly. Mutually exclusive with
preselectedEquipmentTypes.valuessolarbatterysolar+batteryhome-improvement - solarType: string
Panel Model Number min length:1 - teamType: stringFormat: uuid
Id Optional team ID to assign the project to
- utilityType: stringFormat: uuid
Bill Analysis Id Result from utility bill analysis endpoint (applicable when using energyConsumption)
- utmType: string
Campaign UTM campaign parameter for tracking marketing campaigns
- utmType: string
Content UTM content parameter for tracking marketing campaigns
- utmType: string
Medium UTM medium parameter for tracking marketing campaigns
- utmType: string
Source UTM source parameter for tracking marketing campaigns
- utmType: string
Term UTM term parameter for tracking marketing campaigns
- yearlyType: numberFormat: float
Consumption Ackwh 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.

