Create Customer

POST /api/v1/customers/

Creates a customer, if requesting manager has access permissions to it.

Example request

Request body (application/json)

{
    "email": "[email protected]",
    "first_name": "Harry",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "[phone]",
    "reference": "ref123",
    "address": "Street 1",
    "postcode": "10000",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "customer_account": 1,
    "metadata": {}
}

Example responses

200

{
    "id": 4165,
    "total_orders": 0,
    "total_licenses": 0,
    "labels": [],
    "customer_account": null,
    "email": "[email protected]",
    "first_name": "Harry",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "[phone]",
    "reference": "ref123",
    "address": "Street 1",
    "postcode": "10000",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "clabels_all": null,
    "company": 277,
    "license_user": null,
    "clabels": [],
    "cognito_user_pool_id": ""
}

404

{
  "message": "Ain't no cake like that."
}

Request body parameters

Name	Type	Required	Description
email	string	optional	email
first_name	string	optional	first_name
last_name	string	optional	last_name
company_name	string	optional	company_name
phone	string	optional	phone
reference	string	optional	reference
address	string	optional	address
postcode	string	optional	postcode
city	string	optional	city
country	string	optional	country
state	string	optional	state
customer_account	integer	optional	integer
metadata	object	optional	JSON Object