Onboard an installer

​

Provision an installer with an initial team, administrator and active pricing. It can send a login invitation to a new administrator and optionally dispatch an asynchronous demo project. Reuse the Idempotency-Key and identical externalId when retrying.

Headers

  • Unique for seven days. Reuse with the same body returns the original response.

Body

required
application/json
  • Properties: 4
  • Properties: 11
  • Properties: 2

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/external/v2/installer-onboarding
curl https://sales-api.artemis.solar/external/v2/installer-onboarding \
  --request POST \
  --header 'Idempotency-Key: installer-onboarding-1042' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_SECRET_TOKEN' \
  --data '{
  "externalId": "partner-installer-1042",
  "installer": {
    "name": "Example Solar",
    "companyEmail": "operations@example.com",
    "companyPhone": "+14155550125",
    "address": "123 Main St",
    "city": "Pleasanton",
    "state": "CA",
    "zipcode": "94566",
    "countryCode": "US"
  },
  "admin": {
    "email": "admin@example.com",
    "firstName": "Alex",
    "lastName": "Morgan"
  }
}'
Installer provisioned with admin and pricing
{
  "data": {
    "installerOnboardingId": "023e6e0c-b7b4-48ef-b54c-b1ed0fe441f2",
    "externalId": "partner-installer-1042",
    "status": "completed_with_warnings",
    "installer": {
      "id": "f7b7db62-29bf-4e70-bf73-a9221674f12a",
      "slug": "example-solar",
      "name": "Example Solar"
    },
    "teams": [
      {
        "id": "db064d91-6096-4e0f-a4ee-767671156d1d",
        "name": "Example Solar Direct",
        "type": "internal"
      }
    ],
    "admin": {
      "userId": "4a1d3a98-a137-4c0b-9574-ab789da3ac57",
      "email": "admin@example.com",
      "inviteSent": true
    },
    "pricing": {
      "pricingId": "d74df729-8b2f-4d7e-963c-1fe7d03bdb8d",
      "activePricingVersionId": "db56ef31-f229-4a86-ad8a-225281e36afd",
      "strategy": "starter",
      "markets": [
        "ALL"
      ]
    },
    "demoProject": null,
    "readiness": {
      "quote_ready": true,
      "financing_ready": false,
      "contract_ready": false,
      "fully_operational": false
    },
    "warnings": [
      {
        "code": "financing_not_configured",
        "scope": "financing",
        "message": "No lenders linked. Quoting works; financed payment options are unavailable.",
        "resolveWith": null
      }
    ]
  }
}