MageSmith
PUTCustomer · Magento 2.4.9 Anonymous

PUT /V1/customers/password

PUT /V1/customers/password is a Magento 2 REST endpoint in the Customer module. Send an email to the customer with a password reset link. Callable anonymously — no Authorization header required.

Last verified: against Magento 2.4.9.

Returns

bool

true on success

Service contract

Magento\Customer\Api\AccountManagementInterface::initiatePasswordReset

Authorization

Anonymous — no Authorization header required.

Body parameters

email string Required
template string Required
websiteId int 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

Accept
application/json
Content-Type
application/json

Path

/V1/customers/password

Body

{
  "email": "",
  "template": "",
  "websiteId": 0
}

Related in Customer

Other endpoints shipped by the same module.

DELETE

/V1/addresses/:addressId

Delete customer address by ID.

Customer · Magento\Customer\Api\AddressRepositoryInterface::deleteById

→
GET

/V1/attributeMetadata/customer

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAllAttributesMetadata

→
GET

/V1/attributeMetadata/customer/attribute/:attributeCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributeMetadata

→
GET

/V1/attributeMetadata/customer/custom

Customer · Magento\Customer\Api\CustomerMetadataInterface::getCustomAttributesMetadata

→
GET

/V1/attributeMetadata/customer/form/:formCode

Customer · Magento\Customer\Api\CustomerMetadataInterface::getAttributes

→
GET

/V1/attributeMetadata/customerAddress

Customer · Magento\Customer\Api\AddressMetadataInterface::getAllAttributesMetadata

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →