Skip to main content
PATCH
/
v1
/
customers
/
{id}
Update Customer
curl --request PATCH \
  --url https://api.wizcommerce.com/v1/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "company_name": "Company Name",
  "display_name": "Customer Display Name",
  "display_id": "1234567890",
  "freight_term": "<string>",
  "shipping_method": "<string>",
  "payment_mode": "<string>",
  "payment_term": "<string>",
  "primary_contact_id": "<string>",
  "default_shipping_address_id": "<string>",
  "default_billing_address_id": "<string>",
  "reference_id": "CUS123",
  "assigned_sales_rep_ids": [
    "<string>"
  ],
  "assigned_price_list_id": "<string>",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "+14155552671",
  "email": "[email protected]",
  "addresses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "ADDR123",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+14155552671",
      "email": "[email protected]",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "Anytown",
      "state": "CA",
      "country": "US",
      "zip_code": "12345",
      "type": "billing",
      "is_default": true,
      "attributes": [
        {
          "name": "1234567890",
          "value": "red"
        }
      ]
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "CUS123",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone": "+14155552671",
      "designation": "Sales Manager",
      "is_default": true,
      "attributes": [
        {
          "name": "1234567890",
          "value": "red"
        }
      ]
    }
  ],
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ]
}
'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "1234567890",
    "display_id": "WC_1234567890",
    "name": "Customer Name",
    "display_name": "Customer Display Name",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+14155552671",
    "email": "[email protected]",
    "status": "active",
    "freight_term": "Cust. Pickup",
    "shipping_method": "DHL",
    "payment_mode": "AMEX",
    "payment_term": "NET30",
    "assigned_sales_reps": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "+14155552671",
        "department": "Sales",
        "status": "active",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "assigned_price_list": {
      "id": "0c05a9a7-84ed-46f0-819b-653545730920",
      "name": "Price List 1",
      "status": "active",
      "reference_id": "PRC-20250101",
      "description": "Price List 1 Description",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    },
    "addresses": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "customer_id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "reference_id": "ADDR123",
        "address_line_1": "123 Main St",
        "address_line_2": "Apt 101",
        "city": "Anytown",
        "state": "CA",
        "country": "USA",
        "zip_code": "12345",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "+14155552671",
        "email": "[email protected]",
        "type": "billing",
        "status": "active",
        "is_default": false,
        "attributes": [
          {
            "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "name": "Color",
            "value": "Red",
            "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z"
          }
        ],
        "created_at": "2025-01-01T15:04:05Z",
        "updated_at": "2025-01-01T15:04:05Z"
      }
    ],
    "contacts": [
      {
        "id": "0c05a9a7-84ed-46f0-819b-653545730920",
        "reference_id": "CUS123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "+14155552671",
        "designation": "Sales Manager",
        "status": "active",
        "is_default": false,
        "attributes": [
          {
            "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "name": "Color",
            "value": "Red",
            "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z"
          }
        ],
        "created_at": "2025-01-01T15:04:05Z",
        "updated_at": "2025-01-01T15:04:05Z"
      }
    ],
    "attributes": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "name": "Color",
        "value": "Red",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "created_at": "2025-01-01T15:04:05Z",
    "updated_at": "2025-01-01T15:04:05Z"
  }
}
The PATCH request is used to partially update an existing entity by the given id. This means:
  • Only the fields provided in the request body will be updated.
  • Fields not provided in the request body will remain unchanged.
  • The request is idempotent, meaning multiple identical PATCH requests will always result in the same final state.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

id

Body

application/json

request

​
company_name
string
Maximum string length: 255
Example:

"Company Name"

​
display_name
string
Maximum string length: 255
Example:

"Customer Display Name"

​
display_id
string

This is the display ID of the customer, it is generated by the system if not provided.

Maximum string length: 255
Example:

"1234567890"

​
freight_term
string
Maximum string length: 255
​
shipping_method
string
Maximum string length: 255
​
payment_mode
string
Maximum string length: 255
​
payment_term
string
Maximum string length: 255
​
primary_contact_id
string
​
default_shipping_address_id
string
​
default_billing_address_id
string
​
reference_id
string
Maximum string length: 255
Example:

"CUS123"

​
assigned_sales_rep_ids
string[]

List of sales rep ids, sales rep id is a uuid can be queried from sales rep api

Minimum array length: 1
​
assigned_price_list_id
string

Price list id is a uuid can be queried from price list api

​
first_name
string
Maximum string length: 255
Example:

"John"

​
last_name
string
Maximum string length: 255
Example:

"Doe"

​
phone
string

Phone number in E.164 format

Example:

"+14155552671"

​
email
string
​
addresses
object[]
​
contacts
object[]
​
attributes
object[]

Response

Created

​
data
object