Create Customer

3min
Creates a customer, if requesting manager has access permissions to it.
URL: /api/v1/customers/
Method: POST
Parameters:
email - String
first_name - String
last_name - String
company_name - String
phone - String
reference - String
address - String
postcode - String
city - String
country - String
state - String
customer_account - Integer
"metadata"-JSON object
Data Example:
JSON
{
    "email": "[email protected]",
    "first_name": "Harry",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "+385913111111",
    "reference": "ref123",
    "address": "Street 1",
    "postcode": "10000",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "customer_account": 1,
    "metadata": {}
}
{
    "email": "tc3@tc.com",
    "first_name": "Harry",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "+385913111111",
    "reference": "ref123",
    "address": "Street 1",
    "postcode": "10000",
    "city": "New York",
    "country": "US",
    "state": "NY",
    "customer_account": 1,
    "metadata": {}
}
﻿
Success Response:
Code: 200 OK
Content examples:
JSON
{
    "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": "+385913111111",
    "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": "",
    "metadata": {}
}
{
    "id": 4165,
    "total_orders": 0,
    "total_licenses": 0,
    "labels": [],
    "customer_account": null,
    "email": "tc3@tc.com",
    "first_name": "Harry",
    "last_name": "Potter",
    "company_name": "Hogwarts",
    "phone": "+385913111111",
    "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": "",
    "metadata": {}
}
﻿
﻿
Updated 09 Nov 2023
Did this page help you?
Retrieve Customer
List Customers