Update

Update

Update

Updates an existing customer type on an account.

Request

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

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the customer type.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
name
Text
The name of the customer type. If supplied, must not be empty and must be 32 characters or fewer. Omit to leave the current value unchanged.
active
Boolean
Indicates if the customer type is active or inactive. Omit to leave the current value unchanged.
{
  "active": false
}

Remarks

Every field in the body is optional. A field that is omitted from the request is left exactly as it is currently stored — it is not reset to a default value. Only fields that are explicitly supplied are validated and updated, using the same validation rules as create (name must not be empty and must be 32 characters or fewer). In the example above, only active is changed; the stored name value is left untouched.
Customer type names must be unique per account. This is enforced by the API itself, not by a database constraint, and still applies when a new name value is supplied on update.

Response

Headers

None

Status Code

Code
Description
200 OK
The updated customer type was returned.
400 Bad Request
The customer type was not updated. This occurs if name is supplied but is empty or longer than 32 characters.
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 does not have the required scope.
404 Not Found
No customer type was found with that id for this account.
409 Conflict
A customer type with that name already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the customer type.
name
Text
The name of the customer type.
active
Boolean
Indicates if the customer type is active or inactive.