Magento REST icon

Magento REST

Consume Magento REST API

Customer → Update

AI-generated

Summary

Update a customer via PUT to /rest/{websiteCode}/V1/customers/{customerId}

Inputs

  • customerId (required) — Customer ID
  • customerData (required) — Customer data in JSON format, sent as {customer: } in the request body
  • websiteCode — Store view code for multi-store Magento instances; prepends /{code}/ to the API URL
  • simplifyOutput — When enabled, flattens the response: converts custom_attributes array to an object, flattens extension_attributes, and simplifies nested structures

Output shape

Returns the Magento customer API response; if simplifyOutput is true, the response is flattened via flattenResponse (custom_attributes → attributes, extension_attributes spread top-level, nested structures simplified)

May include error details if the request fails and continueOnFail is enabled

Examples

Example 1: Update customer with ID 42 and new email

customerId: 42, customerData: { email: 'new@example.com' }

Links

Discussion