Create

Create

Create

Associates a user as an installer on an account.

Request

Method
URL
POST
 https://api.solatech-dos.com/lists/v1/accounts/{accountUniqueId}/installers 

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of Installers

Body

Name
Required
Type
Description
userEmail

Text
The email address of the user to associate as an installer. The user must already have access to this account. The API resolves this email to an internal user record server-side; the raw ID is never exposed in responses.
commission
Number
The commission rate, from 0 to 1 inclusive (e.g. 0.05 for 5%). Defaults to 0 if omitted.
{
  "userEmail": "john.smith@example.com",
  "commission": 0.1
}

Remarks

The supplied email must resolve to a user who already has access to this account; otherwise the request is rejected with a 400. commission must be between 0 and 1 inclusive if supplied.

Response

Headers

Location — the URL of the newly created installer.

Status Code

Code
Description
201 Created
The installer was created.
400 Bad Request
userEmail is missing/blank, commission is outside the 0-1 range, or the email could not be resolved to a user with access to this account.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API keys feature enabled, or the key lacks the required scope.
409 Conflict
That user is already an installer on this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the installer.
userEmail
Text
The resolved user's email address.
commission
Number
The commission rate.