Developer documentation

Create a customer

A customer is a consumer of the service or product that your business offers. Below details demonstrate to create or update customer with one of API client Postman.

First of all prepare the required request headers as mentioned in Request Headers.

Request info

Production base URL :
Operation : PUT api/v1/customers/<customerID>
Content type : application/json

Here customerID is GUID type parameter that need to be passed in URL while creating customer that will create blank customer. All customer attributes like Name, Address, Email etc. can be set on subsequent requests. This also means for updating any existing customer pass the unique identifier customerID and customer attributes that needs to be set or updated.

So basically sample request to create or update customer would be as below.

PUT /api/v1/customers/62e15dc6-e4c1-4258-b9e2-aaaefc231700 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Accept: application/json
Accept-Language: en
Content-Type: application/json
Prefer: return=representation
Cache-Control: no-cache
Postman-Token: a4c3796c-0651-1511-8672-8edff48fe337

Request body
All attributes of customer are optional while creating new customer however basic object would be appear as.



Request Return
When valid request has been processed by server and created object response demanded then below response will be appear at client side.

Sample customer

  "Name": "Calbri BV1",
  "SearchName": "Calbri BV1"

For more details about all available attributes of customer please Click here.

NL Select your country