Create

Create

Create

Adds a customer type to an account.

Request

Method
URL
POST

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 AccountLists

Body

Name
Required
Type
Description
name

Text
The name of the customer type. Must not be empty and must be 32 characters or fewer.
active
Boolean
Indicates if the customer type is active or inactive. Defaults to true if omitted.
{
"name": "Retail",
"active": true
}

Remarks

name is required, cannot be empty, and cannot exceed 32 characters. If active is omitted, the customer type is created as active.
Customer type names must be unique per account. This is enforced by the API itself, not by a database constraint. Attempting to create a customer type with a name that already exists for the account will fail with a 409 conflict.

Response

Headers

Location — the URL of the newly created customer type.

Status Code

Code
Description
201 Created
The customer type was created.
400 Bad Request
The customer type was not created. This occurs if name is missing, 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.
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.