Create a new customer

Creates a customer and returns the details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The tenant url key.

Query Params
string

Optionally provide a site to send the registration email from.

Body Params

The customer details.

string
required

The preferred language (for emails etc.)

groupIds
array of uuids

The group ids this customer belongs to

groupIds
string

The unique customer number

boolean

Set to false in order to deactivate the customer, they will not be able to log in, defaults to true

string
enum

The type of customer (optional), can be personal or business

Allowed:
string
required

The email, must match regex .+@.+..+

string

Any notes

primaryAddress
object

ViewModel for a customer address

addresses
array of objects

Additional addresses

addresses
personalInfo
object

Personal information of the customer

optional
array of objects

Any optional fields

optional
newsletters
object

Settings for newsletter subscriptions

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

BadRequest

403

Forbidden

404

NotFound

409

The email already exists.

504

There was no timely response from downstream services.

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