Create customer group

Create a customer group. A manual group needs only a name; customers are assigned to it by the manual_groups field of a customer. An automatic group needs at least one condition; customers are added to it and removed from it by the periodic recalculation, not at the moment of creation. A name that another group of the company already has is refused, so a repeated request does not create a second group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255

Must differ from the names of the other customer groups of the company; letter case is not taken into account.

string
enum
Defaults to manual

manual: customers are assigned by the manual_groups field of a customer. auto: customers are added and removed by the conditions.

Allowed:
date | null

Automatic groups only. First day the conditions are applied; defaults to the current date. Always null for a manual group.

date | null

Automatic groups only. The day the group expires: its conditions are no longer applied from the start of this day. Must be later than start_date and than the current date; null means no end date. Always null for a manual group.

conditions
array of objects

Automatic groups only, at least one, each type at most once. Always empty for a manual group.

conditions
Responses

400

Body is not a JSON object

422

Validation failed

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json