POST
/
v1
/
c
/
customer
curl --request POST \
  --url http://127.0.0.1:8080/v1/c/customer \
  --header 'Content-Type: application/json' \
  --header 'wb-key: <api-key>' \
  --data '{
  "addresses": {
    "main": {
      "address": "221B Baker St",
      "city": "London",
      "country": "UK",
      "zip": "NW1 6XE"
    }
  },
  "emails": {
    "main": "sherlock@wingback.com"
  },
  "name": "Sherlock Holmes"
}'
This response has no body data.

Authorizations

wb-key
string
header
required

Body

application/json

Used to either create a new Customer, or modify an existing Customer When id is empty, will create a new customer, while setting id will modify an existing customer

address
object

Physical address. Used by both Customer and WbCustomer entities.

customer_reference
string | null

Customer Reference. May contain a reference to an external system

emails
object | null

Emails associated with this customer

id
string

Unique identifier of an object. Consists of object class prefix and a UUID

metadata
object

Key-value customer metadata with string values.

name
string | null

Name of the Customer

notes
string | null

Additional notes for the customer

tax_details
object

Extra information that impacts customer's taxation