Update

Update

Update

Updates the commission for an existing installer on an account.

Request

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

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the installer.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of Installers

Body

Name
Required
Type
Description
userEmail
Text
Not supported on update. The linked user is fixed at create time and cannot be changed — if this is supplied at all (even matching the existing value), the request is rejected with a 400.
commission

Number
The commission rate, from 0 to 1 inclusive. Required on update — since it's the only field that can change, an update must supply it; omitting it is rejected rather than silently leaving the commission unchanged.
{
  "commission": 0.08
}

Remarks

Unlike every other table in this API, the label-equivalent field (userEmail) can never be changed after creation — only commission is mutable, and for that reason it must always be supplied on update.

Response

Headers

None

Status Code

Code
Description
200 OK
The installer was updated.
400 Bad Request
commission is missing or outside the 0-1 range, or userEmail was supplied.
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.
404 Not Found
No installer was found with that id for 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.