What does POST /V1/customers return?

The endpoint returns Magento\Customer\Api\Data\CustomerInterface.

POSTWebapi · Magento 2.4.9 Admin · Magento_Customer::manage

POST /V1/customers

Q: What does the POST /V1/customers endpoint do in Magento 2?

POST /V1/customers is a Magento 2 REST endpoint in the Webapi module. Create or update a customer. Requires an admin Bearer token with ACL Magento_Customer::manage.

Q: What parameters does POST /V1/customers accept?

This endpoint accepts 2 parameters: customer (Magento\Customer\Api\Data\CustomerInterface) required; passwordHash (string).

Q: Does POST /V1/customers require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Customer::manage.

POST /V1/customers is a Magento 2 REST endpoint in the Webapi module. Create or update a customer. Requires an admin Bearer token with ACL Magento_Customer::manage.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

Magento\Customer\Api\Data\CustomerInterface

Service contract

Magento\Customer\Api\CustomerRepositoryInterface::save

Authorization

Admin Bearer token with ACL:

Magento_Customer::manage

Body parameters

customer Magento\Customer\Api\Data\CustomerInterface Required

passwordHash string default: null

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

application/json

Content-Type

application/json

Authorization

Bearer <ACCESS_TOKEN> admin token with ACL: Magento_Customer::manage

Path

/V1/customers

Body

{
  "customer": {
    "addresses": [
      {
        "city": "",
        "company": "",
        "country_id": "",
        "custom_attributes": [
          {
            "attribute_code": "",
            "value": ""
          }
        ],
        "customer_id": 0,
        "default_billing": false,
        "default_shipping": false,
        "extension_attributes": {},
        "fax": "",
        "firstname": "",
        "id": 0,
        "lastname": "",
        "middlename": "",
        "postcode": "",
        "prefix": "",
        "region": {
          "extension_attributes": {},
          "region": "",
          "region_code": "",
          "region_id": 0
        },
        "region_id": 0,
        "street": [
          {}
        ],
        "suffix": "",
        "telephone": "",
        "vat_id": ""
      }
    ],
    "confirmation": "",
    "created_at": "",
    "created_in": "",
    "custom_attributes": [
      {
        "attribute_code": "",
        "value": ""
      }
    ],
    "default_billing": "",
    "default_shipping": "",
    "disable_auto_group_change": 0,
    "dob": "",
    "email": "",
    "extension_attributes": {},
    "firstname": "",
    "gender": 0,
    "group_id": 0,
    "id": 0,
    "lastname": "",
    "middlename": "",
    "prefix": "",
    "store_id": 0,
    "suffix": "",
    "taxvat": "",
    "updated_at": "",
    "website_id": 0
  },
  "passwordHash": ""
}