Skip to main content
POST
/
customers
/
{id}
{
  "name": "Acme Corporation Updated",
  "email": "newemail@acme.com",
  "business_identification_number": "12-3456789",
  "shipping_address": {
    "line1": "456 New St",
    "line2": "Floor 2",
    "city": "Los Angeles",
    "state": "CA",
    "postal_code": "90001",
    "country": "US"
  }
}
{
  "message": "Customer updated successfully"
}
Updates an existing customer’s information.

Path parameters

id
string
required
The unique identifier for the customer

Request body

name
string
Customer name (minimum 3 characters)
email
string
Customer email address (must be valid email format)
business_identification_number
string
A tax or business registration number for the customer (e.g., VAT ID, EIN, GST number).
shipping_address
object
Customer’s shipping address

Response

Returns a success message upon successful update.
{
  "name": "Acme Corporation Updated",
  "email": "newemail@acme.com",
  "business_identification_number": "12-3456789",
  "shipping_address": {
    "line1": "456 New St",
    "line2": "Floor 2",
    "city": "Los Angeles",
    "state": "CA",
    "postal_code": "90001",
    "country": "US"
  }
}
{
  "message": "Customer updated successfully"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique identifier of the transaction to update

Body

application/json
name
string

A display name for this customer.

Minimum string length: 3
email
string<email>

Email address of the customer.

shipping_address
object

Address object. Only country is required at the schema level. All other field requirements (including postal_code and state) vary by country — use the /address-requirements endpoint to check which fields are REQUIRED, OPTIONAL, or IGNORED for a given country. When provided, postal codes and state codes are validated against country-specific formats and allowed values.

business_identification_number
string

Business identification number for the customer (e.g., tax ID, VAT number, or EIN).

Response

Information about the customer after the update

message
string
Example:

"Successfully updated customer."