Customer Groups (beta)

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

GET/1/customer-groups

List Customer Groups

Authorization
User sessionAPI credential
Permissions
customer-groups:read
OAuth
-
Request
Query parameters2
limitinteger
skipinteger
Responses
200Customer Groups application/json
dataCustomerGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersCustomerGroupFilter[]REQUIRED
itemsCustomerGroupFilterItem[]REQUIRED
labelstring
valuestringREQUIRED
typestringREQUIRED
ACCOUNTINFRA_PROVIDER_IDINTERNAL_TOKENISSUER_NAMETOKEN_BILLING_PLANUIDUNSPECIFIEDUSERVISUAL_NUMBER
valuesstring[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/customer-groups

Create Customer Group

Authorization
User sessionAPI credential
Permissions
customer-groups:write
OAuth
-
Request
Request bodyapplication/json
descriptionstring
filtersobject[]REQUIRED
itemsobject[]
labelstring
valuestringREQUIRED
typestringREQUIRED
ACCOUNTINFRA_PROVIDER_IDINTERNAL_TOKENISSUER_NAMETOKEN_BILLING_PLANUIDUSERVISUAL_NUMBER
valuesstring[]REQUIRED
labelstringREQUIRED
Responses
201Created text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/customer-groups/search

Search Customer Groups

Authorization
User sessionAPI credential
Permissions
customer-groups:read
OAuth
-
Request
Request bodyapplication/json
createdAtobject
$gtestring <date-time>
$ltestring <date-time>
filterTypestring[]
idsstring[]
limitinteger
default 50min 1
querystring
skipinteger
default 0min 0
Responses
200Customer Groups application/json
dataCustomerGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersCustomerGroupFilter[]REQUIRED
itemsCustomerGroupFilterItem[]REQUIRED
labelstring
valuestringREQUIRED
typestringREQUIRED
ACCOUNTINFRA_PROVIDER_IDINTERNAL_TOKENISSUER_NAMETOKEN_BILLING_PLANUIDUNSPECIFIEDUSERVISUAL_NUMBER
valuesstring[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PUT/1/customer-groups/{id}

Update Customer Group

Authorization
User sessionAPI credential
Permissions
customer-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
descriptionstring
filtersobject[]REQUIRED
itemsobject[]
labelstring
valuestringREQUIRED
typestringREQUIRED
ACCOUNTINFRA_PROVIDER_IDINTERNAL_TOKENISSUER_NAMETOKEN_BILLING_PLANUIDUSERVISUAL_NUMBER
valuesstring[]REQUIRED
idstring
labelstringREQUIRED
Responses
204Updated text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/customer-groups/{id}

Delete Customer Group

Authorization
User sessionAPI credential
Permissions
customer-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204Deleted text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED