Update a customer

PUT/api/customers/{id}

Replaces the editable customer fields for the selected customer id.

Path Parameters

id*string

Resource identifier.

Example"cust_123"

Request Body

application/json

Request payload for Update a customer.

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Customer type classification.

Example"company"

Value in

"individual"
"company"

name?|

Customer name.

email?|

Primary customer email.

phone?|

Primary phone number.

address?|

Primary address.

website?|

Customer website URL.

country?|

Country code or label.

idType?|

Government or tax identifier type.

idValue?|

Government or tax identifier value.

note?|

Internal note about the customer.

addresses?array<string>|

Additional customer addresses.

customFields?|

Custom field values to persist on the customer.

memberships?array<>|

Customer-contact memberships to create or update with the customer.

Response Body

`application/json`

curl -X PUT "https://example.com/api/customers/cust_123" \  -H "Content-Type: application/json" \  -d '{    "type": "company"  }'

{  "success": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`