Customer API
  1. customer
Customer API
  • common
    • customers
      • customer
        • account
          • transactions
            • transaction
              • Get Transaction
            • List Transactions
          • Get Account
          • Update Account
          • Get account by id
        • Get Customer
          GET
        • Get Customer w/Account
          GET
        • Update Customer
          PUT
  • host
    • customers
      • Add Customer
      • Add Customers
      • Search Customers
    • customer-account-defaults
      • Get Account Defaults
      • Set Account Defaults
    • default-customer
      • Get Default Customer
    • frequent-customers
      • List Frequent Customers
  • store
    • customers
      • customer
        • account
          • transactions
            • Add Transaction
        • visibility
          • Get Customer Visibility
          • Set Customer Visibility
        • Get Provisioning
        • Provision For Store
        • Publish State Events
        • get customer by account number
      • Add Customer
      • Add & Provision Customer
      • Add Customers
      • Bulk List Customers
      • Search Customers
    • default-customer
      • Get Default Customer
      • Set Default Customer
    • frequent-customers
      • Add Frequent Customer
      • List Frequent Customers
      • Remove Frequent Customer
  1. customer

Update Customer

Developing
PUT
/customers/{customerId}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Body Params application/json

Example
{
    "name": "string",
    "address": {
        "street1": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string",
        "zipCode": "/regex/"
    },
    "phone": "string",
    "email": "string",
    "billToCustomerId": 0,
    "shipTo": {
        "name": "string",
        "address": {
            "street1": "string",
            "street2": "string",
            "city": "string",
            "state": "string",
            "countryCode": "string",
            "zipCode": "/regex/"
        },
        "phone": "string",
        "email": "string"
    },
    "version": 0
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://mock.apidog.com/m1/365924-0-default/customers/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "address": {
        "street1": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string",
        "zipCode": "/regex/"
    },
    "phone": "string",
    "email": "string",
    "billToCustomerId": 0,
    "shipTo": {
        "name": "string",
        "address": {
            "street1": "string",
            "street2": "string",
            "city": "string",
            "state": "string",
            "countryCode": "string",
            "zipCode": "/regex/"
        },
        "phone": "string",
        "email": "string"
    },
    "version": 0
}'

Responses

🟢200OK
application/json
Body

Example
{
    "data": {
        "id": 1,
        "franchiseId": 1,
        "name": "string",
        "address": {
            "street1": "string",
            "street2": "string",
            "city": "string",
            "state": "string",
            "countryCode": "string",
            "zipCode": "/regex/"
        },
        "phone": "string",
        "email": "string",
        "billToAccount": {
            "id": 0,
            "status": "ACTIVE",
            "billToAddress": {
                "street1": "string",
                "street2": "string",
                "city": "string",
                "state": "string",
                "countryCode": "string",
                "zipCode": "/regex/"
            },
            "balance": 0,
            "creditLimit": 0,
            "cashOverLimit": false,
            "cashOverDays": false,
            "ageInDays": 0,
            "defaultPayType": "CASH",
            "payTypes": [
                "CASH"
            ],
            "priceCode": 0,
            "taxCode": "string",
            "maxDays": 0,
            "signatureRequired": false,
            "version": 0
        },
        "shipTo": {
            "name": "string",
            "address": {
                "street1": "string",
                "street2": "string",
                "city": "string",
                "state": "string",
                "countryCode": "string",
                "zipCode": "/regex/"
            },
            "phone": "string",
            "email": "string"
        },
        "version": 0
    }
}
🟠404Not Found
🟠403Forbidden
🟠400Bad Request
🟠409Stale Update
🔴500Server Error
Modified at 2025-05-02 23:30:33
Previous
Get Customer w/Account
Next
Add Customer
Built with